REST Resource: inventorySources

Resource: InventorySource

Sumber inventaris.

Representasi JSON 
{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "inventorySourceProductType": enum (InventorySourceProductType),
  "commitment": enum (InventorySourceCommitment),
  "deliveryMethod": enum (InventorySourceDeliveryMethod),
  "dealId": string,
  "status": {
    object (InventorySourceStatus)
  },
  "exchange": enum (Exchange),
  "updateTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "publisherName": string,
  "timeRange": {
    object (TimeRange)
  },
  "creativeConfigs": [
    {
      object (CreativeConfig)
    }
  ],
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
Kolom
name

string

Hanya output. Nama resource sumber inventaris.
inventorySourceId

string (int64 format)

Hanya output. ID unik sumber inventaris. Ditugaskan oleh sistem.
displayName

string

Nama tampilan sumber inventaris.

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

enum (InventorySourceType)

Menunjukkan jenis sumber inventaris.
inventorySourceProductType

enum (InventorySourceProductType)

Hanya output. Jenis produk sumber inventaris, yang menunjukkan cara penjualan inventaris.
commitment

enum (InventorySourceCommitment)

Apakah sumber inventaris memiliki penayangan yang dijamin atau tidak dijamin.
deliveryMethod

enum (InventorySourceDeliveryMethod)

Metode penayangan sumber inventaris.

  • Untuk sumber inventaris tanpa jaminan, satu-satunya nilai yang dapat diterima adalah INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • Untuk sumber inventaris yang dijamin, nilai yang dapat diterima adalah INVENTORY_SOURCE_DELIVERY_METHOD_TAG dan INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

ID di ruang bursa yang secara unik mengidentifikasi sumber inventaris.

Harus unik di seluruh pembeli dalam setiap bursa, tetapi tidak harus unik di seluruh bursa.
status

object (InventorySourceStatus)

Setelan status sumber inventaris.
exchange

enum (Exchange)

Bursa tempat sumber inventaris berada.
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat sumber inventaris terakhir diperbarui. Ditetapkan oleh sistem.

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

object (RateDetails)

Wajib. Detail tarif sumber inventaris.
publisherName

string

Nama penerbit/penjual sumber inventaris.
timeRange

object (TimeRange)

Rentang waktu saat sumber inventaris ini mulai dan berhenti ditayangkan.
creativeConfigs[]

object (CreativeConfig)

Persyaratan materi iklan sumber inventaris.

Tidak berlaku untuk paket lelang.
guaranteedOrderId

string

Tidak dapat diubah. ID pesanan terjamin yang menjadi sumber inventaris ini.

Hanya berlaku jika commitment adalah INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

Partner atau pengiklan yang memiliki akses baca/tulis ke sumber inventaris.

Output hanya jika commitment adalah INVENTORY_SOURCE_COMMITMENT_GUARANTEED, dalam hal ini pengakses baca/tulis diwarisi dari urutan yang dijamin induk.

Wajib jika commitment adalah INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Jika commitment adalah INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED dan partner ditetapkan di kolom ini, semua pengiklan dalam partner ini akan otomatis memiliki akses hanya baca ke sumber inventaris. Pengiklan ini tidak akan disertakan dalam readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Hanya output. ID pengiklan dengan akses hanya baca ke sumber inventaris.
readPartnerIds[]

string (int64 format)

Hanya output. ID partner dengan akses baca saja ke sumber inventaris.

Semua pengiklan partner di kolom ini mewarisi akses hanya baca ke sumber inventaris.

InventorySourceType

Kemungkinan jenis sumber inventaris.

Enum
INVENTORY_SOURCE_TYPE_UNSPECIFIED Jenis sumber inventaris tidak ditentukan atau tidak diketahui dalam versi ini.
INVENTORY_SOURCE_TYPE_PRIVATE Sumber inventaris pribadi.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Paket lelang.

InventorySourceProductType

Kemungkinan jenis produk dari sumber inventaris.

Enum
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED Jenis produk tidak ditentukan atau tidak diketahui dalam versi ini. Mengubah sumber inventaris jenis produk ini tidak didukung melalui API.
PREFERRED_DEAL Sumber inventaris menjual inventaris melalui Transaksi Pilihan.
PRIVATE_AUCTION Sumber inventaris menjual inventaris melalui Lelang Pribadi.
PROGRAMMATIC_GUARANTEED Sumber inventaris menjual inventaris melalui Dijamin Terprogram.
TAG_GUARANTEED Sumber inventaris menjual inventaris melalui Dijamin Tag.
YOUTUBE_RESERVE Sumber inventaris menjual inventaris melalui YouTube Reserve.
INSTANT_RESERVE Sumber inventaris menjual inventaris melalui Reservasi Instan. Mengubah sumber inventaris jenis produk ini tidak didukung melalui API.
GUARANTEED_PACKAGE Sumber inventaris menjual inventaris melalui Paket Dijamin. Mengubah sumber inventaris jenis produk ini tidak didukung melalui API.
PROGRAMMATIC_TV Sumber inventaris menjual inventaris melalui TV Terprogram. Mengubah sumber inventaris jenis produk ini tidak didukung melalui API.
AUCTION_PACKAGE Sumber inventaris menjual inventaris melalui Paket Lelang. Mengubah sumber inventaris jenis produk ini tidak didukung melalui API.

InventorySourceCommitment

Kemungkinan jenis komitmen untuk sumber inventaris.

Enum
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED Komitmen tidak ditentukan atau tidak diketahui dalam versi ini.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED Komitmen ini adalah penayangan terjamin.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Komitmen ini adalah penayangan tanpa jaminan.

InventorySourceDeliveryMethod

Kemungkinan metode penayangan untuk sumber inventaris.

Enum
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED Metode pengiriman tidak ditentukan atau tidak diketahui dalam versi ini.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC Metode pengirimannya bersifat terprogram.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG Metode pengirimannya adalah tag.

InventorySourceStatus

Setelan terkait status sumber inventaris.

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

enum (EntityStatus)

Apakah sumber inventaris 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 sumber inventaris ini.

Tidak boleh lebih dari 100 karakter.

Hanya berlaku jika entityStatus ditetapkan ke ENTITY_STATUS_PAUSED.
sellerStatus

enum (EntityStatus)

Hanya output. Status yang ditetapkan oleh penjual untuk sumber inventaris.

Hanya berlaku untuk sumber inventaris yang disinkronkan langsung dari penayang. Nilai yang dapat diterima adalah ENTITY_STATUS_ACTIVE dan ENTITY_STATUS_PAUSED.
sellerPauseReason

string

Hanya output. Alasan yang diberikan penjual untuk menjeda sumber inventaris ini.

Hanya berlaku untuk sumber inventaris yang disinkronkan langsung dari penayang dan saat sellerStatus disetel ke ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

Hanya output. Status konfigurasi sumber inventaris.

Hanya berlaku untuk sumber inventaris dijamin. Nilai yang dapat diterima adalah INVENTORY_SOURCE_CONFIG_STATUS_PENDING dan INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Sumber inventaris harus dikonfigurasi (mengisi kolom wajib diisi, memilih materi iklan, dan memilih kampanye default) sebelum dapat ditayangkan.

InventorySourceConfigStatus

Kemungkinan status konfigurasi untuk sumber inventaris yang dijamin.

Enum
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED Status persetujuan tidak ditentukan atau tidak diketahui dalam versi ini.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING Status awal sumber inventaris yang dijamin. Sumber inventaris dalam status ini perlu dikonfigurasi.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Status setelah pembeli mengonfigurasi sumber inventaris terjamin.

RateDetails

Setelan terkait tarif dari sumber inventaris.

Representasi JSON 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
Kolom
inventorySourceRateType

enum (InventorySourceRateType)

Jenis tarif.

Nilai yang dapat diterima adalah INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR, dan INVENTORY_SOURCE_RATE_TYPE_CPD.
rate

object (Money)

Tarif untuk sumber inventaris.
unitsPurchased

string (int64 format)

Wajib untuk sumber inventaris yang dijamin. Jumlah tayangan yang dijamin oleh penjual.
minimumSpend

object (Money)

Hanya output. Jumlah yang telah dikomitmenkan pembeli untuk dibelanjakan di sumber inventaris di awal.

Hanya berlaku untuk sumber inventaris dijamin.

InventorySourceRateType

Kemungkinan jenis tarif untuk sumber inventaris.

Enum
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Jenis tarif tidak ditentukan atau tidak diketahui dalam versi ini.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Jenis tarifnya adalah CPM (Tetap).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Jenis tarifnya adalah CPM (Lantai).
INVENTORY_SOURCE_RATE_TYPE_CPD Jenis tarifnya adalah Biaya per Hari.
INVENTORY_SOURCE_RATE_TYPE_FLAT Jenis tarifnya adalah Flat.

Uang

Mewakili jumlah uang dengan jenis mata uangnya.

Representasi JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Kolom
currencyCode

string

Kode mata uang tiga huruf yang ditentukan dalam ISO 4217.
units

string (int64 format)

Seluruh unit jumlahnya. Misalnya jika currencyCode adalah "USD", maka 1 unit adalah satu dolar AS.
nanos

integer

Jumlah unit nano (10^-9) dari jumlah. Nilainya harus antara -999.999.999 dan +999.999.999 inklusif. Jika units positif, nanos harus positif atau nol. Jika units nol, nanos dapat positif, nol, atau negatif. Jika units negatif, nanos harus negatif atau nol. Misalnya $-1,75 direpresentasikan sebagai units=-1 dan nanos=-750.000.000.

TimeRange

Rentang waktu.

Representasi JSON 
{
  "startTime": string,
  "endTime": string
}
Kolom
startTime

string (Timestamp format)

Wajib. Batas bawah rentang waktu, inklusif.

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

string (Timestamp format)

Wajib. Batas atas rentang waktu, inklusif.

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

CreativeConfig

Konfigurasi persyaratan materi iklan untuk sumber inventaris.

Representasi JSON 
{
  "creativeType": enum (CreativeType),

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}
Kolom
creativeType

enum (CreativeType)

Jenis materi iklan yang dapat ditetapkan ke sumber inventaris. Hanya jenis berikut yang didukung:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Kolom union creative_config_scheme. Berlaku jika creative_type adalah salah satu dari:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Konfigurasi untuk materi iklan yang dapat ditetapkan ke sumber inventaris. creative_config_scheme hanya dapat berupa salah satu dari hal berikut:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

Konfigurasi untuk materi iklan Display. Berlaku saat creativeType adalah CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

Konfigurasi untuk materi iklan video. Berlaku saat creativeType adalah CREATIVE_TYPE_VIDEO.

InventorySourceDisplayCreativeConfig

Konfigurasi untuk materi iklan Display.

Representasi JSON 
{
  "creativeSize": {
    object (Dimensions)
  }
}
Kolom
creativeSize

object (Dimensions)

Persyaratan ukuran untuk materi iklan Display yang dapat ditetapkan ke sumber inventaris.

InventorySourceVideoCreativeConfig

Konfigurasi untuk materi iklan video.

Representasi JSON 
{
  "duration": string
}
Kolom
duration

string (Duration format)

Persyaratan durasi untuk materi iklan video yang dapat ditetapkan ke sumber inventaris.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

InventorySourceAccessors

Partner atau pengiklan yang memiliki akses ke sumber inventaris.

Representasi JSON 
{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}
Kolom
Kolom union accessors. Partner atau pengiklan yang memiliki akses ke sumber inventaris. accessors hanya dapat berupa salah satu dari berikut:
partner

object (PartnerAccessor)

Partner yang memiliki akses ke sumber inventaris.
advertisers

object (AdvertiserAccessors)

Pengiklan yang memiliki akses ke sumber inventaris. Semua pengiklan harus dimiliki oleh partner yang sama.

PartnerAccessor

Partner dengan akses ke sumber inventaris.

Representasi JSON 
{
  "partnerId": string
}
Kolom
partnerId

string (int64 format)

ID partner.

AdvertiserAccessors

Pengiklan yang memiliki akses ke sumber inventaris.

Representasi JSON 
{
  "advertiserIds": [
    string
  ]
}
Kolom
advertiserIds[]

string (int64 format)

ID pengiklan.

Metode

create

 Membuat sumber inventaris baru.

editInventorySourceReadWriteAccessors

 Mengedit pengakses baca/tulis sumber inventaris.

get

 Mendapatkan sumber inventaris.

list

 Mencantumkan sumber inventaris yang dapat diakses oleh pengguna saat ini.

patch

 Memperbarui sumber inventaris yang ada.