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
  ],
  "modelReadiness": [
    {
      object (CustomBiddingModelReadinessState)
    }
  ],
  "customBiddingAlgorithmState": enum (State),

  // 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.
modelReadiness[]

object (CustomBiddingModelReadinessState)

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

Kolom ini hanya dapat menyertakan status pengiklan yang dikueri jika algoritme owner adalah partner dan diambil menggunakan pengiklan accessor.
customBiddingAlgorithmState

enum (State)

Hanya output. Status algoritma bidding kustom.
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.

CustomBiddingModelReadinessState

Status kesiapan model algoritma bidding kustom untuk satu pengiklan bersama.

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

string (int64 format)

ID unik pengiklan yang relevan.
readinessState

enum (ReadinessState)

Status kesiapan 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.

Negara Bagian

Kemungkinan status algoritma bidding kustom.

Enum
STATE_UNSPECIFIED Status tidak ditentukan atau tidak diketahui dalam versi ini.
ENABLED Algoritma diaktifkan, baik yang baru saja digunakan, sedang digunakan, atau dijadwalkan untuk digunakan. Algoritme ini secara aktif menilai tayangan.
DORMANT Algoritma tidak digunakan baru-baru ini. Meskipun algoritma masih bertindak sebagai ENABLED, algoritme pada akhirnya akan ditangguhkan jika tidak digunakan.
SUSPENDED Algoritma digunakan dari menilai tayangan dan tidak memiliki model penyaluran yang dilatih. Jika algoritme ditetapkan ke item baris 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.

uploadScript

 Membuat objek referensi skrip bidding kustom untuk file skrip.