Method: partners.channels.sites.list

チャンネル内のサイトを一覧表示します。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/partners/{partnerId}/channels/{channelId}/sites

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

パスパラメータ

パラメータ
channelId

string (int64 format)

必須。リクエストされたサイトが属する親チャネルの ID。
結合パラメータ owner。必須。親チャンネルを所有するディスプレイ＆ビデオ 360 エンティティを識別します。パートナーまたは広告主のいずれかになります。owner は次のいずれかになります。
partnerId

string (int64 format)

親チャネルを所有するパートナーの ID。

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズ。1～10000 の範囲で指定してください。指定しない場合、デフォルトで 100 になります。無効な値が指定された場合は、エラーコード INVALID_ARGUMENT を返します。
pageToken

string

サーバーが返す必要がある結果のページを特定するトークン。

通常、これは sites.list メソッドの前の呼び出しから返された nextPageToken の値です。指定しない場合は、結果の最初のページが返されます。
orderBy

string

リストの並べ替えに使用するフィールド。使用できる値は次のとおりです。

  • urlOrAppId（デフォルト）

デフォルトの並べ替え順序は昇順です。フィールドに対して降順を指定するには、フィールド名に接尾辞「desc」を追加する必要があります。例: urlOrAppId desc。
filter

string

サイト フィールドでフィルタリングできます。

サポートされる構文:

  • サイト取得のフィルタ式に指定できる制限は 1 つまでです。
  • 制限の形式は {field} {operator} {value} です。
  • すべてのフィールドで HAS (:) 演算子を使用する必要があります。

サポートされているフィールド:

  • urlOrAppId

例:

  • URL またはアプリ ID に「google」が含まれるすべてのサイト: urlOrAppId : "google"

このフィールドの長さは 500 文字以下にする必要があります。

詳しくは、フィルタ LIST リクエストのガイドをご覧ください。
結合パラメータ owner。必須。親チャンネルを所有するディスプレイ＆ビデオ 360 エンティティを識別します。パートナーまたは広告主のいずれかになります。owner は次のいずれかになります。
advertiserId

string (int64 format)

親チャネルを所有する広告主の ID。

リクエストの本文

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

レスポンスの本文

成功した場合、レスポンスの本文には ListSitesResponse のインスタンスが含まれます。

認可スコープ

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

  • https://www.googleapis.com/auth/display-video

詳細については、OAuth 2.0 Overview をご覧ください。