REST Resource: guaranteedOrders

Resource: GuaranteedOrder

Pesanan yang dijamin.

Pesanan yang dijamin adalah entitas induk dari sumber inventaris yang dijamin. Saat membuat sumber inventaris dijamin, ID pesanan dijamin harus ditetapkan ke sumber inventaris tersebut.

Representasi JSON 
{
  "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.
}
Kolom
name

string

Hanya output. Nama resource pesanan yang dijamin.
legacyGuaranteedOrderId

string

Hanya output. ID lama pesanan yang dijamin. Ditetapkan oleh bursa asli. ID lama bersifat unik dalam satu bursa, tetapi tidak dijamin unik di semua pesanan terjamin. ID ini digunakan di SDF dan UI.
exchange

enum (Exchange)

Wajib. Tidak dapat diubah. Bursa tempat pesanan yang dijamin berasal.
guaranteedOrderId

string

Hanya output. ID unik pesanan yang dijamin. ID pesanan yang dijamin memiliki format {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Wajib. Nama tampilan pesanan yang dijamin.

Harus berenkode UTF-8 dengan ukuran maksimum 240 byte.
status

object (GuaranteedOrderStatus)

Setelan status pesanan terjamin.
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat pesanan yang dijamin terakhir diperbarui. Ditetapkan oleh sistem.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
publisherName

string

Wajib. Nama penayang pesanan yang dijamin.

Harus berenkode UTF-8 dengan ukuran maksimum 240 byte.
readAccessInherited

boolean

Apakah semua pengiklan readWritePartnerId memiliki akses baca ke pesanan yang dijamin. Hanya berlaku jika readWritePartnerId ditetapkan. Jika Benar, mengganti readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

ID pengiklan dengan akses baca ke pesanan yang dijamin.

Kolom ini tidak boleh menyertakan pengiklan yang ditetapkan ke readWriteAdvertiserId jika ditetapkan. Semua pengiklan di kolom ini harus milik readWritePartnerId atau partner yang sama dengan readWriteAdvertiserId.
defaultAdvertiserId

string (int64 format)

Hanya output. ID pengiklan default untuk pesanan dijamin.

Pengiklan default adalah readWriteAdvertiserId atau, jika tidak ditetapkan, pengiklan pertama yang tercantum di readAdvertiserIds. Jika tidak, tidak ada pengiklan default.
defaultCampaignId

string (int64 format)

ID kampanye default yang ditetapkan ke pesanan terjamin.

Kampanye default harus milik pengiklan default.

Kolom union read_write_accessor. Wajib.

Partner atau pengiklan dengan akses baca/tulis ke pesanan terjamin. read_write_accessor hanya dapat berupa salah satu dari yang berikut:
readWritePartnerId

string (int64 format)

Partner dengan akses baca/tulis ke pesanan yang dijamin.
readWriteAdvertiserId

string (int64 format)

Pengiklan dengan akses baca/tulis ke pesanan dijamin. Ini juga merupakan pengiklan default dari pesanan dijamin.

GuaranteedOrderStatus

Setelan status pesanan yang dijamin.

Representasi JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Kolom
entityStatus

enum (EntityStatus)

Apakah pesanan yang dijamin dapat ditayangkan atau tidak.

Nilai yang dapat diterima adalah ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, dan ENTITY_STATUS_PAUSED. Nilai defaultnya adalah ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Alasan yang diberikan pengguna untuk menjeda pesanan dijamin ini.

Harus berenkode UTF-8 dengan panjang maksimum 100 byte.

Hanya berlaku jika entityStatus ditetapkan ke ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

Hanya output. Status konfigurasi pesanan yang dijamin.

Nilai yang dapat diterima adalah PENDING dan COMPLETED.

Pesanan yang dijamin harus dikonfigurasi (mengisi kolom wajib diisi, memilih materi iklan, dan memilih kampanye default) sebelum dapat ditayangkan. Saat ini, tindakan konfigurasi hanya dapat dilakukan melalui UI.

GuaranteedOrderConfigStatus

Kemungkinan status konfigurasi untuk pesanan yang dijamin.

Enum
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Status persetujuan tidak ditentukan atau tidak diketahui dalam versi ini.
PENDING Status awal pesanan yang dijamin. Pesanan terjamin dalam status ini perlu dikonfigurasi sebelum dapat ditayangkan.
COMPLETED Status setelah pembeli mengonfigurasi pesanan terjamin.

Metode

create

 Membuat pesanan baru yang dijamin.

editGuaranteedOrderReadAccessors

 Hasil edit membacakan pesanan yang dijamin oleh pengiklan.

get

 Mendapatkan pesanan yang dijamin.

list

 Mencantumkan pesanan terjamin yang dapat diakses oleh pengguna saat ini.

patch

 Memperbarui pesanan dijamin yang ada.