REST Resource: customBiddingAlgorithms

Kaynak: CustomBiddingAlgorithm

Tek bir özel teklif verme algoritması.

JSON gösterimi 
{
  "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.
}
Alanlar
name

string

Yalnızca çıkış. Özel teklif verme algoritmasının kaynak adı.
customBiddingAlgorithmId

string (int64 format)

Yalnızca çıkış. Özel teklif verme algoritmasının benzersiz kimliği. Sistem tarafından atanır.
displayName

string

Zorunlu. Özel teklif verme algoritmasının görünen adı.

UTF-8 kodlu olmalı ve en fazla 240 bayt boyutunda olmalıdır.
entityStatus

enum (EntityStatus)

Özel teklif verme algoritmasının teklif verme stratejisi olarak kullanılıp kullanılamayacağını kontrol eder.

Kabul edilen değerler şunlardır:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Zorunlu. Değişmez. Özel teklif verme algoritmasının türü.
sharedAdvertiserIds[]

string (int64 format)

Bu algoritmaya erişimi olan reklamverenlerin kimlikleri. advertiserId ayarlanırsa bu alan yalnızca bu değerden oluşur.

Algoritma owner bir iş ortağıysa ve bir reklamveren accessor kullanılarak alınıyorsa bu alan ayarlanmaz.
modelDetails[]

object (CustomBiddingModelDetails)

Yalnızca çıkış. Erişimi olan her reklamveren için özel teklif verme modellerinin ayrıntıları.

Bu alan yalnızca algoritma owner bir iş ortağıysa ve bir reklamveren accessor kullanılarak alınıyorsa sorgulanan reklamverenin ayrıntılarını içerebilir.
Birlik alanı owner. Özel teklif verme algoritmasının sahibi olan DV360 öğesini tanımlar. İş ortağı veya reklamveren olabilir. owner yalnızca aşağıdakilerden biri olabilir:
partnerId

string (int64 format)

Değişmez. Özel teklif verme algoritmasının sahibi olan iş ortağının benzersiz kimliği.
advertiserId

string (int64 format)

Değişmez. Özel teklif verme algoritmasının sahibi olan reklamverenin benzersiz kimliği.

CustomBiddingAlgorithmType

Olası özel teklif verme algoritması türleri.

Sıralamalar
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Algoritma türü belirtilmemiş veya bu sürümde bilinmiyor.
SCRIPT_BASED Müşteri tarafından yüklenen özel teklif verme komut dosyası dosyaları aracılığıyla oluşturulan algoritma.
ADS_DATA_HUB_BASED Ads Data Hub ürünü aracılığıyla oluşturulan algoritma.
GOAL_BUILDER_BASED DV3 kullanıcı arayüzündeki hedef oluşturucu aracılığıyla oluşturulan algoritma.

CustomBiddingModelDetails

Tek bir paylaşılan reklamveren için özel teklif verme algoritması modelinin ayrıntıları.

JSON gösterimi 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Alanlar
advertiserId

string (int64 format)

İlgili reklamverenin benzersiz kimliği.
readinessState

enum (ReadinessState)

Özel teklif modelinin hazırlık durumu.
suspensionState

enum (SuspensionState)

Yalnızca çıkış. Özel teklif modelinin askıya alınma durumu.

ReadinessState

Model hazırlık durumunun olası durumları.

Sıralamalar
READINESS_STATE_UNSPECIFIED Durum belirtilmemiş veya bu sürümde bilinmiyor.
READINESS_STATE_ACTIVE Model eğitildi ve yayınlanmaya hazır.
READINESS_STATE_INSUFFICIENT_DATA Yayınlama modelini eğitmek için yeterli veri yok.
READINESS_STATE_TRAINING Model eğitiliyor ve yayınlanmaya hazır değil.
READINESS_STATE_NO_VALID_SCRIPT Modelin eğitileceği geçerli bir özel teklif verme komut dosyası sağlanmadı. Bu durum yalnızca customBiddingAlgorithmType değeri SCRIPT_BASED olan algoritmalara uygulanır.

SuspensionState

Özel teklif verme modellerinin olası askıya alma durumları.

Sıralamalar
SUSPENSION_STATE_UNSPECIFIED Durum belirtilmemiş veya bu sürümde bilinmiyor.
SUSPENSION_STATE_ENABLED Model etkin, yakın zamanda kullanılmış, şu anda kullanılıyor veya kullanılması planlanmış. Algoritma, bu reklamveren için gösterimleri etkin bir şekilde puanlıyor.
SUSPENSION_STATE_DORMANT Model yakın zamanda kullanılmadıysa. Model hâlâ ENABLED olarak görünse de kullanılmazsa askıya alınır.
SUSPENSION_STATE_SUSPENDED Modelin gösterimleri puanlaması askıya alındı ve model yayınlanamıyor. Algoritma bu reklamverenin altındaki bir satır öğesine atanırsa veya başka bir şekilde güncellenirse ENABLED durumuna geri döner ve yayın modelinin tekrar hazırlanması zaman alır.

Yöntemler

create

 Yeni bir özel teklif verme algoritması oluşturur.

get

 Özel teklif verme algoritması alır.

list

 Geçerli kullanıcının erişebildiği ve teklif stratejilerinde kullanılabilen özel teklif verme algoritmalarını listeler.

patch

 Mevcut bir özel teklif verme algoritmasını günceller.

uploadScript

 Bir komut dosyası dosyası için özel teklif verme komut dosyası referans nesnesi oluşturur.