REST Resource: customBiddingAlgorithms

Resource: CustomBiddingAlgorithm

Satu algoritma bidding kustom.

Representasi 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.
}
Kolom
name

string

Hanya output. Nama resource algoritma bidding kustom.
customBiddingAlgorithmId

string (int64 format)

Hanya output. ID unik algoritma bidding kustom. Ditetapkan oleh sistem.
displayName

string

Wajib. Nama tampilan algoritma bidding kustom.

Harus dienkode UTF-8 dengan ukuran maksimum 240 byte.
entityStatus

enum (EntityStatus)

Mengontrol apakah algoritma bidding kustom dapat digunakan sebagai strategi bidding atau tidak.

Nilai yang diterima adalah:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Wajib. Tidak dapat diubah. Jenis algoritma bidding kustom.
sharedAdvertiserIds[]

string (int64 format)

ID pengiklan yang memiliki akses ke algoritma ini. Jika advertiserId ditetapkan, kolom ini hanya akan berisi nilai tersebut.

Kolom ini tidak akan ditetapkan jika algoritme owner adalah partner dan diambil menggunakan pengiklan accessor.
modelDetails[]

object (CustomBiddingModelDetails)

Hanya output. Detail model bidding kustom untuk setiap pengiklan yang memiliki akses.

Kolom ini hanya dapat menyertakan detail pengiklan yang dikueri jika algoritma owner adalah partner dan diambil menggunakan pengiklan accessor.
Kolom union owner. Mengidentifikasi entitas DV360 yang memiliki algoritma bidding kustom. Partner dapat berupa partner atau pengiklan. owner hanya ada berupa salah satu diantara berikut:
partnerId

string (int64 format)

Tidak dapat diubah. ID unik partner yang memiliki algoritma bidding kustom.
advertiserId

string (int64 format)

Tidak dapat diubah. ID unik pengiklan yang memiliki algoritma bidding kustom.

CustomBiddingAlgorithmType

Kemungkinan jenis algoritma bidding kustom.

Enum
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Jenis algoritma tidak ditentukan atau tidak diketahui pada versi ini.
SCRIPT_BASED Algoritme yang dihasilkan melalui file skrip bidding kustom yang diupload pelanggan.
ADS_DATA_HUB_BASED Algoritme yang dibuat melalui produk Ads Data Hub.
GOAL_BUILDER_BASED Algoritma yang dibuat melalui pembuat sasaran di UI DV3.
RULE_BASED

Algoritma yang didasarkan pada aturan yang ditentukan. Aturan ini ditentukan di API menggunakan objek AlgorithmRules.

Jenis algoritma ini hanya tersedia untuk pelanggan dalam daftar yang diizinkan. Pelanggan lain yang mencoba menggunakan jenis ini akan menerima error.

CustomBiddingModelDetails

Detail model algoritma bidding kustom untuk satu pengiklan bersama.

Representasi JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Kolom
advertiserId

string (int64 format)

ID unik pengiklan yang relevan.
readinessState

enum (ReadinessState)

Status kesiapan model bidding kustom.
suspensionState

enum (SuspensionState)

Hanya output. Status penangguhan model bidding kustom.

ReadinessState

Kemungkinan status kesiapan model.

Enum
READINESS_STATE_UNSPECIFIED Status tidak ditentukan atau tidak diketahui dalam versi ini.
READINESS_STATE_ACTIVE Model dilatih dan siap disalurkan.
READINESS_STATE_INSUFFICIENT_DATA Tidak ada cukup data untuk melatih model penyaluran.
READINESS_STATE_TRAINING Model ini sedang dilatih dan belum siap untuk ditayangkan.
READINESS_STATE_NO_VALID_SCRIPT Skrip bidding kustom yang valid belum disediakan untuk melatih model. Status ini hanya akan diterapkan ke algoritme yang customBiddingAlgorithmType-nya adalah SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE Skrip yang valid diberikan, tetapi evaluasi gagal. Ini berlaku untuk skrip yang tidak dapat dievaluasi dalam waktu yang ditentukan.

SuspensionState

Kemungkinan status penangguhan model bidding kustom.

Enum
SUSPENSION_STATE_UNSPECIFIED Status tidak ditentukan atau tidak diketahui dalam versi ini.
SUSPENSION_STATE_ENABLED Model diaktifkan, baik yang baru saja digunakan, sedang digunakan, atau dijadwalkan untuk digunakan. Algoritme secara aktif menilai tayangan untuk pengiklan ini.
SUSPENSION_STATE_DORMANT Model tidak digunakan baru-baru ini. Meskipun masih bertindak sebagai ENABLED, model tersebut pada akhirnya akan ditangguhkan jika tidak digunakan.
SUSPENSION_STATE_SUSPENDED Model ditangguhkan sehingga tidak dapat menilai tayangan dan tidak dapat ditayangkan. Jika algoritme ditetapkan ke item baris di bagian pengiklan ini atau diperbarui, algoritme akan beralih kembali ke status ENABLED dan memerlukan waktu untuk menyiapkan model penayangan lagi.

Metode

create

 Membuat algoritma bidding kustom baru.

get

 Mendapatkan algoritma bidding kustom.

list

 Mencantumkan algoritma bidding kustom yang dapat diakses oleh pengguna saat ini dan dapat digunakan dalam strategi bidding.

patch

 Memperbarui algoritma bidding kustom yang ada.

uploadRules

 Membuat objek referensi aturan untuk file AlgorithmRules.

uploadScript

 Membuat objek referensi skrip bidding kustom untuk file skrip.