Method: advertisers.locationLists.list

根据给定的广告客户 ID 列出地理位置列表。

HTTP 请求

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/locationLists

网址采用 gRPC 转码语法。

路径参数

参数
advertiserId

string (int64 format)

必需。提取的地理位置列表所属的 DV360 广告客户的 ID。

查询参数

参数
pageSize

integer

请求的页面大小。 必须介于 1200 之间。如果未设置,则默认为 100。如果指定的值无效,则返回错误代码 INVALID_ARGUMENT

pageToken

string

用于标识服务器应返回的结果页面的令牌。

通常,这是上次调用 locationLists.list 方法返回的 nextPageToken 值。如果未指定,则返回第一页结果。

orderBy

string

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

  • locationListId(默认)
  • displayName

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

filter

string

允许按营业地点列表字段进行过滤。

支持的语法:

  • 过滤条件表达式由一个或多个限制条件组成。
  • 限制条件可以通过 ANDOR 逻辑运算符组合使用。一系列限制会隐式使用 AND
  • 限制的格式为 {field} {operator} {value}
  • 所有字段都必须使用 EQUALS (=) 运算符。

支持的字段:

  • locationType

示例:

  • 所有区域性地理位置列表:locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • 所有邻近位置列表:locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

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

如需了解详情,请参阅我们的过滤 LIST 请求指南。

请求正文

请求正文必须为空。

响应正文

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

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

object (LocationList)

地理位置列表的列表。

如果为空,则不会显示此列表。

nextPageToken

string

用于检索下一页结果的令牌。

在对 locationLists.list 方法的后续调用中,将此值传入 pageToken 字段,以检索下一页结果。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅 OAuth 2.0 概览