REST Resource: guaranteedOrders

Kaynak: GuaranteedOrder

Garantili sipariş.

Garantili siparişler, garantili envanter kaynaklarının ana 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,

  // 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, tek 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 kaynağı olan borsa.
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 bayt boyutunda UTF-8 kodlu 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ı.

Maksimum 240 bayt boyutunda UTF-8 kodlu olmalıdır.
readAccessInherited

boolean

readWritePartnerId reklamverenlerinin tümü, garantili siparişe okuma erişimine sahip mi? Yalnızca readWritePartnerId ayarlanmışsa geçerlidir. Doğruysa 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 öğesine atanmış 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, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan 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, garantili siparişin varsayılan reklamverenidir.
Birbirini dışlayan 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'dir. Varsayılan değer ENTITY_STATUS_ACTIVE'dır.
entityPauseReason

string

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

Maksimum uzunluğu 100 bayt olan UTF-8 kodlu 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.

Yayınlanabilmesi için garantili siparişin yapılandırılması (gerekli alanların doldurulması, reklam öğelerinin seçilmesi ve varsayılan bir kampanyanın belirlenmesi) 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 bir 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

 Garantili bir siparişin reklamverenlerini okur.

get

 Garantili sipariş alır.

list

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

patch

 Mevcut bir garantili siparişi günceller.