REST Resource: guaranteedOrders

Resource: GuaranteedOrder

Pesanan yang dijamin.

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

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,

  // 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.
}
Kolom
name

string

Hanya output. Nama resource pesanan 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 yang dijamin. ID ini digunakan di SDF dan UI.
exchange

enum (Exchange)

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

string

Hanya output. ID unik pesanan 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 yang dijamin.
updateTime

string (Timestamp format)

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

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
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 dijamin. Hanya berlaku jika readWritePartnerId ditetapkan. Jika True, akan menggantikan readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

ID pengiklan dengan akses baca ke pesanan dijamin.

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

string (int64 format)

Hanya output. ID pengiklan default pesanan yang 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 dijamin.

Kampanye default harus dimiliki oleh pengiklan default.

Wajib.

Partner atau pengiklan dengan akses baca/tulis ke pesanan dijamin. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
readWritePartnerId

string (int64 format)

Partner dengan akses baca/tulis ke pesanan dijamin.
readWriteAdvertiserId

string (int64 format)

Pengiklan dengan akses baca/tulis ke pesanan yang dijamin. Pengiklan ini juga merupakan pengiklan default pesanan dijamin.
Akhir kolom yang saling eksklusif.

GuaranteedOrderStatus

Setelan status pesanan yang dijamin.

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

enum (EntityStatus)

Menunjukkan apakah pesanan 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 dijamin harus dikonfigurasi (isi kolom wajib diisi, pilih materi iklan, dan pilih 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 dijamin. Pesanan dijamin dalam status ini perlu dikonfigurasi sebelum dapat ditayangkan.
COMPLETED Status setelah pembeli mengonfigurasi pesanan yang dijamin.

Metode

create

 Membuat pesanan dijamin baru.

editGuaranteedOrderReadAccessors

 Pengeditan akan memberi tahu pengiklan tentang pesanan dijamin.

get

 Mendapatkan pesanan yang dijamin.

list

 Mencantumkan pesanan yang dijamin yang dapat diakses oleh pengguna saat ini.

patch

 Memperbarui pesanan dijamin yang ada.