Method: partners.list

現在のユーザーがアクセスできるパートナーを一覧表示します。

順序は orderBy パラメータで定義します。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/partners

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

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズです。 1～200 の値にしてください。指定しない場合、デフォルトの 100 が使用されます。
pageToken

string

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

string

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

  • displayName

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

string

パートナー フィールドでフィルタできます。

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

  • フィルタ式は、1 つ以上の制限で構成されます。
  • 制限は、AND 論理演算子または OR 論理演算子で組み合わせることができます。制限のシーケンスでは、暗黙的に AND が使用されます。
  • 制限の形式は {field} {operator} {value} です。
  • すべてのフィールドで EQUALS (=) 演算子を使用する必要があります。

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

  • entityStatus

例:

  • すべての有効なパートナー: entityStatus="ENTITY_STATUS_ACTIVE"

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

詳しくは、LIST リクエストをフィルタするガイドをご覧ください。

リクエスト本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "partners": [
    {
      object (Partner)
    }
  ],
  "nextPageToken": string
}
フィールド
partners[]

object (Partner)

パートナーのリスト。

リストが空の場合は、このリストは表示されません。
nextPageToken

string

結果の次のページを取得するためのトークン。 結果の次のページを取得するには、この値を後続の partners.list メソッド呼び出しの pageToken フィールドに渡します。

認可スコープ

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

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

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