REST Resource: exchanges.orders.products

Resource: Produk

Produk

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "program": string,
  "buyerCustomParameters": {
    string: string,
    ...
  },
  "etag": string
}
Kolom
name

string

Nama resource relatif untuk produk. Dibuat oleh server. Contoh: "exchanges/1234/orders/5678/products/abc". Hanya output.
displayName

string

Nama tampilan produk.

Harus berenkode UTF-8 dengan ukuran maksimum 240 byte. Wajib.
externalDealId

string

ID Eksternal. Ini adalah ID transaksi di sistem bursa. Maksimal 100 karakter. Karakter yang diizinkan adalah alfanumerik, garis bawah, tanda hubung, dan titik. Harus unik di semua produk. Wajib.
transactionType

enum (TransactionType)

Jenis transaksi produk. Wajib.
pricingType

enum (PricingType)

Jenis harga untuk produk. Wajib.
updateTime
(deprecated)

string (Timestamp format)

Stempel waktu saat produk terakhir diperbarui.

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".
startTime

string (Timestamp format)

Waktu saat produk ini menjadi aktif. Harus lebih awal dari endTime. Waktu mulai tidak boleh lebih dari 1 tahun ke depan. Wajib.

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".
endTime

string (Timestamp format)

Waktu saat produk ini menjadi tidak aktif. Tidak boleh lebih dari tahun 2036. Wajib.

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".
rateDetails

object (RateDetails)

Detail tarif. Wajib.
creativeConfig[]

object (CreativeConfig)

Persyaratan materi iklan untuk produk. Wajib ada untuk produk jenis transaksi yang direservasi.
makegood
(deprecated)

boolean

Menunjukkan apakah produk merupakan produk kompensasi.
makegoodDetails
(deprecated)

object (MakegoodDetails)

Detail kompensasi untuk produk. Wajib jika produk berupa kompensasi.
creativeSource

enum (CreativeSource)

Sumber materi iklan untuk produk. Opsional, defaultnya adalah CREATIVE_SOURCE_ADVERTISER. Tidak dapat diubah setelah pembuatan produk.
mediumType

enum (MediumType)

Jenis media untuk produk. Jika tidak ditentukan, setelan defaultnya adalah DIGITAL untuk kompatibilitas mundur. Tidak dapat diubah setelah pembuatan produk.
audienceTargetingConfig

object (AudienceTargetingConfig)

Opsional. Konfigurasi penargetan audiens diterapkan di tingkat transaksi di bursa.
targetingCriteria

object (TargetingCriteria)

Hanya output. Referensi kriteria penargetan produk. Hanya berlaku untuk Skenario Transaksi Instan.
forecastResult

object (ForecastResult)

Hasil perkiraan produk. Wajib diisi jika kriteria penargetan tidak kosong dan perkiraan tidak diberikan. Hanya berlaku untuk Skenario Transaksi Instan.
errorDetails

object (ErrorDetails)

Detail error harus ditentukan jika kolom produk tertentu tidak dapat diperbarui. Wajib diisi jika hasil perkiraan tidak dapat diberikan karena kriteria penargetan atau pembaruan tidak dapat dilakukan pada produk. Hanya berlaku untuk Skenario Transaksi Instan.
frequencyCap

object (FrequencyCap)

Hanya output. Batas frekuensi yang dipilih oleh pembeli. Hanya berlaku untuk Skenario Transaksi Instan.
program

string

Hanya output. Program yang digunakan pembeli untuk membuat transaksi instan. Kosong untuk alur reguler pertukaran. Hanya berlaku untuk Skenario Transaksi Instan.
buyerCustomParameters

map (key: string, value: string)

Hanya output. Parameter kunci/nilai kustom yang ditetapkan oleh pembeli pada permintaan transaksi instan. Hanya berlaku untuk Skenario Transaksi Instan.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
etag

string

Etag yang perlu ditentukan saat memperbarui produk. Kolom ini hanya perlu ditentukan untuk update jika kolom etag tidak kosong. Hanya berlaku untuk Skenario Transaksi Instan.

CreativeConfig

Konfigurasi persyaratan materi iklan untuk produk.

Representasi JSON 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
Kolom
creativeType

enum (CreativeType)

Jenis materi iklan. Wajib.
dimensionCreativeConfig

object (DimensionCreativeConfig)

Konfigurasi untuk materi iklan Display. Kolom ini tidak didukung untuk materi iklan Native (CREATIVE_TYPE_NATIVE).
durationCreativeConfig

object (DurationCreativeConfig)

Konfigurasi untuk materi iklan video.

CreativeType

Kemungkinan jenis materi iklan.

