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" の値に設定します。

認証

このリクエストには、次の 1 つ以上の範囲の認証が必要です(詳細については、認証と承認に関する記事をご覧ください)。

範囲
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 この広告ユニットの一意の識別子。これは不透明(opaque)な識別子とみなす必要があり、特定の形式を持つ保証はありません。
items[].kind string リソースの種類。この例では adsense#adUnit です。
items[].name string この広告ユニットの名前。
items[].status string この広告ユニットのステータス。値は次のいずれかです。

NEW: 過去 7 日以内に作成され、まだ関連付けられたアクティビティがない広告ユニットであることを示します。

ACTIVE: 過去 7 日間にこの広告ユニットでアクティビティがあったことを示します。

INACTIVE: 過去 7 日間にこの広告ユニットでアクティビティがなかったことを示します。



有効な値は次のとおりです。
  • "ACTIVE":
  • "INACTIVE":
  • "NEW":
items[].customStyle nested object この広告ユニットに固有のカスタム スタイル情報。
items[].customStyle.kind string 種類。この例では adsense#adStyle です。
items[].customStyle.colors object スタイルに含める色。6 桁の 16 進数で表します。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 広告の URL の色。
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 に設定した場合に使用する URL。
items[].mobileContentAdsSettings object モバイル コンテンツ広告(従来型)(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 フィード広告(AFF)に固有の設定。
items[].feedAdsSettings.type string 表示される広告のタイプ。
items[].feedAdsSettings.minimumWordCount integer 広告が添付されるために必要なエントリの最小の長さ。
items[].feedAdsSettings.frequency integer 広告をフィードに表示する頻度(N エントリごと)。
items[].feedAdsSettings.adPosition string フィード エントリに対する広告の位置。

有効な値は次のとおりです。
  • "BOTTOM":
  • "TOP":

実際に試す

このメソッドを呼び出してレスポンスを確認するには、以下のテスト ツールをご利用ください。

フィードバックを送信...