REST Resource: customBiddingAlgorithms

リソース: CustomBiddingAlgorithm

1 つのカスタム入札アルゴリズム。

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

  // 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 を使用して取得されている場合のみです。
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

省略可。変更不可。このアルゴリズムを管理する第三者最適化パートナーを指定します。
共用体フィールド owner。カスタム入札アルゴリズムを所有するディスプレイ＆ビデオ 360 エンティティを識別します。パートナーまたは広告主のいずれかになります。owner は次のいずれかになります。
partnerId

string (int64 format)

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

string (int64 format)

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

CustomBiddingAlgorithmType

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

列挙型
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED このバージョンでは、アルゴリズム タイプが指定されていないか、不明です。
SCRIPT_BASED お客様がアップロードしたカスタム入札スクリプト ファイルから生成されたアルゴリズム。
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 状態に戻り、配信モデルの再準備に時間がかかります。

ThirdPartyOptimizationPartnerType

サードパーティ最適化パートナーのタイプ。

列挙型
UNKNOWN このバージョンでは、Type 値が指定されていないか、不明です。
SCIBIDS DV3 パートナーや広告主が提携できるサードパーティのデータ サイエンス サービス プロバイダ。
ADELAIDE DV3 パートナー/広告主様が提携できる第三者のアテンション測定サービス プロバイダ。

メソッド

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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