Enum
CREATIVE_TYPE_UNSPECIFIED Jenis materi iklan tidak ditentukan. Nilai input tidak valid.
CREATIVE_TYPE_DISPLAY Jenis materi iklan display.
CREATIVE_TYPE_VIDEO Jenis materi iklan video.
CREATIVE_TYPE_AUDIO Jenis materi iklan audio.
CREATIVE_TYPE_NATIVE Jenis materi iklan native. Hal ini tidak didukung untuk produk jenis transaksi RESERVED.

DimensionCreativeConfig

Dimensi materi iklan Display dalam piksel.

Representasi JSON 
{
  "width": integer,
  "height": integer
}
Kolom
width

integer

Menampilkan lebar materi iklan. Wajib.
height

integer

Tinggi materi iklan Display. Wajib.

DurationCreativeConfig

Konfigurasi untuk materi iklan dalam durasi.

Representasi JSON 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
Kolom
duration

string (Duration format)

Durasi materi iklan video dalam detik. Wajib

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

enum (DurationMatchType)

Kriteria pencocokan durasi.
skippableMatchType

enum (SkippableMatchType)

Jenis materi iklan video yang dapat dilewati.

DurationMatchType

Kriteria pencocokan untuk durasi materi iklan video.

Enum
DURATION_MATCH_TYPE_UNSPECIFIED Kriteria pencocokan durasi tidak ditentukan atau tidak diketahui dalam versi ini. Nilai input tidak valid.
DURATION_MATCH_TYPE_EQUAL_TO Durasi materi iklan harus sama dengan durasi yang diperlukan.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO Durasi materi iklan harus sama dengan atau kurang dari durasi yang diperlukan.

SkippableMatchType

Kriteria pencocokan untuk menentukan apakah materi iklan video dapat dilewati.

Enum
SKIPPABLE_MATCH_TYPE_UNSPECIFIED Jenis yang dapat dilewati tidak ditentukan atau tidak diketahui dalam versi ini. Nilai input tidak valid.
SKIPPABLE_MATCH_TYPE_SKIPPABLE Materi iklan harus dapat dilewati.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE Materi iklan harus tidak dapat dilewati.
SKIPPABLE_MATCH_TYPE_ANY Materi iklan dapat dilewati atau tidak dapat dilewati.

MakegoodDetails

Konfigurasi untuk detail kompensasi.

Representasi JSON 
{
  "originalExternalDealId": string,
  "reason": string
}
Kolom
originalExternalDealId

string

ID transaksi eksternal asli yang meminta kompensasi. Maksimal 100 karakter. Karakter yang diizinkan adalah alfanumerik, garis bawah, tanda hubung, dan titik. Wajib.
reason

string

Alasan Kompensasi yang dimulai oleh penjual. Maksimal 250 karakter. Wajib.

CreativeSource

Sumber materi iklan; tempat materi iklan akan ditayangkan.

Enum
CREATIVE_SOURCE_UNSPECIFIED Sumber materi iklan tidak ditentukan atau tidak diketahui dalam versi ini. Nilai input tidak valid.
CREATIVE_SOURCE_ADVERTISER Materi iklan akan ditayangkan oleh DV3.
CREATIVE_SOURCE_PUBLISHER Materi iklan akan ditayangkan oleh penayang. Materi iklan yang dihosting penayang saat ini tidak didukung; permintaan apa pun yang mencoba menetapkan sumber materi iklan ke CREATIVE_SOURCE_PUBLISHER akan gagal.

AudienceTargetingConfig

Konfigurasi untuk penargetan audiens.

Representasi JSON 
{
  "audienceType": enum (AudienceType)
}
Kolom
audienceType

enum (AudienceType)

Jenis audiens. Wajib.

AudienceType

Jenis audiens.

Enum
AUDIENCE_TYPE_UNSPECIFIED Jenis audiens tidak ditentukan. Tidak valid untuk input.
AUDIENCE_TYPE_COMMERCE Jenis audiens Commerce.

TargetingCriteria

Kriteria penargetan yang ditentukan.

Representasi JSON 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
Kolom
selectedTargetingOptions[]

object (SelectedTargetingOption)

Opsi yang dipilih.

SelectedTargetingOption

Satu atau beberapa opsi penargetan yang dipilih untuk satu jenis penargetan.

