Method: customBiddingAlgorithms.scripts.list

指定されたアルゴリズムに属するカスタム入札スクリプトを一覧表示します。

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v1/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts

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

パスパラメータ

パラメータ
customBiddingAlgorithmId

string (int64 format)

必須。スクリプトはカスタム入札アルゴリズムの ID によって作成されます。

クエリ パラメータ

パラメータ
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • createTime desc(デフォルト)

デフォルトの並べ替え順は降順です。フィールドの昇順を指定するには、接尾辞「desc」を削除する必要があります。(例: createTime)。

ユニオン パラメータ accessor。必須。親のカスタム入札アルゴリズムを所有するディスプレイ&ビデオ 360 エンティティを示します。パートナー様または広告主様のいずれかです。accessor は次のいずれかになります。
partnerId

string (int64 format)

親カスタム入札アルゴリズムを所有するパートナーの ID。

このカスタム入札スクリプトへの書き込みアクセス権を持つのは、このパートナーのみです。

advertiserId

string (int64 format)

親カスタム入札アルゴリズムを所有する広告主の ID。

リクエスト本文

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

レスポンスの本文

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

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

object (CustomBiddingScript)

カスタム入札スクリプトのリスト。

空の場合、このリストは存在しません。

nextPageToken

string

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

認可スコープ

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

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

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