REST Resource: guaranteedOrders

Resource: GuaranteedOrder

Pesanan yang dijamin.

Pesanan yang dijamin adalah entitas induk dari sumber inventaris yang dijamin. Saat membuat sumber inventaris terjamin, ID pesanan terjamin 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,

  // 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 yang dijamin. 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 terjamin. ID pesanan terjamin 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. Ditugaskan oleh sistem.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. 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 terjamin. Hanya berlaku jika readWritePartnerId disetel. Jika Benar, akan 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 pesanan terjamin.

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 hal berikut:
readWritePartnerId

string (int64 format)

Partner dengan akses baca/tulis ke pesanan terjamin.
readWriteAdvertiserId

string (int64 format)

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

GuaranteedOrderStatus

Setelan status pesanan terjamin.

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 terjamin 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 terjamin harus dikonfigurasi (isi kolom yang diperlukan, 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 yang dijamin. Pesanan terjamin dalam status ini perlu dikonfigurasi sebelum dapat ditayangkan.
COMPLETED Status setelah pembeli mengonfigurasi pesanan terjamin.

Metode

create

 Membuat pesanan terjamin baru.

editGuaranteedOrderReadAccessors

 Mengedit pengiklan yang membaca pesanan yang dijamin.

get

 Mendapatkan pesanan yang dijamin.

list

 Mencantumkan pesanan terjamin yang dapat diakses oleh pengguna saat ini.

patch

 Memperbarui pesanan terjamin yang ada.