Method: customBiddingAlgorithms.list

列出当前用户可访问且可用于出价策略的自定义出价算法。

顺序由 orderBy 参数定义。

HTTP 请求

GET https://displayvideo.googleapis.com/v3/customBiddingAlgorithms

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

请求的页面大小。 必须介于 1 和 200 之间。如果未指定，则默认为 100。如果指定了无效值，则返回错误代码 INVALID_ARGUMENT。
pageToken

string

标识服务器应返回的结果页面的令牌。通常，这是上一次调用 customBiddingAlgorithms.list 方法时返回的 nextPageToken 值。如果未指定，则返回第一页的结果。
orderBy

string

表示要按哪个字段对此列表进行排序。可接受的值包括：

  • displayName（默认）

默认排序顺序为升序。如需将字段指定为降序，应在字段名称中添加后缀“desc”。示例：displayName desc。
filter

string

允许按自定义出价算法字段进行过滤。

支持的语法：

  • 过滤表达式由一个或多个限制条件组成。
  • 您可以使用 AND 组合限制条件。一系列限制条件会隐式使用 AND。
  • 限制的格式为 {field} {operator} {value}。
  • customBiddingAlgorithmType 字段必须使用 EQUALS (=) 运算符。
  • displayName 字段必须使用 HAS (:) 运算符。

支持的字段：

  • customBiddingAlgorithmType
  • displayName

示例：

  • 所有显示名称中包含“politics”的自定义出价算法：displayName:"politics"。
  • 所有类型为“SCRIPT_BASED”的自定义出价算法：customBiddingAlgorithmType=SCRIPT_BASED

此字段的长度不应超过 500 个字符。

如需了解详情，请参阅我们的过滤 LIST 请求指南。
联合参数 accessor。必需。用于标识请求是在哪个 DV360 实体中发出的。LIST 请求将仅返回 accessor 中标识的 DV360 实体可访问的自定义出价算法实体。如需执行 LIST 请求，用户需要拥有对 accessor 实体的权限。accessor 只能是下列其中一项：
partnerId

string (int64 format)

有权访问自定义出价算法的 DV360 合作伙伴的 ID。
advertiserId

string (int64 format)

有权访问自定义出价算法的 DV360 广告客户的 ID。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "customBiddingAlgorithms": [
    {
      object (CustomBiddingAlgorithm)
    }
  ],
  "nextPageToken": string
}
字段
customBiddingAlgorithms[]

object (CustomBiddingAlgorithm)

自定义出价算法的列表。

如果为空，则此列表将不存在。
nextPageToken

string

用于检索下一页结果的令牌。在后续对 ListCustomBiddingAlgorithmsRequest 方法的调用中，将此值传入 pageToken 字段，以检索下一页结果。如果此字段为 null，则表示这是最后一页。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/display-video

如需了解详情，请参阅 OAuth 2.0 Overview。