REST Resource: accounts.promotions

Resource: Promotion

Mewakili promosi. Lihat artikel berikut untuk detail selengkapnya.

Atribut input promosi yang diperlukan agar lulus pemeriksaan validasi data terutama didefinisikan di bawah:

Setelah menyisipkan, memperbarui input promosi, mungkin perlu waktu beberapa menit sebelum promosi akhir dapat diambil.

Representasi JSON 
{
  "name": string,
  "promotionId": string,
  "contentLanguage": string,
  "targetCountry": string,
  "redemptionChannel": [
    enum (RedemptionChannel)
  ],
  "dataSource": string,
  "attributes": {
    object (Attributes)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "promotionStatus": {
    object (PromotionStatus)
  },
  "versionNumber": string
}
Kolom
name

string

ID. Nama promosi. Format: accounts/{account}/promotions/{promotion}
promotionId

string

Wajib. Pengguna memberikan ID promosi untuk mengidentifikasi promosi secara unik. Ikuti persyaratan minimum untuk mencegah penolakan promosi.
contentLanguage

string

Wajib. Kode bahasa ISO 639-1 dua huruf untuk promosi.

Promosi hanya untuk bahasa tertentu.
targetCountry

string

Wajib. Negara target yang digunakan sebagai bagian dari ID unik. Direpresentasikan sebagai kode wilayah CLDR.

Promosi hanya tersedia di negara tertentu, Listingan Gratis dan iklan Shopping Iklan Inventaris Lokal
redemptionChannel[]

enum (RedemptionChannel)

Wajib. Saluran penukaran untuk promosi. Minimal satu channel diperlukan.
dataSource

string

Hanya output. Sumber data utama promosi.
attributes

object (Attributes)

Opsional. Daftar atribut promosi.
customAttributes[]

object (CustomAttribute)

Opsional. Daftar atribut khusus (disediakan penjual). Atribut ini juga dapat digunakan untuk mengirimkan atribut spesifikasi data apa pun dalam bentuk generiknya (misalnya, { "name": "size type", "value": "regular" }). Hal ini berguna untuk mengirimkan atribut yang tidak diekspos secara eksplisit oleh API.
promotionStatus

object (PromotionStatus)

Hanya output. Status promosi, masalah validasi data, yaitu, informasi tentang promosi yang dihitung secara asinkron.
versionNumber

string (int64 format)

Opsional. Merepresentasikan versi promosi yang ada (keaktualan), yang dapat digunakan untuk mempertahankan urutan yang tepat saat beberapa pembaruan dilakukan secara bersamaan.

Jika ditetapkan, penyisipan akan dicegah jika nomor versi lebih rendah dari nomor versi saat ini dari promosi yang ada. Penyisipan ulang (misalnya, pembaruan promosi setelah 30 hari) dapat dilakukan dengan versionNumber saat ini.

Jika operasi dicegah, pengecualian yang dibatalkan akan ditampilkan.

RedemptionChannel

Saluran promosi.

Enum
REDEMPTION_CHANNEL_UNSPECIFIED Menunjukkan bahwa saluran tidak ditentukan.
IN_STORE Menunjukkan bahwa channel tersedia di toko. Ini sama dengan saluran local yang digunakan untuk products.
ONLINE Menunjukkan bahwa channel sedang online.

Atribut

Atribut.

Representasi JSON 
{
  "productApplicability": enum (ProductApplicability),
  "offerType": enum (OfferType),
  "genericRedemptionCode": string,
  "longTitle": string,
  "couponValueType": enum (CouponValueType),
  "promotionDestinations": [
    enum (DestinationEnum)
  ],
  "itemIdInclusion": [
    string
  ],
  "brandInclusion": [
    string
  ],
  "itemGroupIdInclusion": [
    string
  ],
  "productTypeInclusion": [
    string
  ],
  "itemIdExclusion": [
    string
  ],
  "brandExclusion": [
    string
  ],
  "itemGroupIdExclusion": [
    string
  ],
  "productTypeExclusion": [
    string
  ],
  "minimumPurchaseAmount": {
    object (Price)
  },
  "minimumPurchaseQuantity": string,
  "limitQuantity": string,
  "limitValue": {
    object (Price)
  },
  "percentOff": string,
  "moneyOffAmount": {
    object (Price)
  },
  "getThisQuantityDiscounted": string,
  "freeGiftValue": {
    object (Price)
  },
  "freeGiftDescription": string,
  "freeGiftItemId": string,
  "promotionEffectiveTimePeriod": {
    object (Interval)
  },
  "promotionDisplayTimePeriod": {
    object (Interval)
  },
  "storeApplicability": enum (StoreApplicability),
  "storeCodesInclusion": [
    string
  ],
  "storeCodesExclusion": [
    string
  ],
  "promotionUrl": string
}
Kolom
productApplicability

enum (ProductApplicability)

Wajib. Penerapan promosi untuk semua produk atau hanya produk tertentu.
offerType

enum (OfferType)

Wajib. Jenis promosi. Gunakan atribut ini untuk menunjukkan apakah pelanggan memerlukan kode kupon untuk menukarkan promosi Anda atau tidak.
genericRedemptionCode

string

Opsional. Kode penukaran generik untuk promosi. Untuk digunakan dengan kolom offerType dan harus memenuhi persyaratan minimum.
longTitle

string

Wajib. Judul panjang untuk promosi.
couponValueType

enum (CouponValueType)

Wajib. Atribut jenis nilai kupon untuk menunjukkan jenis promosi yang Anda jalankan. Bergantung pada jenis nilai kupon yang dipilih, beberapa atribut diperlukan.
promotionDestinations[]

enum (DestinationEnum)

Wajib. Daftar tujuan tempat promosi berlaku. Jika Anda tidak menentukan tujuan dengan menyertakan nilai yang didukung di sumber data, promosi Anda secara default akan ditampilkan di iklan Shopping dan listingan gratis.

Anda mungkin sebelumnya telah mengirimkan nilai berikut sebagai tujuan untuk produk Anda: Shopping Actions, Platform Google, platform Google lokal. Untuk merepresentasikan nilai ini, gunakan FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. Untuk mengetahui detail selengkapnya, lihat Tujuan promosi
itemIdInclusion[]

string

Opsional. Filter produk menurut ID item untuk promosi. Atribut filter produk hanya diterapkan jika atribut keberlakuan produk productApplicability untuk produk yang memenuhi syarat promosi ditetapkan ke specific_products.
brandInclusion[]

string

Opsional. Filter produk menurut merek untuk promosi. Atribut filter produk hanya diterapkan jika atribut keberlakuan produk productApplicability untuk produk yang memenuhi syarat promosi ditetapkan ke specific_products.
itemGroupIdInclusion[]

string

Opsional. Filter produk menurut ID kelompok item untuk promosi. Atribut filter produk hanya diterapkan jika atribut keberlakuan produk [productApplicability] untuk produk yang memenuhi syarat promosi ditetapkan ke specific_products.
productTypeInclusion[]

string

Opsional. Filter produk menurut jenis produk untuk promosi. Atribut filter produk hanya diterapkan jika atribut keberlakuan produk productApplicability untuk produk yang memenuhi syarat promosi ditetapkan ke specific_products.
itemIdExclusion[]

string

Opsional. Filter produk menurut pengecualian ID item untuk promosi. Atribut filter produk hanya diterapkan jika atribut keberlakuan produk productApplicability untuk produk yang memenuhi syarat promosi ditetapkan ke specific_products.
brandExclusion[]

string

Opsional. Filter produk menurut pengecualian merek untuk promosi. Atribut filter produk hanya diterapkan jika atribut keberlakuan produk productApplicability untuk produk yang memenuhi syarat promosi ditetapkan ke specific_products.
itemGroupIdExclusion[]

string

Opsional. Filter produk menurut ID kelompok item. Atribut filter produk hanya diterapkan jika atribut productApplicability keberlakuan produk yang memenuhi syarat untuk promosi ditetapkan ke specific_products. pengecualian untuk promosi.
productTypeExclusion[]

string

Opsional. Filter produk menurut pengecualian jenis produk untuk promosi. Atribut filter produk hanya berlaku jika atribut kelayakan produk untuk promosi productApplicability pemberlakuan produk ditetapkan ke specific_products.
minimumPurchaseAmount

object (Price)

Opsional. Jumlah pembelian minimum untuk promosi.
minimumPurchaseQuantity

string (int64 format)

Opsional. Jumlah pembelian minimum untuk promosi.
limitQuantity

string (int64 format)

Opsional. Jumlah pembelian maksimum untuk promosi.
limitValue

object (Price)

Opsional. Harga produk maksimum untuk promosi.
percentOff

string (int64 format)

Opsional. Persentase diskon yang ditawarkan dalam promosi.
moneyOffAmount

object (Price)

Opsional. Jumlah potongan harga yang ditawarkan dalam promosi.
getThisQuantityDiscounted

string (int64 format)

Opsional. Jumlah item yang didiskon dalam promosi. Atribut ditetapkan saat couponValueType sama dengan buy_m_get_n_money_off atau buy_m_get_n_percent_off.
freeGiftValue

object (Price)

Opsional. Nilai hadiah gratis untuk promosi.
freeGiftDescription

string

Opsional. Deskripsi hadiah gratis untuk promosi.
freeGiftItemId

string

Opsional. ID item hadiah gratis untuk promosi.
promotionEffectiveTimePeriod

object (Interval)

Wajib. Representasi TimePeriod untuk tanggal mulai berlaku promosi. Atribut ini menentukan bahwa promosi dapat diuji di toko online Anda selama jangka waktu ini.
promotionDisplayTimePeriod

object (Interval)

Opsional. Representasi TimePeriod untuk tanggal tayang promosi. Atribut ini menentukan tanggal dan jangka waktu saat promosi akan ditampilkan di Google.com dan iklan Shopping. Jika jangka waktu tampilan untuk atribut promotionDisplayTimePeriod promosi tidak ditentukan, jangka waktu berlaku promosi promotionEffectiveTimePeriod akan menentukan tanggal dan jangka waktu saat promosi akan ditampilkan di Google.com dan iklan Shopping.
storeApplicability

enum (StoreApplicability)

Opsional. Apakah promosi berlaku untuk semua toko, atau hanya toko tertentu. Promosi iklan Inventaris Lokal akan menampilkan error jika tidak ada penerapan toko yang disertakan. Error INVALID_ARGUMENT ditampilkan jika storeApplicability ditetapkan ke ALL_STORES dan storeCodesInclusion atau score_code_exclusion ditetapkan ke nilai.
storeCodesInclusion[]

string

Opsional. Kode toko yang akan disertakan untuk promosi. Atribut filter toko hanya berlaku jika atribut storeApplicability ditetapkan ke specific_stores.

Kode toko (ID toko dari Profil Bisnis Anda) dari toko fisik tempat produk dijual. Lihat Spesifikasi data inventaris produk lokal untuk mengetahui informasi selengkapnya.
storeCodesExclusion[]

string

Opsional. Kode toko yang akan dikecualikan untuk promosi. Atribut filter toko hanya berlaku jika atribut storeApplicability ditetapkan ke specific_stores.
promotionUrl

string

Opsional. URL ke halaman di situs penjual tempat promosi ditampilkan. Promosi iklan Inventaris Lokal akan menampilkan error jika tidak ada promotionUrl yang disertakan. URL digunakan untuk mengonfirmasi bahwa promosi valid dan dapat ditukarkan.

ProductApplicability

Produk atau daftar produk yang menjadi sasaran promosi.

Enum
PRODUCT_APPLICABILITY_UNSPECIFIED Produk yang menjadi sasaran promosi tidak diketahui.
ALL_PRODUCTS Berlaku untuk semua produk.
SPECIFIC_PRODUCTS Hanya berlaku untuk satu produk atau daftar produk.

OfferType

Jenis penawaran promosi.

Enum
OFFER_TYPE_UNSPECIFIED Jenis penawaran tidak diketahui.
NO_CODE Jenis penawaran tanpa kode.
GENERIC_CODE Jenis penawaran dengan kode. Kode penukaran generik untuk promosi diperlukan jika offerType = GENERIC_CODE.

CouponValueType

Jenis nilai kupon promosi.

Enum
COUPON_VALUE_TYPE_UNSPECIFIED Menunjukkan bahwa jenis nilai kupon tidak ditentukan.
MONEY_OFF Jenis nilai kupon potongan harga.
PERCENT_OFF Jenis nilai kupon diskon persen.
BUY_M_GET_N_MONEY_OFF Beli jumlah M, dapatkan jenis nilai kupon diskon N. minimumPurchaseQuantity dan getThisQuantityDiscounted harus ada. moneyOffAmount juga harus ada.
BUY_M_GET_N_PERCENT_OFF Beli jumlah M, dapatkan diskon N persen untuk jenis nilai kupon. minimumPurchaseQuantity dan getThisQuantityDiscounted harus ada. percent_off_percentage juga harus ada.
BUY_M_GET_MONEY_OFF Beli jumlah M, dapatkan potongan harga. minimumPurchaseQuantity dan moneyOffAmount harus ada.
BUY_M_GET_PERCENT_OFF Beli jumlah M, dapatkan potongan harga. minimumPurchaseQuantity dan percent_off_percentage harus ada.
FREE_GIFT Hadiah gratis dengan deskripsi saja.
FREE_GIFT_WITH_VALUE Hadiah gratis dengan nilai uang.
FREE_GIFT_WITH_ITEM_ID Hadiah gratis dengan ID item.
FREE_SHIPPING_STANDARD Jenis nilai kupon pengiriman gratis standar.
FREE_SHIPPING_OVERNIGHT Jenis nilai kupon pengiriman gratis semalam.
FREE_SHIPPING_TWO_DAY Jenis nilai kupon pengiriman gratis dua hari.

DestinationEnum

Nilai tujuan.

Enum
DESTINATION_ENUM_UNSPECIFIED Tidak ditentukan.
SHOPPING_ADS Iklan Shopping.
DISPLAY_ADS Iklan Display.
LOCAL_INVENTORY_ADS Iklan inventaris lokal.
FREE_LISTINGS Listingan gratis.
FREE_LOCAL_LISTINGS Listingan produk lokal gratis.
YOUTUBE_SHOPPING YouTube Shopping.
YOUTUBE_SHOPPING_CHECKOUT Checkout YouTube Shopping.
YOUTUBE_AFFILIATE Afiliasi YouTube.
FREE_VEHICLE_LISTINGS Listingan kendaraan gratis.
VEHICLE_ADS Iklan kendaraan.
CLOUD_RETAIL untuk retail cloud.
LOCAL_CLOUD_RETAIL Retail cloud lokal.

StoreApplicability

Kode toko atau daftar kode toko yang menjadi tujuan promosi. Hanya untuk promosi Iklan inventaris lokal.

Enum
STORE_APPLICABILITY_UNSPECIFIED Kode toko tempat promosi berlaku tidak diketahui.
ALL_STORES Promosi berlaku untuk semua toko.
SPECIFIC_STORES Promosi hanya berlaku untuk toko yang ditentukan.

PromotionStatus

Status promosi.

Representasi JSON 
{
  "destinationStatuses": [
    {
      object (DestinationStatus)
    }
  ],
  "itemLevelIssues": [
    {
      object (ItemLevelIssue)
    }
  ],
  "creationDate": string,
  "lastUpdateDate": string
}
Kolom
destinationStatuses[]

object (DestinationStatus)

Hanya output. Tujuan yang dimaksudkan untuk promosi.
itemLevelIssues[]

object (ItemLevelIssue)

Hanya output. Daftar masalah yang terkait dengan promosi.
creationDate

string (Timestamp format)

Hanya output. Tanggal pembuatan promosi dalam format ISO 8601: Tanggal, waktu, dan offset, misalnya 2020-01-02T09:00:00+01:00 atau 2020-01-02T09:00:00Z
lastUpdateDate

string (Timestamp format)

Hanya output. Tanggal saat status promosi terakhir diperbarui dalam format ISO 8601: Tanggal, waktu, dan offset, misalnya 2020-01-02T09:00:00+01:00 atau 2020-01-02T09:00:00Z

DestinationStatus

Status untuk tujuan yang ditentukan.

Representasi JSON 
{
  "reportingContext": enum (ReportingContextEnum),
  "status": enum (State)
}
Kolom
reportingContext

enum (ReportingContextEnum)

Hanya output. Nama tujuan promosi.
status

enum (State)

Hanya output. Status untuk tujuan yang ditentukan.

Negara Bagian

Status promosi saat ini.

Enum
STATE_UNSPECIFIED Status promosi tidak diketahui.
IN_REVIEW Promosi sedang dalam peninjauan.
REJECTED Promosi tidak disetujui.
LIVE Promosi disetujui dan aktif.
STOPPED Promosi dihentikan oleh penjual.
EXPIRED Promosi tidak lagi aktif.
PENDING Promosi tidak dihentikan, dan semua ulasan disetujui, tetapi tanggal aktifnya akan datang di masa mendatang.

ItemLevelIssue

Masalah yang terkait dengan promosi.

Representasi JSON 
{
  "code": string,
  "severity": enum (Severity),
  "resolution": string,
  "attribute": string,
  "reportingContext": enum (ReportingContextEnum),
  "description": string,
  "detail": string,
  "documentation": string,
  "applicableCountries": [
    string
  ]
}
Kolom
code

string

Hanya output. Kode error masalah.
severity

enum (Severity)

Hanya output. Pengaruh masalah ini terhadap penayangan promosi.
resolution

string

Hanya output. Apakah masalah dapat diselesaikan oleh penjual.
attribute

string

Hanya output. Nama atribut, jika masalahnya disebabkan oleh satu atribut.
reportingContext

enum (ReportingContextEnum)

Hanya output. Tujuan tempat masalah diterapkan.
description

string

Hanya output. Deskripsi singkat masalah dalam bahasa Inggris.
detail

string

Hanya output. Deskripsi masalah mendetail dalam bahasa Inggris.
documentation

string

Hanya output. URL halaman web untuk membantu menyelesaikan masalah ini.
applicableCountries[]

string

Hanya output. Daftar kode negara (ISO 3166-1 alpha-2) tempat masalah berlaku untuk penawaran.

Keparahan

Tingkat keparahan masalah.

Enum
SEVERITY_UNSPECIFIED Tidak ditentukan.
NOT_IMPACTED Masalah ini merupakan peringatan dan tidak berdampak langsung terhadap promosi.
DEMOTED Promosi diturunkan dan kemungkinan besar memiliki performa terbatas di hasil penelusuran
DISAPPROVED Masalah tidak menyetujui promosi.

Metode

get

 Mengambil promosi dari akun Merchant Center Anda.

insert

 Menyisipkan promosi untuk akun Merchant Center Anda.

list

 Mencantumkan promosi di akun Merchant Center Anda.