Method: partners.channels.list

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
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 リクエストのフィルタに関するガイドをご覧ください。
advertiserId

string (int64 format)

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

リクエスト本文

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

レスポンスの本文

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

認証スコープ

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

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

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