Method: advertisers.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
現在のユーザーがアクセスできる広告主を一覧表示します。
順序は orderBy
パラメータで定義されます。
partnerId
は 1 つだけ必要です。クロス パートナー様の掲載情報はサポートされていません。
HTTP リクエスト
GET https://displayvideo.googleapis.com/v1/advertisers
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ |
partnerId |
string (int64 format)
必須。取得したすべての広告主が属するパートナーの ID。システムは、一度に 1 つのパートナーの広告主しかリストできません。
|
pageSize |
integer
リクエストされたページサイズです。 1 ~200 の範囲で指定してください。指定しない場合のデフォルトは 100 です。
|
pageToken |
string
サーバーが返す必要がある結果のページを特定するトークンです。 通常、これは前回の advertisers.list メソッドの呼び出しで返された nextPageToken の値です。指定しない場合、結果の最初のページが返されます。
|
orderBy |
string
リストの並べ替え基準となるフィールドです。有効な値は次のとおりです。
displayName (デフォルト)
entityStatus
updateTime
デフォルトの並べ替え順は昇順です。フィールドを降順で指定するには、フィールド名に「desc」という接尾辞を追加する必要があります。たとえば、displayName desc のようにします。
|
filter |
string
広告主のフィールドによるフィルタリングを可能にします。 サポートされる構文:
- フィルタ式は 1 つ以上の制限で構成されます。
- 制限は
AND または OR 論理演算子で組み合わせることができます。
- 制限の形式は
{field} {operator} {value} です。
updateTime フィールドでは GREATER THAN OR EQUAL TO (>=) または LESS THAN OR EQUAL TO (<=) 演算子を使用する必要があります。
- 他のすべてのフィールドでは
EQUALS (=) 演算子を使用する必要があります。
サポートされているフィールド:
advertiserId
displayName
entityStatus
updateTime (ISO 8601 形式または YYYY-MM-DDTHH:MM:SSZ での入力)
例:
- 同じパートナーのすべてのアクティブな広告主:
entityStatus="ENTITY_STATUS_ACTIVE"
- 更新時間が 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 表現 |
{
"advertisers": [
{
object (Advertiser )
}
],
"nextPageToken": string
} |
フィールド |
advertisers[] |
object (Advertiser )
広告主のリスト。 空の場合、このリストは存在しません。
|
nextPageToken |
string
結果の次のページを取得するためのトークン。 結果の次のページを取得するには、後続の advertisers.list メソッドの呼び出しで、この値を pageToken フィールドに渡します。
|
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/display-video
詳細については、OAuth 2.0 の概要をご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2023-12-02 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":"その他"
}]