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)
    }
  ],
  "thirdPartyOptimizationPartner": enum (ThirdPartyOptimizationPartnerType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.
}
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 berenkode 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 algoritma owner adalah partner dan diambil menggunakan accessor pengiklan.
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 accessor pengiklan.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

Opsional. Tidak dapat diubah. Menetapkan partner pengoptimalan pihak ketiga yang mengelola algoritma ini.
Mengidentifikasi entitas DV360 yang memiliki algoritma bidding kustom. Partner atau pengiklan. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
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.
Akhir kolom yang saling eksklusif.

CustomBiddingAlgorithmType

Jenis algoritma bidding kustom yang memungkinkan.

Enum
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Jenis algoritma tidak ditentukan atau tidak diketahui dalam versi ini.
SCRIPT_BASED Algoritma yang dihasilkan melalui file skrip bidding kustom yang diupload pelanggan.
RULE_BASED

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

Jenis algoritma ini hanya tersedia untuk pelanggan 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 telah dilatih dan siap untuk inferensi.
READINESS_STATE_INSUFFICIENT_DATA Data tidak cukup untuk melatih model inferensi.
READINESS_STATE_TRAINING Model sedang dilatih dan belum siap untuk inferensi.
READINESS_STATE_NO_VALID_SCRIPT Skrip bidding kustom yang valid belum diberikan untuk melatih model. Status ini hanya akan diterapkan ke algoritma yang customBiddingAlgorithmType-nya adalah SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE Skrip yang valid diberikan, tetapi gagal dievaluasi. Hal 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 baru saja digunakan, sedang digunakan, atau dijadwalkan untuk digunakan. Algoritma ini secara aktif menilai tayangan iklan untuk pengiklan ini.
SUSPENSION_STATE_DORMANT Model belum digunakan baru-baru ini. Meskipun model masih bertindak sebagai ENABLED, model tersebut pada akhirnya akan ditangguhkan jika tidak digunakan.
SUSPENSION_STATE_SUSPENDED Model ditangguhkan dari pemberian skor tayangan iklan dan tidak dapat ditayangkan. Jika algoritma ditetapkan ke item baris di bawah pengiklan ini atau diperbarui, algoritma akan beralih kembali ke status ENABLED dan memerlukan waktu untuk menyiapkan model penayangan lagi.

ThirdPartyOptimizationPartnerType

Jenis Partner Pengoptimalan Pihak Ketiga yang mungkin.

Enum
UNKNOWN Nilai jenis tidak ditentukan atau tidak diketahui dalam versi ini.
SCIBIDS Penyedia layanan data science pihak ketiga yang dapat diajak bekerja sama oleh partner/pengiklan DV3.
ADELAIDE Penyedia layanan pengukuran atensi pihak ketiga yang dapat diajak bekerja sama oleh partner/pengiklan DV3.

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.