REST Resource: customBiddingAlgorithms

リソース: CustomBidAlgorithm

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

JSON 表現 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],

  // 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 を使用して取得されている場合、このフィールドは設定されません。
modelDetails[]

object (CustomBiddingModelDetails)

出力のみ。アクセス権のある各広告主のカスタム入札モデルの詳細。

このフィールドに、クエリ対象の広告主の詳細が含まれるのは、アルゴリズム owner がパートナーで、広告主 accessor を使用して取得される場合のみです。
共用体フィールド 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 DV3 管理画面の目標作成ツールを介して作成されたアルゴリズム。
RULE_BASED

定義済みのルールに基づくアルゴリズム。これらのルールは、AlgorithmRules オブジェクトを使用して API で定義されます。

このアルゴリズムの種類は、許可リストに登録されたお客様のみご利用いただけます。他のお客様がこのタイプを使用しようとすると、エラーが発生します。

CustomBiddingModelDetails

単一の共有広告主のカスタム入札アルゴリズム モデルの詳細です。

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

string (int64 format)

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

enum (ReadinessState)

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

enum (SuspensionState)

出力のみ。カスタム入札モデルの強制停止ステータスです。

ReadinessState

モデルの準備状況の考えられる状態。

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

SuspensionState

カスタム入札モデルが一時停止される可能性があるステータス。

列挙型
SUSPENSION_STATE_UNSPECIFIED このバージョンでは状態が指定されていないか、不明です。
SUSPENSION_STATE_ENABLED モデルが有効（最近使用済み、現在使用中、使用予定）のいずれかです。アルゴリズムによってこの広告主のインプレッションのスコア付けがアクティブに行われています。
SUSPENSION_STATE_DORMANT モデルは最近使用されていません。モデルは引き続き ENABLED として機能しますが、使用しない場合、最終的に停止します。
SUSPENSION_STATE_SUSPENDED このモデルはインプレッションのスコア付けが停止され、配信できません。アルゴリズムがこの広告主の広告申込情報に割り当てられているか、更新されると、ステータスが ENABLED に戻り、配信モデルをもう一度準備するのに時間がかかります。

Methods

create

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

get

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

list

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

patch

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

uploadRules

 AlgorithmRules ファイルのルール参照オブジェクトを作成します。

uploadScript

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