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 boyutunda 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 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, sorgulanan reklamverenin ayrıntılarını yalnızca owner algoritması bir iş ortağıysa ve bir reklamveren accessor ile alınıyorsa içerebilir.
Birleştirme alanı owner. Özel teklif verme algoritmasının sahibi olan DV360 varlığını tanımlar. 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 Bu sürümde algoritma türü belirtilmemiş veya 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ü aracılığıyla oluşturulan algoritma.
GOAL_BUILDER_BASED DV3 kullanıcı arayüzündeki hedef oluşturucu ile 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 verme modelinin hazırlık durumu.
suspensionState

enum (SuspensionState)

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

ReadinessState

Modelin 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 yayına hazır.
READINESS_STATE_INSUFFICIENT_DATA Sunum modelini eğitmek için yeterli veri yok.
READINESS_STATE_TRAINING Model eğitiliyor ve yayına hazır değil.
READINESS_STATE_NO_VALID_SCRIPT Modelin eğitilmesi için kullanılacak 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 alınma durumları.

Sıralamalar
SUSPENSION_STATE_UNSPECIFIED Bu sürümde durum belirtilmemiş veya bilinmiyor.
SUSPENSION_STATE_ENABLED Model etkinleştirildi; son kullanılan, şu anda kullanılan veya kullanım için planlanmış. Algoritma, bu reklamveren için gösterimleri etkin bir şekilde puanlıyor.
SUSPENSION_STATE_DORMANT Model yakın zamanda kullanılmadı. Model ENABLED olarak işlev görmeye devam etse de kullanılmadığı takdirde bir süre sonra askıya alınır.
SUSPENSION_STATE_SUSPENDED Modelin gösterim puanlaması askıya alındı ve sunulamaz. Algoritma, bu reklamveren altındaki bir satır öğesine atanır veya başka bir şekilde güncellenirse ENABLED durumuna geri dönecek ve sunma modelini tekrar hazırlamak için zaman gerektirecektir.

Yöntemler

create

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

get

 Özel teklif verme algoritması alır.

list

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

patch

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

uploadScript

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