Method: partners.channels.list

パートナーまたは広告主のチャネルを一覧表示します。

HTTP リクエスト

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

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

パスパラメータ

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

string (int64 format)

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

クエリ パラメータ

パラメータ
pageSize

integer

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

string

サーバーが返す必要がある結果のページを特定するトークンです。 通常、これは channels.list メソッドの前の呼び出しから返された nextPageToken の値です。指定しない場合、結果の最初のページが返されます。
orderBy

string

リストの並べ替え基準として使用するフィールド。指定できる値は次のとおりです。

  • displayName（デフォルト）
  • channelId

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

string

チャンネル フィールドでフィルタリングできます。

サポートされている構文:

  • チャンネルのフィルタ式に含めることができる制限は 1 つだけです。
  • 制限の形式は {field} {operator} {value} です。
  • すべてのフィールドで HAS (:) 演算子を使用する必要があります。

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

  • displayName

例:

  • 表示名に「google」を含むすべてのチャンネル: displayName : "google"。

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

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

string (int64 format)

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

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

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

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