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

UTF-8 olarak kodlanmış ve maksimum 240 bayt boyutunda 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:

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

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.
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, birbirini dışlayan alanların listesi verilmiştir. Yanıtta alanlardan en fazla biri 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 hariç tutan 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üşteri tarafından yüklenen özel teklif verme komut dosyası 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

Paylaşılan tek bir 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ı halleri.

Sıralamalar
READINESS_STATE_UNSPECIFIED Durum belirtilmemiş veya bu sürümde bilinmiyor.
READINESS_STATE_ACTIVE Model eğitilmiştir ve yayınlanmaya hazırdı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 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ğerlendirme başarısız oldu. Bu durum, ayrılan sürede değerlendirilemeyen komut dosyaları için geçerlidir.

SuspensionState

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

Sıralamalar
SUSPENSION_STATE_UNSPECIFIED Durum belirtilmemiş veya bu sürümde bilinmiyor.
SUSPENSION_STATE_ENABLED Model etkinleştirilmiş, 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ı. Model hâlâ ENABLED olarak çalışsa da kullanılmadığı takdirde 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ınlama modelini tekrar hazırlamak için zamana ihtiyaç duyar.

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/reklamverenlerinin iş ortaklığı yapabileceği üçüncü taraf veri bilimi servis sağlayıcısı.
ADELAIDE DV3 iş ortaklarının/reklamverenlerinin 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şebileceğ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 kural referans nesnesi oluşturur.

uploadScript

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