Method: exchanges.orders.products.patch

Memperbarui produk.

Permintaan HTTP

PATCH https://dv360seller.googleapis.com/v1beta1/{product.name=exchanges/*/orders/*/products/*}

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
product.name

string

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

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "product": {
    "name": string,
    "displayName": string,
    "externalDealId": string,
    "transactionType": enum (TransactionType),
    "pricingType": enum (PricingType),
    "updateTime": string,
    "startTime": string,
    "endTime": string,
    "rateDetails": {
      "rateType": enum (RateType),
      "rate": {
        object (Money)
      },
      "unitsPurchasedCount": string
    },
    "creativeConfig": [
      {
        "creativeType": enum (CreativeType),
        "dimensionCreativeConfig": {
          object (DimensionCreativeConfig)
        },
        "durationCreativeConfig": {
          object (DurationCreativeConfig)
        }
      }
    ],
    "makegood": boolean,
    "makegoodDetails": {
      "originalExternalDealId": string,
      "reason": string
    },
    "creativeSource": enum (CreativeSource),
    "mediumType": enum (MediumType),
    "audienceTargetingConfig": {
      "audienceType": enum (AudienceType)
    },
    "targetingCriteria": {
      "selectedTargetingOptions": [
        {
          object (SelectedTargetingOption)
        }
      ]
    },
    "forecastResult": {
      "forecasts": [
        {
          object (Forecast)
        }
      ]
    },
    "errorDetails": {
      "message": string,
      "instantDealErrorStatus": enum (InstantDealErrorStatus)
    },
    "frequencyCap": {
      "timeUnit": enum (TimeUnit),
      "maxImpressions": string
    },
    "program": string,
    "buyerCustomParameters": {
      string: string,
      ...
    },
    "etag": string
  },
  "updateMask": string
}
Kolom
product.displayName

string

Nama tampilan produk.

Harus berenkode UTF-8 dengan ukuran maksimum 240 byte. Wajib.
product.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.
product.transactionType

enum (TransactionType)

Jenis transaksi produk. Wajib.
product.pricingType

enum (PricingType)

Jenis harga untuk produk. Wajib.
product.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".
product.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".
product.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".
product.rateDetails

object (RateDetails)

Detail tarif. Wajib.
product.creativeConfig[]

object (CreativeConfig)

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

boolean

Menunjukkan apakah produk merupakan produk kompensasi.
product.makegoodDetails
(deprecated)

object (MakegoodDetails)

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

enum (CreativeSource)

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

enum (MediumType)

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

object (AudienceTargetingConfig)

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

object (TargetingCriteria)

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

object (ForecastResult)

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

object (FrequencyCap)

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

string

Hanya output. Program yang digunakan pembeli untuk membuat transaksi instan. Kosong untuk alur reguler pertukaran. Hanya berlaku untuk Skenario Transaksi Instan.
product.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" }.
product.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.
updateMask

string (FieldMask format)

Mask untuk mengontrol kolom yang akan diperbarui. Wajib.

Ini adalah daftar dipisahkan koma yang berisi nama-nama kolom yang sepenuhnya valid. Contoh: "user.displayName,photo".

Isi respons

Jika berhasil, isi respons memuat instance Product.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/doubleclickbidmanager

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.