ディスプレイとVideo 360 API v2 は
2024 年 9 月 3 日に廃止されます。サービスの中断を避けるため、期日までに
v3 に移行してください。
Method: advertisers.adGroupAds.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
HTTP リクエスト
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroupAds
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
advertiserId |
string (int64 format)
必須。広告グループが属する広告主の ID。
|
クエリ パラメータ
パラメータ |
pageSize |
integer
(省略可)リクエストされたページサイズです。 1 ~100 の範囲で指定してください。指定しない場合のデフォルトは 100 です。無効な値が指定されている場合は、エラーコード INVALID_ARGUMENT を返します。
|
pageToken |
string
(省略可)サーバーが返す必要がある結果のページを特定するトークンです。 通常、これは前回の adGroupAds.list メソッドの呼び出しで返された nextPageToken の値です。指定しない場合、結果の最初のページが返されます。
|
orderBy |
string
(省略可)リストの並べ替え基準となるフィールドです。有効な値は次のとおりです。
displayName (デフォルト)
entityStatus
デフォルトの並べ替え順は昇順です。フィールドを降順で指定するには、フィールド名に「desc」という接尾辞を追加する必要があります。(例: displayName desc )。
|
filter |
string
(省略可)カスタムの広告グループの広告フィールドでフィルタできます。 サポートされる構文:
- フィルタ式は 1 つ以上の制限で構成されます。
- 制限は
AND と OR で組み合わせることができます。一連の制限では、暗黙的に AND が使用されます。
- 制限の形式は
{field} {operator} {value} です。
- すべてのフィールドで
EQUALS (=) 演算子を使用する必要があります。
サポートされているフィールド:
adGroupId
displayName
entityStatus
adGroupAdId
例:
- 広告グループ内のすべての広告グループ広告:
adGroupId="1234"
- entityStatus が
ENTITY_STATUS_ACTIVE または ENTITY_STATUS_PAUSED の広告グループのすべての広告グループ広告: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupId="12345"
このフィールドの長さは 500 文字以下にする必要があります。 詳しくは、LIST リクエストのフィルタに関するガイドをご覧ください。
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
{
"adGroupAds": [
{
object (AdGroupAd )
}
],
"nextPageToken": string
} |
フィールド |
adGroupAds[] |
object (AdGroupAd )
広告グループの広告のリストです。 空の場合、このリストは存在しません。
|
nextPageToken |
string
結果の次のページを取得するためのトークン。 結果の次のページを取得するには、後続の adGroupAds.list メソッドの呼び出しで、この値を pageToken フィールドに渡します。
|
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/display-video
詳細については、OAuth 2.0 の概要をご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-06-11 UTC。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"必要な情報がない"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"複雑すぎる / 手順が多すぎる"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"最新ではない"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻訳に関する問題"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"サンプル / コードに問題がある"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"その他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"わかりやすい"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"問題の解決に役立った"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"その他"
}]
{
"last_modified": "最終更新日 2024-06-11 UTC。",
"state": ""
}