Campaigns: list

检索广告系列列表,可能是过滤后的。此方法支持分页立即试用

请求

HTTP 请求

GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/campaigns

参数

参数名称 说明
路径参数
profileId long 与此请求相关联的用户个人资料 ID。
可选查询参数
advertiserGroupIds long 仅选择这些广告客户组中的广告客户所拥有的广告系列。
advertiserIds long 仅选择属于这些广告客户的广告系列。
archived boolean 仅选择已归档的广告系列。请勿将该字段设为同时选择已归档的广告系列和未归档的广告系列。
atLeastOneOptimizationActivity boolean 仅选择至少有一个优化活动的广告系列。
excludedIds long 排除具有这些 ID 的广告系列。
ids long 仅选择具有这些 ID 的广告系列。
maxResults integer 返回的结果数上限。可接受的值介于 0(含)到 1000(含)之间。(默认值:1000
overriddenEventTagId long 仅选择已替换此事件代码 ID 的广告系列。
pageToken string 上一结果页中的 nextPageToken 值。
searchString string 允许按名称或 ID 搜索广告系列。允许使用通配符 (*)。例如,搜索 "campaign*2015" 将返回名称为 "campaign June 2015""campaign April 2015" 或只是 "campaign 2015" 等的广告系列。大多数搜索查询也会在搜索字符串的开头和结尾处隐式添加通配符。例如,如果搜索字符串为 "campaign",将与名称为 "my campaign""campaign 2015" 或只是 "campaign" 的广告系列匹配。
sortField string 列表排序所依据的字段。

可接受的值为:
  • ID”(默认值)
  • NAME
sortOrder string 结果的排序顺序。

可接受的值为:
  • ASCENDING”(默认值)
  • DESCENDING
subaccountId long 仅选择属于此子帐号的广告系列。

授权

此请求需要获得以下范围的授权:

范围
https://www.googleapis.com/auth/dfatrafficking

如需了解详情,请参阅身份验证和授权页面。

请求正文

请勿使用此方法提供请求正文。

响应

如果成功,此方法将返回具有以下结构的响应正文:

{
  "kind": "dfareporting#campaignsListResponse",
  "nextPageToken": string,
  "campaigns": [
    campaigns Resource
  ]
}
属性名称 说明 备注
kind string 标识所属资源种类。值:固定字符串 "dfareporting#campaignsListResponse"
campaigns[] list 广告系列集合。
nextPageToken string 要用于下一项列出操作的分页令牌。

试试看!

使用下面的 API Explorer 对实际数据调用此方法,然后查看响应。