Method: partners.channels.list

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
必須。チャネルを所有するディスプレイ＆ビデオ 360 エンティティを識別します。パートナーまたは広告主様のいずれかになります。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
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 リクエストのガイドをご覧ください。
必須。チャネルを所有するディスプレイ＆ビデオ 360 エンティティを識別します。パートナーまたは広告主様のいずれかになります。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
advertiserId

string (int64 format)

チャネルを所有する広告主の ID。
相互に排他的なフィールドの終わり。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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