REST Resource: customBiddingAlgorithms

リソース: CustomBiddingAlgorithm

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

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 ディスプレイ&ビデオ 360 の UI の目標作成ツールで作成されたアルゴリズム。
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 に戻り、配信モデルを再度準備する時間が必要になります。

メソッド

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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