REST Resource: guaranteedOrders

Kaynak: GarantiliSipariş

Garantili sipariş.

Garantili siparişler, garantili envanter kaynaklarının üst varlığıdır. Garantili envanter kaynağı oluştururken 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'te benzersizdir ancak tüm garantili siparişlerde benzersiz olması garanti edilmez. Bu kimlik, SDF ve kullanıcı arayüzünde kullanılır.
exchange

enum (Exchange)

Zorunlu. Değişmez. Garantili siparişin oluşturulduğu exchange.
guaranteedOrderId

string

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

string

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

UTF-8 kodlu olmalı ve en fazla 240 bayt boyutunda 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üğüne sahip ve en fazla dokuz kesirli basamak içeren 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 bayt boyutta UTF-8 olarak kodlanmış olmalıdır.
readAccessInherited

boolean

readWritePartnerId'teki tüm reklamverenlerin garantili siparişe okuma erişimi olup olmadığı. Yalnızca readWritePartnerId ayarlanmışsa geçerlidir. Doğru ise readAdvertiserIds değerini geçersiz kılar.
readAdvertiserIds[]

string (int64 format)

Garantili sipariş için okuma erişimi olan reklamverenlerin kimlikleri.

Bu alan, ayarlanmışsa readWriteAdvertiserId alanına atanan reklamvereni içermemelidir. Bu alandaki tüm reklamverenler readWritePartnerId'e 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 bu ayarlanmamışsa readAdvertiserIds içinde listelenen ilk reklamverendir. Aksi takdirde varsayılan reklamveren olmaz.
defaultCampaignId

string (int64 format)

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

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

Birlik alanı read_write_accessor. Zorunlu.

Garantili siparişe okuma/yazma erişimi olan iş ortağı veya reklamveren. read_write_accessor yalnızca aşağıdakilerden biri olabilir:
readWritePartnerId

string (int64 format)

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

string (int64 format)

Garantili siparişe 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)

Garanti edilen siparişin yayınlanabilir olup olmadığı.

Kabul edilen değerler ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED ve ENTITY_STATUS_PAUSED'dir. Varsayılan değer ENTITY_STATUS_ACTIVE'tür.
entityPauseReason

string

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

UTF-8 kodlu ve en fazla 100 bayt uzunluğunda 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.

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

GuaranteedOrderConfigStatus

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

Sıralamalar
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Onay durumu bu sürümde belirtilmemiş veya bilinmiyor.
PENDING Garantili siparişin başlangıç durumu. Bu durumdaki garantili siparişin yayınlanabilmesi için yapılandırılması gerekir.
COMPLETED Alıcının garantili siparişi yapılandırdıktan sonraki durum.

Yöntemler

create

 Yeni bir garantili sipariş oluşturur.

editGuaranteedOrderReadAccessors

 Garantili bir siparişin okunabilir reklamverenlerini düzenler.

get

 Garantili sipariş verir.

list

 Geçerli kullanıcının erişebildiği garantili siparişleri listeler.

patch

 Mevcut bir garantili siparişi günceller.