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)
  },
  "etag": string
}
Kolom
name

string

Nama rute 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. Maksimum 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. Saat ini 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 diisi untuk produk jenis transaksi yang dipesan.
makegood
(deprecated)

boolean

Menunjukkan apakah produk adalah produk kompensasi.
makegoodDetails
(deprecated)

object (MakegoodDetails)

Detail kompensasi untuk produk. Wajib diisi jika produk adalah 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 untuk kompatibilitas mundur, setelan defaultnya adalah DIGITAL. Tidak dapat diubah setelah pembuatan produk.
audienceTargetingConfig

object (AudienceTargetingConfig)

Opsional. Konfigurasi penargetan audiens yang dipilih diterapkan di tingkat transaksi di Exchange.
targetingCriteria

object (TargetingCriteria)

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

object (ForecastResult)

Hasil perkiraan produk. Wajib diisi jika kriteria penargetan tidak kosong dan perkiraan tidak diberikan. Hanya berlaku untuk Skenario Kesepakatan 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 produk tidak dapat diperbarui. Hanya berlaku untuk Skenario Kesepakatan Instan.
frequencyCap

object (FrequencyCap)

Hanya output. Batas frekuensi yang dipilih oleh pembeli. Hanya berlaku untuk Skenario Kesepakatan Instan.
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 Kesepakatan 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.

DimensionCreativeConfig

Dimensi materi iklan display dalam piksel.

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

integer

Lebar materi iklan display. Wajib.
height

integer

Tinggi materi iklan display. Wajib.

DurationCreativeConfig

Konfigurasi 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, yang diakhiri dengan 's'. Contoh: "3.5s".
durationMatchType

enum (DurationMatchType)

Kriteria kecocokan durasi.
skippableMatchType

enum (SkippableMatchType)

Jenis materi iklan video yang dapat dilewati.

DurationMatchType

Kemungkinan format untuk kriteria kecocokan durasi.

Enum
DURATION_MATCH_TYPE_UNSPECIFIED Kriteria kecocokan 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

Kemungkinan format untuk produk.

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 tidak boleh 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. Maksimum 100 karakter. Karakter yang diizinkan adalah alfanumerik, garis bawah, tanda hubung, dan titik. Wajib.
reason

string

Alasan Kompensasi yang diajukan penjual. Maks. 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; setiap permintaan yang mencoba menyetel 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 e-commerce.

TargetingCriteria

Kriteria penargetan ditentukan.

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

object (SelectedTargetingOption)

Opsi yang dipilih.

SelectedTargetingOption

Opsi penargetan yang dipilih untuk satu jenis penargetan.

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

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
Kolom
type

enum (TargetingType)

Jenis penargetan yang terkait dengan opsi yang dipilih.
Kolom union value. Hanya satu jenis pilihan yang dapat disertakan. Pilihan yang dipilih harus sesuai dengan TargetingType yang dipilih untuk kolom "type". value hanya dapat berupa salah satu dari berikut:
audienceSelection

object (AudienceSelection)

Audiens yang dipilih.
targetingSelection

object (TargetingSelection)

Kumpulan umum ID opsi yang dipilih.

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 DMA jenis penargetan.
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 Gender jenis penargetan.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Segmen kontekstual jenis penargetan.
TARGETING_TYPE_REQUEST_FORMAT Format permintaan jenis penargetan.
TARGETING_TYPE_PUBLISHER Jenis penargetan penayang.
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 penayangan video jenis penargetan.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Ukuran pemutar minimum video jenis penargetan.

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 sekelompok opsi yang digabungkan dengan OR.
excludedOptionIds[]

string (int64 format)

Opsi yang dikecualikan digabungkan dengan OR.

OrGroup

Grup opsi yang dipilih digabungkan dengan OR.

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

string (int64 format)

ID opsi yang dipilih.

TargetingSelection

Kumpulan satu atau beberapa ID opsi yang dipilih, berlaku untuk sebagian besar jenis penargetan.

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

string (int64 format)

ID opsi yang dipilih.

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),

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
Kolom
forecastCategory

enum (ForecastCategory)

Kategori perkiraan tertentu yang diwakili oleh statistik perkiraan.
Kolom union forecast_data. Hanya satu jenis data statistik yang dapat disertakan. Data yang diisi harus sesuai dengan kolom "forecastCategory". forecast_data hanya dapat berupa salah satu dari berikut:
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.

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 Poin rating target digital. Data persentase.
FORECAST_CATEGORY_SUGGESTED_CPM Harga CPM yang disarankan. Rentang CPM atau data harga CPM.
FORECAST_CATEGORY_UNIQUE_REACH Perkirakan jangkauan unik. Data angka.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Perincian perkiraan. Data perincian perkiraan.

CpmRange

Rentang CPM berisi CPM minimum dan maksimum.

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 berisi 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)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
Kolom
selectedTargetingOption

object (SelectedTargetingOption)

Opsi penargetan yang dipilih untuk satu jenis penargetan.
Kolom union breakdown_data. Hanya satu jenis data perincian yang dapat disertakan. breakdown_data hanya dapat berupa salah satu dari berikut:
impressions

string (int64 format)

Perkirakan tayangan.

ErrorDetails

Detail error yang ditentukan saat update mengalami error.

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

string

Pesan yang ditentukan saat pembaruan mengalami error.
instantDealErrorStatus

enum (InstantDealErrorStatus)

Status error yang ditentukan saat update memiliki error untuk penawaran instan.

InstantDealErrorStatus

Status error ditentukan saat update penawaran instan mengalami error.

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

FrequencyCap

Jumlah berapa kali pengguna dapat melihat iklan yang sama selama jangka waktu tertentu

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

enum (TimeUnit)

Unit waktu saat batas frekuensi akan diterapkan.
maxImpressions

string (int64 format)

Jumlah maksimum penayangan iklan yang sama kepada pengguna selama periode ini.

TimeUnit

Unit waktu saat batas frekuensi akan diterapkan.

Enum
TIME_UNIT_UNSPECIFIED Satuan waktu tidak ditentukan.
TIME_UNIT_LIFETIME Batas frekuensi akan diterapkan untuk seluruh masa aktif.
TIME_UNIT_MONTHS Pembatasan frekuensi akan diterapkan selama beberapa bulan.
TIME_UNIT_WEEKS Batas frekuensi akan diterapkan selama beberapa minggu.
TIME_UNIT_DAYS Batas frekuensi akan diterapkan selama beberapa hari.

Metode

create

 Membuat produk.

get

 Mendapatkan produk.

list

 Mencantumkan produk.

patch

 Memperbarui produk.