Method: sellers.adUnits.list

広告ユニットを一覧表示します。

  • 例: GET /v1/sellers/seller111/adUnits
  • 成功した場合は、次のページを取得するための広告ユニットのリストとトークンを返します。
  • ユーザーが販売者にアクセスできない場合、または販売者 ID が存在しない場合は、エラーコード PERMISSION_DENIED を返します。
  • 販売者が無効なページサイズまたはページトークンを指定した場合は、エラーコード INVALID_ARGUMENT が返されます。

HTTP リクエスト

GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/adUnits

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。この広告ユニットのコレクションを所有する販売者。形式: sellers/{seller}

クエリ パラメータ

パラメータ
pageSize

integer

返される最大アイテム数。サービスが返す値はこれよりも少ないことがあります。広告ユニットの最大数は 1,000 です。1,000 を超える値は 1,000 に変更されます。指定されていない場合は、最大で 1, 000 個の広告ユニットが返されます。
pageToken

string

前の List リクエストから返された nextPageToken 値（存在する場合）。
filter

string

リストフィルタ。現在、外部 ID と状態のフィルタリング（構文:「externalId = [EXTERNAL_ID]」）がサポートされています。"state = [STATE]" のように構成されます。論理演算子 AND と OR を使用してフィルタを連結できます。AD_UNIT_STATE_DELETED を使用して、削除された広告ユニットを表示することはできません。代わりに showDeleted を使用してください。
orderBy

string

結果の並べ替え順序を指定するために使用される文字列による順序。現在、updateTime による並べ替えをサポートしています。「updateTime」を指定してください結果は updateTime の昇順または「updateTime desc」に並べ替えられます。降順に指定します。
showDeleted

boolean

削除済み（復元可能）広告ユニットを返すかどうか。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

InventoryService.ListUnits に対するレスポンス メッセージです。

JSON 表現 
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
フィールド
adUnits[]

object (AdUnit)

広告ユニットのリスト。
nextPageToken

string

結果の次のページを取得するためのトークン。 結果の次のページを取得するには、この値を後続の adUnits.list メソッド呼び出しの pageToken フィールドに渡します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/doubleclickbidmanager

詳しくは、OAuth 2.0 の概要をご覧ください。