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)
    }
  ],
  "thirdPartyOptimizationPartner": enum (ThirdPartyOptimizationPartnerType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.
}
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 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ştirilemez. Ö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 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.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

İsteğe bağlıdır. Değiştirilemez. Bu algoritmayı yöneten üçüncü taraf optimizasyon iş ortağını belirtir.
Özel teklif verme algoritmasının sahibi olan DV360 öğesini tanımlar. Bu, bir iş ortağı veya reklamveren olabilir. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
partnerId

string (int64 format)

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

string (int64 format)

Değiştirilemez. Özel teklif verme algoritmasının sahibi olan reklamverenin benzersiz kimliği.
Birbirini dışlayan alanların sonu.

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

CustomBiddingModelDetails

Paylaşılan tek bir reklamverene ait ö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 yayına 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, 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 (son zamanlarda kullanılmış, şu anda kullanılıyor veya kullanılmak üzere planlanmışsa) Algoritma, bu reklamveren için gösterimleri etkin bir şekilde puanlıyor.
SUSPENSION_STATE_DORMANT Model yakın zamanda kullanılmadı. Model hâlâ ENABLED olarak işlev görse de kullanılmadığı takdirde sonunda askıya alınır.
SUSPENSION_STATE_SUSPENDED Modelin gösterimleri puanlaması askıya alındı ve model reklam yayınlayamıyor. Algoritma bu reklamveren 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.

ThirdPartyOptimizationPartnerType

Olası üçüncü taraf optimizasyon iş ortağı türleri.

Sıralamalar
UNKNOWN Tür değeri belirtilmemiş veya bu sürümde bilinmiyor.
SCIBIDS DV3 iş ortaklarının/reklamverenlerin iş ortaklığı yapabileceği üçüncü taraf veri bilimi servis sağlayıcısı.
ADELAIDE DV3 iş ortaklarının/reklamverenlerin iş ortaklığı yapabileceği üçüncü taraf dikkat ölçümü hizmeti sağlayıcısı.

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