Adunits.customchannels: list

認証が必要です

指定された広告ユニットが属するすべてのカスタム チャネルのリストを表示します。実際に試す

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 説明
パス パラメータ
adClientId string 広告ユニットが含まれる広告クライアント。
adUnitId string カスタム チャネルのリストを表示する広告ユニット。
省略可能なクエリパラメータ
maxResults integer レスポンスに含めるカスタム チャネルの最大数。ページの割り付けに使用されます。有効な値は 010000(指定した値を含む)です。
pageToken string 継続トークン。カスタム チャネルのリストのページ割り付けに使用されます。次のページを取得するには、このパラメータを前のレスポンスの "nextPageToken" の値に設定します。

認証

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

範囲
https://www.googleapis.com/auth/adsense
https://www.googleapis.com/auth/adsense.readonly

リクエスト本文

このメソッドをリクエストの本文に含めないでください。

レスポンス

正常終了すると、このメソッドは次の構造でレスポンスの本体を返します。

{
  "kind": "adsense#customChannels",
  "etag": etag,
  "nextPageToken": string,
  "items": [
    {
      "kind": "adsense#customChannel",
      "id": string,
      "code": string,
      "name": string,
      "targetingInfo": {
        "adsAppearOn": string,
        "location": string,
        "description": string,
        "siteLanguage": string
      }
    }
  ]
}
プロパティ名 説明 備考
kind string リストの種類。この例では adsense#customChannels です。
etag etag このレスポンスのキャッシュ用の ETag。
nextPageToken string 継続トークン。カスタム チャネルのリストのページ割り付けに使用されます。結果の次のページを取得するには、この値を次のリクエストの "pageToken" の値に設定します。
items[] list このリスト レスポンスで取得されるカスタム チャネル。
items[].kind string リソースの種類。この例では adsense#customChannel です。
items[].id string このカスタム チャネルの一意の識別子。これは不透明(opaque)な識別子とみなす必要があり、特定の形式を持つ保証はありません。
items[].code string このカスタム チャネルのコード。広告クライアント全体で一意である必要はありません。
items[].name string このカスタム チャネルの名前。
items[].targetingInfo object 有効な場合、このカスタム チャネルのターゲティング情報。
items[].targetingInfo.adsAppearOn string このチャネルを外部で記述するとき使用される名前。
items[].targetingInfo.location string 広告が表示される位置(コンテンツ広告とモバイル コンテンツ広告でのみ有効)。コンテンツ広告で有効な値は、TOP_LEFT、TOP_CENTER、TOP_RIGHT、MIDDLE_LEFT、MIDDLE_CENTER、MIDDLE_RIGHT、BOTTOM_LEFT、BOTTOM_CENTER、BOTTOM_RIGHT、MULTIPLE_LOCATIONS です。モバイル コンテンツ広告で有効な値は、TOP、MIDDLE、BOTTOM、MULTIPLE_LOCATIONS です。

有効な値は次のとおりです。
  • "BOTTOM":
  • "BOTTOM_CENTER":
  • "BOTTOM_LEFT":
  • "BOTTOM_RIGHT":
  • "MIDDLE":
  • "MIDDLE_CENTER":
  • "MIDDLE_LEFT":
  • "MIDDLE_RIGHT":
  • "MULTIPLE_LOCATIONS":
  • "TOP":
  • "TOP_CENTER":
  • "TOP_LEFT":
  • "TOP_RIGHT":
items[].targetingInfo.description string チャネルの外部向けの記述。
items[].targetingInfo.siteLanguage string サイト広告の表示で使用される言語。

実際に試す

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

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