Representasi JSON 
{
  "type": enum (TargetingType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of mutually exclusive fields.
}
Kolom
type

enum (TargetingType)

Jenis penargetan yang terkait dengan opsi yang dipilih.
Hanya satu jenis pilihan yang dapat disertakan. Pilihan yang dipilih harus sesuai dengan TargetingType yang dipilih untuk kolom type. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
audienceSelection

object (AudienceSelection)

Audiens yang dipilih.
targetingSelection

object (TargetingSelection)

Kumpulan umum ID opsi yang dipilih.
Akhir kolom yang saling eksklusif.

TargetingType

Jenis penargetan.

Enum
TARGETING_TYPE_UNSPECIFIED Jenis penargetan tidak ditentukan, tidak valid untuk input.
TARGETING_TYPE_AUDIENCE Audiens jenis penargetan.
TARGETING_TYPE_COUNTRY Negara jenis penargetan.
TARGETING_TYPE_DMA Jenis penargetan dma.
TARGETING_TYPE_PROGRAMMER Pemrogram jenis penargetan.
TARGETING_TYPE_BRAND Merek jenis penargetan.
TARGETING_TYPE_CONTENT_GENRE Genre konten jenis penargetan.
TARGETING_TYPE_DEVICE Perangkat jenis penargetan.
TARGETING_TYPE_OPERATING_SYSTEM Sistem operasi jenis penargetan.
TARGETING_TYPE_RATING Rating jenis penargetan.
TARGETING_TYPE_ENVIRONMENT Lingkungan jenis penargetan.
TARGETING_TYPE_LANGUAGE Bahasa jenis penargetan.
TARGETING_TYPE_GEO Geografi jenis penargetan.
TARGETING_TYPE_AGE Usia jenis penargetan.
TARGETING_TYPE_GENDER Jenis penargetan gender.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Segmen kontekstual jenis penargetan.
TARGETING_TYPE_REQUEST_FORMAT Format permintaan jenis penargetan.
TARGETING_TYPE_PUBLISHER Penayang jenis penargetan.
TARGETING_TYPE_INVENTORY_SIZE Ukuran jenis penargetan.
TARGETING_TYPE_NETWORK Jaringan jenis penargetan.
TARGETING_TYPE_PLATFORM Platform jenis penargetan.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Jenis penargetan jenis penayangan video.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Jenis penargetan ukuran pemutar minimum video.
TARGETING_TYPE_VIDEO_COMPLETION Penempatan video jenis penargetan.
TARGETING_TYPE_VIEWABILITY Visibilitas jenis penargetan.
TARGETING_TYPE_REWARDED Jenis penargetan reward.
TARGETING_TYPE_VIDEO_AD_DURATION_THRESHOLD_SEC Targeting type video ad duration threshold sec.
TARGETING_TYPE_VIDEO_PLACEMENT Penempatan video jenis penargetan.
TARGETING_TYPE_VIDEO_PLAYBACK_METHOD Metode pemutaran video jenis penargetan.
TARGETING_TYPE_APP_ID ID aplikasi jenis penargetan.
TARGETING_TYPE_DOMAIN_URL URL domain jenis penargetan.
TARGETING_TYPE_CTR Rasio klik-tayang jenis penargetan.
TARGETING_TYPE_DEMOGRAPHICS Demografi jenis penargetan.
TARGETING_TYPE_RESTRICTED_CATEGORY Kategori yang dibatasi jenis penargetan.
TARGETING_TYPE_AD_POSITION Posisi iklan jenis penargetan.
TARGETING_TYPE_DAY_AND_TIME Jenis penargetan hari dan waktu.
TARGETING_TYPE_RETAIL_MEDIA_AUDIENCE Jenis penargetan audiens media retail.

AudienceSelection

Opsi penargetan audiens yang dipilih.

Representasi JSON 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
Kolom
includedOrGroups[]

object (OrGroup)

Opsi yang disertakan digabungkan dengan AND, setiap opsi yang disertakan dapat berupa opsi individual, atau grup opsi yang digabungkan dengan OR.
excludedOptionIds[]

string (int64 format)

Opsi yang dikecualikan digabungkan dengan OR.

OrGroup

Sekelompok opsi yang dipilih yang digabungkan dengan OR.

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

string (int64 format)

ID opsi yang dipilih.

TargetingSelection

Opsi penargetan yang dipilih dan dikecualikan, berlaku untuk sebagian besar jenis penargetan.

Representasi JSON 
{
  "optionIds": [
    string
  ],
  "externalIds": [
    string
  ],
  "excludedOptionIds": [
    string
  ],
  "excludedExternalIds": [
    string
  ]
}
Kolom
optionIds[]

string (int64 format)

Hanya output. ID opsi penargetan DV3 yang dipilih yang dibagikan ke bursa. Dapat ditampilkan bersama excludedOptionIds asalkan kedua daftar tidak tumpang-tindih.
externalIds[]

string

Hanya output. ID opsi penargetan yang dipilih yang disediakan oleh bursa. Dapat ditampilkan bersama excludedExternalIds asalkan kedua daftar tidak tumpang-tindih.
excludedOptionIds[]

string (int64 format)

Hanya output. ID opsi penargetan DV3 yang dikecualikan yang dibagikan ke bursa. Dapat ditampilkan bersama optionIds asalkan kedua daftar tidak tumpang-tindih.
excludedExternalIds[]

string

Hanya output. ID opsi penargetan yang dikecualikan yang disediakan oleh bursa. Dapat ditampilkan bersama externalIds asalkan kedua daftar tidak tumpang-tindih.

ForecastResult

Hasil perkiraan ditentukan.

Representasi JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Kolom
forecasts[]

object (Forecast)

Perkiraan. forecastCategory harus unik untuk setiap elemen yang ditentukan.

Perkiraan

Perkiraan kategori perkiraan yang ditentukan.

Representasi JSON 
{
  "forecastCategory": enum (ForecastCategory),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of mutually exclusive fields.
}
Kolom
forecastCategory

enum (ForecastCategory)

Kategori perkiraan yang ditentukan yang diwakili oleh statistik perkiraan.
Hanya satu jenis data statistik yang dapat disertakan. Data yang diisi harus sesuai dengan kolom forecastCategory. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
number

string (int64 format)

Data angka.
percentage

integer

Data persentase.
cpmPrice

object (Money)

Data harga CPM.
cpmRange

object (CpmRange)

Data rentang harga CPM.
forecastBreakdownData

object (ForecastBreakdownData)

Data perincian perkiraan.
Akhir kolom yang saling eksklusif.

ForecastCategory

Kategori perkiraan.

Enum
FORECAST_CATEGORY_UNSPECIFIED Kategori tidak ditentukan. Tidak valid untuk input.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES Total peluang. Data angka.
FORECAST_CATEGORY_TOTAL_AUDIENCE Total audiens. Data angka.
FORECAST_CATEGORY_DIGITAL_TRP Target poin rating digital. Data persentase.
FORECAST_CATEGORY_SUGGESTED_CPM Harga CPM yang disarankan. Data rentang CPM atau harga CPM.
FORECAST_CATEGORY_UNIQUE_REACH Memperkirakan jangkauan unik. Data angka.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Perincian perkiraan. Data perincian perkiraan.

CpmRange

Rentang CPM berisi nilai minimum dan maksimum CPM.

Representasi JSON 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
Kolom
minCpm

object (Money)

Batas bawah rentang CPM.
maxCpm

object (Money)

Batas atas rentang CPM.

ForecastBreakdownData

Data perincian perkiraan menyimpan daftar perincian perkiraan.

Representasi JSON 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
Kolom
forecastBreakdowns[]

object (ForecastBreakdown)

Daftar perincian perkiraan.

ForecastBreakdown

Perincian perkiraan opsi penargetan yang dipilih.

Representasi JSON 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "impressions": string
  // End of mutually exclusive fields.
}
Kolom
selectedTargetingOption

