REST Resource: customBiddingAlgorithms

Kaynak: Custom BiddingAlgorithm

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ı.

Maksimum 240 bayt boyutta UTF-8 olarak kodlanmış olmalıdır.
entityStatus

enum (EntityStatus)

Özel teklif verme algoritmasının bir teklif 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. Sabit. Ö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 o değerden oluşur.

owner algoritması bir iş ortağıysa ve accessor adlı reklamveren 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 owner algoritması bir iş ortağıysa ve accessor adlı reklamveren kullanılarak alınıyorsa sorgulanan reklamverenin ayrıntılarını içerebilir.
Birleştirme alanı owner. Özel teklif verme algoritmasının sahibi olan DV360 varlığını tanımlar. Bu bir iş ortağı veya reklamveren olabilir. owner şunlardan yalnızca biri olabilir:
partnerId

string (int64 format)

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

string (int64 format)

Sabit. Ö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ü belirtilmedi veya bu sürümde bilinmiyor.
SCRIPT_BASED Müşteri tarafından yüklenen özel teklif verme komut dosyası dosyalarıyla oluşturulan algoritma.
ADS_DATA_HUB_BASED Ads Data Hub ürünüyle oluşturulan algoritma.
GOAL_BUILDER_BASED DV3 kullanıcı arayüzündeki hedef oluşturucu aracılığıyla oluşturulan algoritma.
RULE_BASED

Tanımlanmış kurallara dayalı algoritma. Bu kurallar, API'de AlgorithmRules nesnesi kullanılarak tanımlanır.

Bu algoritma türü yalnızca izin verilenler listesindeki müşteriler tarafından kullanılabilir. Bu türü kullanmaya çalışan diğer müşteriler hata alır.

CustomBiddingModelDetails

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

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

string (int64 format)

Alakalı reklamverenin benzersiz kimliği.
readinessState

enum (ReadinessState)

Özel teklif modelinin hazır olma durumu.
suspensionState

enum (SuspensionState)

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

ReadinessState

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

Sıralamalar
READINESS_STATE_UNSPECIFIED Bu sürümde durum belirtilmemiş veya bilinmiyor.
READINESS_STATE_ACTIVE Model eğitildi ve hizmet vermeye hazır.
READINESS_STATE_INSUFFICIENT_DATA Sunma 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 Modeli eğitmek için geçerli bir özel teklif verme komut dosyası sağlanmadı. Bu durum yalnızca customBiddingAlgorithmType değeri SCRIPT_BASED olan algoritmalara uygulanır.
READINESS_STATE_EVALUATION_FAILURE Geçerli bir komut dosyası sağlandı ancak değerlendirmede başarısız oldu. Bu, kendisine ayrılan sürede değerlendirilemeyen komut dosyaları için geçerlidir.

SuspensionState

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

Sıralamalar
SUSPENSION_STATE_UNSPECIFIED Bu sürümde durum belirtilmemiş veya bilinmiyor.
SUSPENSION_STATE_ENABLED Model etkin durumda (son kullanılan, şu anda kullanılan veya kullanılmak üzere planlanmış) etkin. Algoritma, bu reklamveren için gösterimleri etkin olarak puanlıyor.
SUSPENSION_STATE_DORMANT Model yakın zamanda kullanılmadı. Model hâlâ ENABLED olarak çalışıyor olsa da kullanılmadığı takdirde bir süre sonra askıya alınır.
SUSPENSION_STATE_SUSPENDED Modelin puanlaması askıya alındığından sunulamaz. Algoritma, bu reklamverenin altındaki bir satır öğesine atanırsa veya başka bir şekilde güncellenirse ENABLED durumuna geri döner ve sunma modelini yeniden hazırlamak için zaman gerekir.

Yöntemler

create

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

get

 Özel bir teklif verme algoritması alır.

list

 Mevcut kullanıcının erişebildiği ve teklif stratejilerinde kullanılabilecek özel teklif verme algoritmalarını listeler.

patch

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

uploadRules

 Bir AlgorithmRules dosyası için kurallar referans nesnesi oluşturur.

uploadScript

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