Method: advertisers.campaigns.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
HTTP リクエスト
GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/campaigns
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
advertiserId |
string (int64 format)
キャンペーンを一覧表示する広告主の ID。
|
クエリ パラメータ
パラメータ |
pageSize |
integer
リクエストされたページサイズです。 1 ~200 の値にしてください。指定しない場合のデフォルトは 100 です。
|
pageToken |
string
サーバーが返す必要がある結果のページを特定するトークンです。 通常、これは前回の campaigns.list メソッドの呼び出しで返された nextPageToken の値です。指定しない場合、結果の最初のページが返されます。
|
orderBy |
string
リストの並べ替えに使用するフィールド。指定できる値は次のとおりです。
displayName (デフォルト)
entityStatus
updateTime
デフォルトの並べ替え順は昇順です。フィールドの降順を指定するには、接尾辞「desc」を使用しますフィールド名に を追加します。例: displayName desc 。
|
filter |
string
キャンペーン フィールドでフィルタできます。 サポートされている構文:
- フィルタ式は 1 つ以上の制限で構成されます。
- 制限は、
AND 論理演算子または OR 論理演算子で組み合わせることができます。一連の制限では、暗黙的に AND が使用されます。
- 制限の形式は
{field} {operator} {value} です。
updateTime フィールドでは、GREATER THAN OR EQUAL TO (>=) 演算子または LESS THAN OR EQUAL TO (<=) 演算子を使用する必要があります。
- 他のすべてのフィールドでは、
EQUALS (=) 演算子を使用する必要があります。
サポートされているフィールド:
campaignId
displayName
entityStatus
updateTime (ISO 8601 形式または YYYY-MM-DDTHH:MM:SSZ で入力)
例:
- 広告主のすべての「
ENTITY_STATUS_ACTIVE 」または「ENTITY_STATUS_PAUSED 」キャンペーン: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED")
- 更新時間が 2020-11-04T18:54:47Z(ISO 8601 形式)以下のすべてのキャンペーン:
updateTime<="2020-11-04T18:54:47Z"
- 更新時間が 2020-11-04T18:54:47Z(ISO 8601 形式)以上のすべてのキャンペーン:
updateTime>="2020-11-04T18:54:47Z"
このフィールドの長さは 500 文字以下にする必要があります。 詳しくは、LIST リクエストのフィルタ ガイドをご覧ください。
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
{
"campaigns": [
{
object (Campaign )
}
],
"nextPageToken": string
} |
フィールド |
campaigns[] |
object (Campaign )
キャンペーンのリスト。 空の場合、このリストは存在しません。
|
nextPageToken |
string
結果の次のページを取得するためのトークン。 結果の次のページを取得するには、この値を後続の campaigns.list メソッド呼び出しの pageToken フィールドに渡します。
|
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/display-video
https://www.googleapis.com/auth/display-video-mediaplanning
詳しくは、OAuth 2.0 の概要をご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-08-21 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":"その他"
}]
{"lastModified": "\u6700\u7d42\u66f4\u65b0\u65e5 2024-08-21 UTC\u3002"}
[[["わかりやすい","easyToUnderstand","thumb-up"],["問題の解決に役立った","solvedMyProblem","thumb-up"],["その他","otherUp","thumb-up"]],[["必要な情報がない","missingTheInformationINeed","thumb-down"],["複雑すぎる / 手順が多すぎる","tooComplicatedTooManySteps","thumb-down"],["最新ではない","outOfDate","thumb-down"],["翻訳に関する問題","translationIssue","thumb-down"],["サンプル / コードに問題がある","samplesCodeIssue","thumb-down"],["その他","otherDown","thumb-down"]],["最終更新日 2024-08-21 UTC。"]]