REST Resource: customBiddingAlgorithms

リソース: CustomBiddingAlgorithm

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

JSON 表現 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelReadiness": [
    {
      object (CustomBiddingModelReadinessState)
    }
  ],
  "customBiddingAlgorithmState": enum (State),

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
フィールド
name

string

出力専用。カスタム入札アルゴリズムのリソース名。
customBiddingAlgorithmId

string (int64 format)

出力専用。カスタム入札アルゴリズムの一意の ID。システムによって割り当てられます。
displayName

string

必須。カスタム入札アルゴリズムの表示名。

UTF-8 でエンコードし、最大サイズを 240 バイトにする必要があります。
entityStatus

enum (EntityStatus)

カスタム入札アルゴリズムを入札戦略として使用できるかどうかを制御します。

次の値が利用できます。

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

必須。変更不可。カスタム入札アルゴリズムのタイプ。
sharedAdvertiserIds[]

string (int64 format)

このアルゴリズムにアクセスできる広告主の ID。advertiserId が設定されている場合、このフィールドはその値のみで構成されます。

アルゴリズム owner がパートナーで、広告主 accessor を使用して取得されている場合、このフィールドは設定されません。
modelReadiness[]

object (CustomBiddingModelReadinessState)

出力専用。アクセス権を持つ各広告主におけるカスタム入札モデルの準備状況。

アルゴリズム owner がパートナーであり、広告主 accessor を使用して取得されている場合にのみ、このフィールドにクエリ対象の広告主の状態を含めることができます。
customBiddingAlgorithmState

enum (State)

出力専用。カスタム入札アルゴリズムのステータス。
共用体フィールド owner。カスタム入札アルゴリズムを所有するディスプレイ&ビデオ 360 エンティティを表します。パートナーまたは広告主のいずれかになります。owner は次のいずれかになります。
partnerId

string (int64 format)

変更不可。カスタム入札アルゴリズムを所有するパートナーの一意の ID。
advertiserId

string (int64 format)

変更不可。カスタム入札アルゴリズムを所有する広告主の一意の ID。

CustomBiddingAlgorithmType

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

列挙型
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED アルゴリズムのタイプが指定されていないか、このバージョンで不明です。
SCRIPT_BASED 顧客がアップロードしたカスタム入札スクリプト ファイルから生成されるアルゴリズム。
ADS_DATA_HUB_BASED Ads Data Hub プロダクトを通じて作成されたアルゴリズム。
GOAL_BUILDER_BASED ディスプレイ&ビデオ 360 の UI の目標作成ツールで作成されたアルゴリズム。

CustomBiddingModelReadinessState

単一の共有広告主に対するカスタム入札アルゴリズムのモデルの準備状況。

JSON 表現 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState)
}
フィールド
advertiserId

string (int64 format)

関連する広告主の一意の ID。
readinessState

enum (ReadinessState)

カスタム入札モデルの準備状況。

ReadinessState

モデルの準備状況に関して考えられる状態。

列挙型
READINESS_STATE_UNSPECIFIED このバージョンでは状態が指定されていないか、不明です。
READINESS_STATE_ACTIVE モデルのトレーニングが完了し、サービングの準備ができました。
READINESS_STATE_INSUFFICIENT_DATA サービング モデルをトレーニングするのに十分なデータがありません。
READINESS_STATE_TRAINING モデルはトレーニング中で、サービングの準備ができていません。
READINESS_STATE_NO_VALID_SCRIPT モデルのトレーニングに使用する有効なカスタム入札スクリプトが提供されていません。この状態は、customBiddingAlgorithmType が SCRIPT_BASED のアルゴリズムにのみ適用されます。

州

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

列挙型
STATE_UNSPECIFIED このバージョンでは状態が指定されていないか、不明です。
ENABLED アルゴリズムが有効になっています（最近使用した、現在使用されている、または使用する予定）。アルゴリズムでインプレッションのスコア計算がアクティブになっています。
DORMANT アルゴリズムは最近使用されていません。アルゴリズムは引き続き ENABLED として機能しますが、使用しない場合は最終的に一時停止されます。
SUSPENDED アルゴリズムによるインプレッションのスコア付けが行われていないため、サービング モデルがトレーニングされていません。アルゴリズムが広告申込情報に割り当てられているか、それ以外の方法で更新された場合、状態は ENABLED に戻り、サービング モデルを再度準備するのに時間がかかります。

メソッド

create

 新しいカスタム入札アルゴリズムを作成します。

get

 カスタム入札アルゴリズムを取得します。

list

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

patch

 既存のカスタム入札アルゴリズムを更新します。

uploadScript

 スクリプト ファイル用のカスタム入札スクリプト参照オブジェクトを作成します。