Customchannels.adunits: list

需要授权

列出指定自定义渠道中的所有广告单元。立即尝试

请求

HTTP请求

GET https://www.googleapis.com/adsense/v1.4/adclients/adClientId/customchannels/customChannelId/adunits

参数

参数名称 说明
路径参数
adClientId string 包含自定义渠道的广告客户。
customChannelId string 要为其列出广告单元的自定义渠道。
可选查询参数
includeInactive boolean 是否加入无效广告单元。默认值:true。
maxResults integer 此响应中可包含的广告单元数量上限,用于分页。可接受的值包括010000(闭区间)。
pageToken string 用于对广告单元进行分页的延续令牌。要检索下一页,请将此参数设置为上一个响应中的“nextPageToken”的值。

授权

此请求至少需要获得下列其中一个范围的授权(详细了解身份验证和授权)。

范围
https://www.googleapis.com/auth/adsense
https://www.googleapis.com/auth/adsense.readonly

请求正文

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

响应

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

{
  "kind": "adsense#adUnits",
  "etag": etag,
  "nextPageToken": string,
  "items": [
    {
      "code": string,
      "id": string,
      "kind": "adsense#adUnit",
      "name": string,
      "status": string,
      "customStyle": {
        "kind": "adsense#adStyle",
        "colors": {
          "border": string,
          "title": string,
          "background": string,
          "text": string,
          "url": string
        },
        "corners": string,
        "font": {
          "family": string,
          "size": string
        }
      },
      "savedStyleId": string,
      "contentAdsSettings": {
        "type": string,
        "size": string,
        "backupOption": {
          "type": string,
          "color": string,
          "url": string
        }
      },
      "mobileContentAdsSettings": {
        "type": string,
        "size": string,
        "markupLanguage": string,
        "scriptingLanguage": string
      },
      "feedAdsSettings": {
        "type": string,
        "minimumWordCount": integer,
        "frequency": integer,
        "adPosition": string
      }
    }
  ]
}
属性名称 说明 备注
kind string 此列表的种类,在此示例中为 adsense#adUnits。
etag etag 此响应的 ETag,用于进行缓存。
nextPageToken string 用于对广告单元进行分页的延续令牌。要检索下一页结果,请将下一个请求的“pageToken”值设置为此值。
items[] list 此列表响应中返回的广告单元。
items[].code string 此广告单元的标识代码,不必在多个广告客户之间保持唯一。
items[].id string 此广告单元的唯一标识符。它应该被视为一个不透明的标识符;如果使用任何特殊格式,则不能完全依靠它来进行标识。
items[].kind string 此资源的种类,在此示例中为 adsense#adUnit。
items[].name string 此广告单元的名称。
items[].status string 此广告单元的状态。其值可以是:

NEW:表示此广告单元在最近七天内创建,还没有发生任何与其相关的活动。

ACTIVE:表示在最近七天内,此广告单元上发生了活动。

INACTIVE:表示在最近七天内,此广告单元上没有发生活动。



可接受的值为:
  • "ACTIVE":
  • "INACTIVE":
  • "NEW":
items[].customStyle nested object 此广告单元特有的自定义样式信息。
items[].customStyle.kind string 种类,在此示例中为 adsense#adStyle。
items[].customStyle.colors object 此样式中包含的颜色。由六个十六进制字符表示,类似于HTML颜色代码,但没有开头的井号。
items[].customStyle.colors.border string 广告边框的颜色。
items[].customStyle.colors.title string 广告标题的颜色。
items[].customStyle.colors.background string 广告背景的颜色。
items[].customStyle.colors.text string 广告文字的颜色。
items[].customStyle.colors.url string 广告网址的颜色。
items[].customStyle.corners string 广告中边角的样式。

可接受的值为:
  • "SLIGHTLY_ROUNDED":
  • "SQUARE":
  • "VERY_ROUNDED":
items[].customStyle.font object 此样式中包含的字体。
items[].customStyle.font.family string 字体系列。

可接受的值为:
  • "ACCOUNT_DEFAULT_FAMILY":
  • "ADSENSE_DEFAULT_FAMILY":
  • "ARIAL":
  • "LORA":
  • "OPEN_SANS":
  • "OPEN_SANS_LIGHT":
  • "ROBOTO_LIGHT":
  • "TIMES":
  • "UBUNTU_LIGHT":
  • "VERDANA":
items[].customStyle.font.size string 字体大小。

可接受的值为:
  • "ACCOUNT_DEFAULT_SIZE":
  • "ADSENSE_DEFAULT_SIZE":
  • "LARGE":
  • "MEDIUM":
  • "SMALL":
items[].savedStyleId string 含有此广告单元样式信息的已保存广告样式的ID。
items[].contentAdsSettings object 内容广告 (AFC) 和高端移动内容广告 (AFMC) 特有的设置。
items[].contentAdsSettings.type string 此广告单元的类型。
items[].contentAdsSettings.size string 此广告单元的尺寸。
items[].contentAdsSettings.backupOption object 要在广告不适用的实例中使用的备份选项。
items[].contentAdsSettings.backupOption.type string 备份选项的类型。可能的值包括BLANK、COLOR和URL。

可接受的值为:
  • "BLANK":
  • "COLOR":
  • "URL":
items[].contentAdsSettings.backupOption.color string 类型设置为COLOR时使用的颜色。
items[].contentAdsSettings.backupOption.url string 类型设置为 URL 时使用的网址。
items[].mobileContentAdsSettings object WAP 移动内容广告 (AFMC) 特有的设置。
items[].mobileContentAdsSettings.type string 此广告单元的类型。
items[].mobileContentAdsSettings.size string 此广告单元的尺寸。
items[].mobileContentAdsSettings.markupLanguage string 用于此广告单元的标记语言。

可接受的值为:
  • "CHTML":
  • "WML":
  • "XHTML":
items[].mobileContentAdsSettings.scriptingLanguage string 用于此广告单元的脚本语言。

可接受的值为:
  • "ASP":
  • "CGI":
  • "JSP":
  • "PHP":
items[].feedAdsSettings object Feed广告(AFF)特有的设置。
items[].feedAdsSettings.type string 应展示的广告类型。
items[].feedAdsSettings.minimumWordCount integer 为了具有附加广告而应输入的最小长度。
items[].feedAdsSettings.frequency integer 广告在Feed中展示的频率(即,每N个条目)。
items[].feedAdsSettings.adPosition string 广告相对于Feed条目的位置。

可接受的值为:
  • "BOTTOM":
  • "TOP":

立即尝试!

请使用下面的API Explorer针对实际数据调用此方法并查看响应。

发送以下问题的反馈:

此网页
AdSense Management API
AdSense Management API