現在のユーザーがアクセスできる広告主を一覧表示します。
順序は orderBy
パラメータで定義されます。
partnerId
は 1 つだけ必要です。クロス パートナー様の掲載情報はサポートされていません。
HTTP リクエスト
GET https://displayvideo.googleapis.com/v3/advertisers
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
partnerId |
必須。取得したすべての広告主が属するパートナーの ID。システムは、一度に 1 つのパートナーの広告主しかリストできません。 |
pageSize |
リクエストされたページサイズです。 |
pageToken |
サーバーが返す必要がある結果のページを特定するトークンです。 通常、これは前回の |
orderBy |
リストの並べ替え基準となるフィールドです。有効な値は次のとおりです。
デフォルトの並べ替え順は昇順です。フィールドを降順で指定するには、フィールド名に「desc」という接尾辞を追加する必要があります。たとえば、 |
filter |
広告主のフィールドによるフィルタリングを可能にします。 サポートされる構文:
サポートされているフィールド:
例:
このフィールドの長さは 500 文字以下にする必要があります。 詳しくは、 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"advertisers": [
{
object ( |
フィールド | |
---|---|
advertisers[] |
広告主のリスト。 空の場合、このリストは存在しません。 |
nextPageToken |
結果の次のページを取得するためのトークン。 結果の次のページを取得するには、後続の |
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/display-video
詳細については、OAuth 2.0 の概要をご覧ください。