REST Resource: guaranteedOrders

Kaynak: Garantili Sıralama

Sipariş garantisi.

Garantili siparişler, garantili envanter kaynaklarının üst varlığıdır. Garantili envanter kaynağı oluşturulurken envanter kaynağına garantili sipariş kimliği atanmalıdır.

JSON gösterimi 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}
Alanlar
name

string

Yalnızca çıkış. Garantili siparişin kaynak adı.
legacyGuaranteedOrderId

string

Yalnızca çıkış. Garantili siparişin eski kimliği. Orijinal exchange tarafından atanır. Eski kimlik bir exchange içinde benzersizdir ancak tüm garantili siparişlerde benzersiz olacağı garanti edilmez. Bu kimlik, SDF'de ve kullanıcı arayüzünde kullanılır.
exchange

enum (Exchange)

Zorunlu. Sabit. Garantili siparişin kaynaklandığı exchange.
guaranteedOrderId

string

Yalnızca çıkış. Garantili siparişin benzersiz tanımlayıcısı. Garantili sipariş kimlikleri {exchange}-{legacyGuaranteedOrderId} biçimindedir.
displayName

string

Zorunlu. Garantili siparişin görünen adı.

Maksimum 240 baytlık bir boyutla kodlanmış UTF-8 olmalıdır.
status

object (GuaranteedOrderStatus)

Garantili siparişin durum ayarları.
updateTime

string (Timestamp format)

Yalnızca çıkış. Garantili siparişin en son güncellendiği zaman damgası. Sistem tarafından atanır.

Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
publisherName

string

Zorunlu. Garantili siparişin yayıncı adı.

Maksimum 240 baytlık bir boyutla kodlanmış UTF-8 olmalıdır.
readAccessInherited

boolean

Tüm readWritePartnerId reklamverenlerinin garantili siparişe okuma erişimi olup olmadığı. Yalnızca readWritePartnerId ayarlandıysa geçerlidir. Doğru değerine ayarlanırsa readAdvertiserIds değerini geçersiz kılar.
readAdvertiserIds[]

string (int64 format)

Garantili siparişe okuma erişimi olan reklamverenlerin kimlikleri.

Bu alan, ayarlanmışsa readWriteAdvertiserId adlı reklamverene atanan reklamvereni içermemelidir. Bu alandaki tüm reklamverenler, readWritePartnerId şirketine veya readWriteAdvertiserId ile aynı iş ortağına ait olmalıdır.
defaultAdvertiserId

string (int64 format)

Yalnızca çıkış. Garantili siparişin varsayılan reklamvereninin kimliği.

Varsayılan reklamveren readWriteAdvertiserId veya ayarlanmazsa readAdvertiserIds öğesinde listelenen ilk reklamverendir. Aksi takdirde, varsayılan reklamveren yoktur.
defaultCampaignId

string (int64 format)

Garantili siparişe atanan varsayılan kampanyanın kimliği.

Varsayılan kampanya, varsayılan reklamverene ait olmalıdır.

read_write_accessor alanı. Zorunlu.

Garantili sipariş için okuma/yazma erişimi olan iş ortağı veya reklamveren. read_write_accessor şunlardan yalnızca biri olabilir:
readWritePartnerId

string (int64 format)

Garantili siparişe okuma/yazma erişimi olan iş ortağı.
readWriteAdvertiserId

string (int64 format)

Garantili sipariş için okuma/yazma erişimi olan reklamveren. Bu, aynı zamanda garantili siparişin varsayılan reklamverenidir.

GuaranteedOrderStatus

Garantili siparişin durum ayarları.

JSON gösterimi 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Alanlar
entityStatus

enum (EntityStatus)

Garantili siparişin yayınlanabilir olup olmadığı.

Kabul edilebilir değerler ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED ve ENTITY_STATUS_PAUSED'dir. ENTITY_STATUS_ACTIVE, varsayılan değerdir.
entityPauseReason

string

Bu garantili siparişi duraklatmanız için kullanıcı tarafından sağlanan neden.

Maksimum 100 bayt uzunlukla UTF-8 olarak kodlanmış olmalıdır.

Yalnızca entityStatus, ENTITY_STATUS_PAUSED olarak ayarlandığında geçerlidir.
configStatus

enum (GuaranteedOrderConfigStatus)

Yalnızca çıkış. Garantili siparişin yapılandırma durumu.

Kabul edilebilir değerler PENDING ve COMPLETED'dir.

Garantili bir siparişin yayınlanabilmesi için önce yapılandırılması gerekir (gerekli alanları doldurun, reklam öğelerini seçin ve varsayılan kampanya belirleyin). Şu anda yapılandırma işlemi yalnızca kullanıcı arayüzü aracılığıyla gerçekleştirilebilir.

GuaranteedOrderConfigStatus

Garantili sipariş için olası yapılandırma durumları.

Sıralamalar
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Onay durumu belirtilmemiş veya bu sürümde bilinmiyor.
PENDING Garantili bir siparişin başlangıç durumu. Bu durumdaki garantili siparişin, yayınlanmadan önce yapılandırılması gerekir.
COMPLETED Alıcının garantili bir siparişi yapılandırmasından sonraki durum.

Yöntemler

create

 Yeni bir garantili sipariş oluşturur.

editGuaranteedOrderReadAccessors

 Düzenlemeler garanti edilen sıradaki reklamverenleri okur.

get

 Sipariş garantisi sağlanır.

list

 Geçerli kullanıcının erişebileceği garanti edilen siparişleri listeler.

patch

 Mevcut bir garantili siparişi günceller.