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

例:

  • 1 つの広告申込情報内のすべての広告グループ: lineItemId="1234"
  • 1 つの広告主のすべての「AD_GROUP_FORMAT_IN_STREAM」広告グループ（ENTITY_STATUS_ACTIVE 個または ENTITY_STATUS_PAUSED 個）: (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 の概要をご覧ください。