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。必須。リクエストが行われるディスプレイ&ビデオ 360 エンティティを識別できます。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 の概要をご覧ください。