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ış. Teklif vermeye yönelik özel algoritmanı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 boyutunda ve UTF-8 kodlu olmalıdır.
entityStatus

enum (EntityStatus)

Özel teklif verme algoritmasının 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. 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.

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

object (CustomBiddingModelDetails)

Yalnızca çıkış. Erişimi olan her reklamveren için özel teklif 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.
Birleştirme alanı owner. Özel teklif verme algoritmasının sahibi olan DV360 varlığını 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üşteriler tarafından yüklenen özel teklif verme komut dosyası dosyaları aracılığıyla oluşturulan algoritma.
ADS_DATA_HUB_BASED

DEPRECATED: ADS_DATA_HUB_BASED kullanımdan kaldırıldı. Ads Data Hub ürünü aracılığıyla oluşturulan algoritma.
GOAL_BUILDER_BASED

KULLANIMDAN KALDIRILDI: GOAL_BUILDER_BASED kullanımdan kaldırıldı, artık desteklenmiyor ve RULE_BASED ile değiştirildi. DV3 kullanıcı arayüzündeki hedef oluşturucu aracılığıyla oluşturulan algoritma.

Bu türdeki mevcut algoritmalar RULE_BASED'e taşındı.
RULE_BASED

Tanımlanmış kurallara dayalı algoritma. Bu kurallar, AlgorithmRules nesnesi kullanılarak API'de 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 mesajı alır.

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

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

Sıralamalar
READINESS_STATE_UNSPECIFIED Bu sürümde eyalet belirtilmemiş veya bilinmiyor.
READINESS_STATE_ACTIVE Model eğitildi ve yayınlanmaya hazır.
READINESS_STATE_INSUFFICIENT_DATA Yayın modelini eğitmek için yeterli veri yok.
READINESS_STATE_TRAINING Model eğitiliyor ve sunuma hazır değil.
READINESS_STATE_NO_VALID_SCRIPT Modeli eğitmek için geçerli bir özel teklif verme komut dosyası sağlanmamıştır. 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ğerlendirme başarısız oldu. Bu durum, ayrılan süre içinde değerlendirilemeyen komut dosyaları için geçerlidir.

SuspensionState

Özel teklif verme modellerinin olası askıya alınma durumları.

Sıralamalar
SUSPENSION_STATE_UNSPECIFIED Bu sürümde eyalet belirtilmemiş veya bilinmiyor.
SUSPENSION_STATE_ENABLED Model etkinleştirilmişse (yakın zamanda kullanılmış, şu anda kullanılıyor veya kullanılmak üzere planlanmışsa) Bu reklamveren için algoritma, gösterimleri aktif olarak puanlıyor.
SUSPENSION_STATE_DORMANT Model yakın zamanda kullanılmamışsa Model hâlâ ENABLED olarak hareket etse de kullanılmadığı takdirde sonunda 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ı için zaman gerekir.

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ılabilecek özel teklif verme algoritmalarını listeler.

patch

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

uploadRules

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

uploadScript

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