Method: advertisers.adGroups.list

広告グループを一覧表示します。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroups

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
advertiserId

string (int64 format)

必須。広告グループが属する広告主の ID。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。リクエストされたページサイズ。1～200 の範囲で指定してください。指定しない場合、デフォルトで 100 になります。無効な値が指定された場合は、エラーコード INVALID_ARGUMENT を返します。
pageToken

string

省略可。サーバーが返す必要がある結果のページを特定するトークン。通常、これは adGroups.list メソッドの前の呼び出しから返された nextPageToken の値です。指定しない場合は、結果の最初のページが返されます。
orderBy

string

省略可。リストの並べ替えに使用するフィールド。使用できる値は次のとおりです。

  • displayName（デフォルト）
  • entityStatus

デフォルトの並べ替え順序は昇順です。フィールドに対して降順を指定するには、フィールド名に接尾辞「desc」を追加する必要があります。例: displayName desc。
filter

string

省略可。カスタム広告グループ フィールドでフィルタできます。

サポートされている構文:

  • フィルタ式は、1 つ以上の制限で構成されます。
  • 制限は AND と OR で組み合わせることができます。制限のシーケンスでは、暗黙的に AND が使用されます。
  • 制限の形式は {field} {operator} {value} です。
  • すべてのフィールドで EQUALS (=) 演算子を使用する必要があります。

サポートされているプロパティ:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

例:

  • 広告申込情報 lineItemId="1234" のすべての広告グループ
  • 広告主のすべての ENTITY_STATUS_ACTIVE または ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM 広告グループ: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

このフィールドの長さは 500 文字以下にする必要があります。

詳しくは、フィルタ LIST リクエストのガイドをご覧ください。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "adGroups": [
    {
      object (AdGroup)
    }
  ],
  "nextPageToken": string
}
フィールド
adGroups[]

object (AdGroup)

広告グループのリスト。

空の場合、このリストは存在しません。
nextPageToken

string

結果の次のページを取得するためのトークン。 この値を次の adGroups.list メソッド呼び出しの pageToken フィールドで渡して、結果の次ページを取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/display-video

詳細については、OAuth 2.0 Overview をご覧ください。