Method: customBiddingAlgorithms.list

現在のユーザーがアクセスでき、入札戦略で使用できるカスタム入札アルゴリズムのリストが表示されます。

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

string

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

  • displayName（デフォルト）

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

string

カスタム入札アルゴリズムのフィールドでフィルタリングできます。

サポートされる構文:

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

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

  • customBiddingAlgorithmType
  • displayName

例:

  • 表示名に「politics」が含まれるすべてのカスタム入札アルゴリズム: displayName:"politics"。
  • タイプが「SCRIPT_BASED」のすべてのカスタム入札アルゴリズム: customBiddingAlgorithmType=SCRIPT_BASED

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

詳しくは、LIST リクエストをフィルタするガイドをご覧ください。
結合パラメータ accessor。必須。リクエストがどの DV360 エンティティ内で行われたかを識別します。LIST リクエストでは、accessor 内で識別されたディスプレイ＆ビデオ 360 エンティティにアクセスできるカスタム入札アルゴリズム エンティティのみが返されます。LIST リクエストを実行するには、ユーザーに accessor エンティティに対する権限が必要です。accessor は次のいずれかになります。
partnerId

string (int64 format)

カスタム入札アルゴリズムにアクセスできるディスプレイ＆ビデオ 360 パートナーの ID。
advertiserId

string (int64 format)

カスタム入札アルゴリズムにアクセスできるディスプレイ＆ビデオ 360 広告主の ID。

リクエストの本文

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

レスポンスの本文

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

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

object (CustomBiddingAlgorithm)

カスタム入札アルゴリズムのリスト。

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

string

結果の次のページを取得するためのトークン。 この値を、後続の ListCustomBiddingAlgorithmsRequest メソッド呼び出しの pageToken フィールドで渡して、結果の次のページを取得します。このフィールドが null の場合、これが最後のページです。

認可スコープ

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

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

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