object (SelectedTargetingOption)

Satu atau beberapa opsi penargetan yang dipilih untuk satu jenis penargetan.
Hanya satu jenis data pengelompokan yang dapat disertakan. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
impressions

string (int64 format)

Perkirakan tayangan iklan.
Akhir kolom yang saling eksklusif.

ErrorDetails

Detail error yang ditentukan saat update mengalami error.

Representasi JSON 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
Kolom
message

string

Pesan yang ditentukan saat update mengalami error.
instantDealErrorStatus

enum (InstantDealErrorStatus)

Status error yang ditentukan saat pembaruan mengalami error untuk transaksi instan.

InstantDealErrorStatus

Status error yang ditentukan saat pembaruan transaksi instan mengalami error.

Enum
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED Status error yang belum ditetapkan.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE Status error menunjukkan inventaris tidak tersedia.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE Status error menunjukkan perkiraan tidak tersedia.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT Status error menunjukkan ada kolom input yang tidak valid.

FrequencyCap

Frekuensi pengguna dapat melihat iklan yang sama selama jangka waktu tertentu

Representasi JSON 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
Kolom
timeUnit

enum (TimeUnit)

Unit waktu yang akan digunakan untuk menerapkan batas frekuensi.
maxImpressions

string (int64 format)

Frekuensi maksimum pengguna dapat melihat iklan yang sama selama periode ini.

TimeUnit

Unit waktu yang akan digunakan untuk menerapkan batas frekuensi.

Enum
TIME_UNIT_UNSPECIFIED Satuan waktu yang tidak ditentukan.
TIME_UNIT_LIFETIME Batas frekuensi akan diterapkan ke seluruh masa aktif.
TIME_UNIT_MONTHS Batas frekuensi akan diterapkan ke sejumlah bulan.
TIME_UNIT_WEEKS Batas frekuensi akan diterapkan ke sejumlah minggu.
TIME_UNIT_DAYS Batas frekuensi akan diterapkan ke sejumlah hari.

Metode

create

 Membuat produk.

get

 Mendapatkan produk.

list

 Mencantumkan produk.

patch

 Memperbarui produk.