列出某个广告客户名下的广告系列。
顺序由 orderBy
形参定义。如果未指定由 entityStatus
提供的 filter
,则 ENTITY_STATUS_ARCHIVED
的广告系列将不会包含在结果中。
HTTP 请求
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
advertiserId |
要为其列出广告系列的广告客户的 ID。 |
查询参数
参数 | |
---|---|
pageSize |
请求的页面大小。必须介于 |
pageToken |
标识服务器应返回的结果页面的令牌。通常,这是上一次调用 |
orderBy |
列表排序所依据的字段。可接受的值为:
默认排序顺序是升序。要为字段指定降序,应在字段名称中添加后缀“desc”。示例: |
filter |
允许按广告系列字段过滤。 支持的语法:
支持的字段:
示例:
此字段的长度不应超过 500 个字符。 如需了解详情,请参阅我们的过滤 |
请求正文
请求正文必须为空。
响应正文
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"campaigns": [
{
object ( |
字段 | |
---|---|
campaigns[] |
广告系列的列表。 如果为空,则不会显示此列表。 |
nextPageToken |
用于检索下一页结果的令牌。在后续调用 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/display-video
https://www.googleapis.com/auth/display-video-mediaplanning
有关详情,请参阅 OAuth 2.0 概览。