REST Resource: guaranteedOrders

Kaynak: GuaranteedOrder

Garantili sipariş.

Garantili siparişler, garantili envanter kaynaklarının ana varlığıdır. Garantili bir 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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
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 olması garanti edilmez. Bu kimlik, SDF ve kullanıcı arayüzünde kullanılır.
exchange

enum (Exchange)

Zorunlu. Değiştirilemez. 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ı.

UTF-8 olarak kodlanmış ve maksimum 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.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
publisherName

string

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

UTF-8 olarak kodlanmış ve maksimum 240 bayt boyutunda olmalıdır.
readAccessInherited

boolean

readWritePartnerId için tüm reklamverenlerin garantili siparişe okuma erişimi olup olmadığı. Yalnızca readWritePartnerId ayarlandıysa geçerlidir. Doğru ise 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 için atanan reklamvereni içermemelidir. Bu alandaki tüm reklamverenler readWritePartnerId 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 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.

Zorunlu.

Garantili siparişe okuma/yazma erişimi olan iş ortağı veya reklamveren. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta alanlardan en fazla biri ayarlanır:
readWritePartnerId

string (int64 format)

Garantili siparişe 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.
Birbirini hariç tutan alanların sonu.

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. Varsayılan değer: ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Kullanıcı tarafından bu garantili siparişin duraklatılması için belirtilen neden.

UTF-8 olarak kodlanmış ve maksimum 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 edilen değerler PENDING ve COMPLETED'dir.

Garantili siparişin yayınlanabilmesi için yapılandırılması (gerekli alanların doldurulması, reklam öğelerinin seçilmesi ve varsayılan bir kampanyanın belirlenmesi) gerekir. Şu anda yapılandırma işlemi 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 belirtilmemiş veya bu sürümde 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ı garantili bir sipariş yapılandırdıktan sonraki durum.

Yöntemler

create

 Yeni bir garantili sipariş oluşturur.

editGuaranteedOrderReadAccessors

 Düzenlemeler, garantili bir siparişin reklamverenlerini okur.

get

 Garantili sipariş alır.

list

 Mevcut kullanıcının erişebileceği garantili siparişleri listeler.

patch

 Mevcut bir garantili siparişi günceller.