Method: customBiddingAlgorithms.rules.list

指定されたアルゴリズムに属するルールリソースを一覧表示します。

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/customBiddingAlgorithms/{customBiddingAlgorithmId}/rules

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

パスパラメータ

パラメータ
customBiddingAlgorithmId

string (int64 format)

必須。ルールリソースを所有するカスタム入札アルゴリズムの ID。

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

string

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

  • createTime desc（デフォルト）

デフォルトの並べ替え順序は降順です。フィールドに対して昇順を指定するには、接尾辞「desc」を削除する必要があります。例: createTime。
結合パラメータ accessor。必須。親のカスタム入札アルゴリズムを所有するディスプレイ&ビデオ 360 エンティティを識別します。パートナーまたは広告主のいずれかです。accessor は次のいずれかになります。
partnerId

string (int64 format)

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

string (int64 format)

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

リクエスト本文

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

レスポンスの本文

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

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

object (CustomBiddingAlgorithmRules)

CustomBiddingAlgorithmRules リソースのリスト。

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

string

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

認可スコープ

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

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

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