Method: partners.channels.sites.list

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v2/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 の概要をご覧ください。