Package google.shopping.merchant.promotions.v1beta

Indeks

PromotionsService

Layanan untuk mengelola promosi produk.

GetPromotion

rpc GetPromotion(GetPromotionRequest) returns (Promotion)

Mengambil promosi dari akun Merchant Center Anda.

Setelah menyisipkan atau memperbarui input promosi, mungkin perlu waktu beberapa menit sebelum promosi yang diperbarui dapat diambil.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
InsertPromotion

rpc InsertPromotion(InsertPromotionRequest) returns (Promotion)

Menyisipkan promosi untuk akun Merchant Center Anda. Jika promosi sudah ada, maka promosi akan memperbarui promosi.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
ListPromotions

rpc ListPromotions(ListPromotionsRequest) returns (ListPromotionsResponse)

Mencantumkan promosi di akun Merchant Center. Respons mungkin berisi lebih sedikit item dari yang ditentukan oleh pageSize. Andalkan pageToken untuk menentukan apakah ada item lain yang akan diminta.

Setelah menyisipkan atau memperbarui promosi, mungkin perlu waktu beberapa menit sebelum promosi yang diproses yang diperbarui dapat diambil.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

Atribut

Atribut.

Kolom
product_applicability

ProductApplicability

Wajib. Pemberlakuan promosi ke semua produk atau produk tertentu saja.
offer_type

OfferType

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

string

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

string

Wajib. Judul panjang untuk promosi.
coupon_value_type

CouponValueType

Wajib. Atribut coupon value type untuk menandakan jenis promosi yang Anda jalankan. Bergantung pada jenis nilai kupon yang dipilih, beberapa atribut diperlukan.
promotion_destinations[]

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 mewakili nilai ini, gunakan FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. Untuk mengetahui detail selengkapnya, lihat Tujuan promosi
item_id_inclusion[]

string

Opsional. Filter produk menurut ID item untuk promosi. Atribut filter produk hanya diterapkan jika atribut kelayakan produk untuk promosi product_applicability pemberlakuan produk ditetapkan ke specific_products.
brand_inclusion[]

string

Opsional. Filter produk menurut merek untuk promosi. Atribut filter produk hanya diterapkan jika atribut kelayakan produk untuk promosi product_applicability pemberlakuan produk ditetapkan ke specific_products.
item_group_id_inclusion[]

string

Opsional. Filter produk menurut ID kelompok item untuk promosi. Atribut filter produk hanya berlaku jika atribut kelayakan produk untuk promosi pemberlakuan produk [product_applicability] ditetapkan ke specific_products.
product_type_inclusion[]

string

Opsional. Filter produk menurut tipe produk untuk promosi. Atribut filter produk hanya diterapkan jika atribut kelayakan produk untuk promosi product_applicability pemberlakuan produk ditetapkan ke specific_products.
item_id_exclusion[]

string

Opsional. Filter produk menurut pengecualian ID item untuk promosi. Atribut filter produk hanya diterapkan jika atribut kelayakan produk untuk promosi product_applicability pemberlakuan produk ditetapkan ke specific_products.
brand_exclusion[]

string

Opsional. Filter produk menurut pengecualian merek untuk promosi. Atribut filter produk hanya diterapkan jika atribut kelayakan produk untuk promosi product_applicability pemberlakuan produk ditetapkan ke specific_products.
item_group_id_exclusion[]

string

Opsional. Filter produk menurut ID kelompok item. Atribut filter produk hanya berlaku jika atribut kelayakan produk untuk promosi product_applicability pemberlakuan produk ditetapkan ke specific_products, pengecualian untuk promosi.
product_type_exclusion[]

string

Opsional. Filter produk menurut pengecualian tipe produk untuk promosi. Atribut filter produk hanya diterapkan jika atribut kelayakan produk untuk promosi product_applicability pemberlakuan produk ditetapkan ke specific_products.
minimum_purchase_amount

Price

Opsional. Jumlah pembelian minimum untuk promosi.
minimum_purchase_quantity

int64

Opsional. Jumlah pembelian minimum untuk promosi.
limit_quantity

int64

Opsional. Jumlah pembelian maksimum untuk promosi.
limit_value

Price

Opsional. Harga produk maksimum untuk promosi.
percent_off

int64

Opsional. Diskon persentase yang ditawarkan dalam promosi.
money_off_amount

Price

Opsional. Jumlah potongan harga yang ditawarkan dalam promosi.
get_this_quantity_discounted

int64

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

Price

Opsional. Nilai hadiah gratis untuk promosi.
free_gift_description

string

Opsional. Deskripsi hadiah gratis untuk promosi.
free_gift_item_id

string

Opsional. ID item hadiah gratis untuk promosi.
promotion_effective_time_period

Interval

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

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 atribut jangka waktu tampilan untuk promosi promotion_display_time_period tidak ditentukan, jangka waktu mulai berlaku promosi promotion_effective_time_period akan menentukan tanggal dan jangka waktu saat promosi akan ditampilkan di Google.com dan iklan Shopping.
store_applicability

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 store_applicability ditetapkan ke ALL_STORES dan store_codes_inclusion atau score_code_exclusion ditetapkan ke nilai.
store_codes_inclusion[]

string

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

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

string

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

string

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

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. minimum_purchase_quantity dan get_this_quantity_discounted harus ada. money_off_amount juga harus ada.
BUY_M_GET_N_PERCENT_OFF Beli jumlah M, dapatkan jenis nilai kupon diskon N persen. minimum_purchase_quantity dan get_this_quantity_discounted harus ada. percent_off_percentage juga harus ada.
BUY_M_GET_MONEY_OFF Beli jumlah M, dapatkan potongan harga. minimum_purchase_quantity dan money_off_amount harus ada.
BUY_M_GET_PERCENT_OFF Beli jumlah M, dapatkan potongan harga. minimum_purchase_quantity 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 selama dua hari.

GetPromotionRequest

Pesan permintaan untuk metode GetPromotion.

Kolom
name

string

Wajib. Nama promosi yang akan diambil. Format: accounts/{account}/promotions/{promotions}

InsertPromotionRequest

Pesan permintaan untuk metode InsertPromotion.

Kolom
parent

string

Wajib. Akun tempat promosi akan dimasukkan. Format: accounts/{account}
promotion

Promotion

Wajib. Promosi yang akan disisipkan.
data_source

string

Wajib. Sumber data Format promosi: accounts/{account}/dataSources/{datasource}.

ListPromotionsRequest

Pesan permintaan untuk metode ListPromotions.

Kolom
parent

string

Wajib. Akun untuk mencantumkan promosi yang diproses. Format: accounts/{account}
page_size

int32

Hanya output. Jumlah maksimum promosi yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Nilai maksimum adalah 1.000; nilai di atas 1.000 akan dikonversi menjadi 1.000. Jika tidak ditentukan, jumlah maksimum promosi akan ditampilkan.
page_token

string

Hanya output. Token halaman, yang diterima dari panggilan ListPromotions sebelumnya. Berikan atribut ini untuk mengambil halaman selanjutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan ke ListPromotions harus cocok dengan panggilan yang menyediakan token halaman.

ListPromotionsResponse

Pesan respons untuk metode ListPromotions.

Kolom
promotions[]

Promotion

Promosi yang diproses dari akun yang ditentukan.
next_page_token

string

Token, yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak ada halaman berikutnya.

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 umum untuk promosi wajib diisi jika offerType = GENERIC_CODE.

ProductApplicability

Produk atau daftar produk yang memiliki promosi.

Enum
PRODUCT_APPLICABILITY_UNSPECIFIED Produk tempat promosi berlaku tidak diketahui.
ALL_PRODUCTS Berlaku untuk semua produk.
SPECIFIC_PRODUCTS Berlaku hanya untuk satu produk atau daftar produk.

Promosi

Mewakili promosi. Lihat artikel berikut untuk detail selengkapnya.

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

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

Kolom
name

string

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

string

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

string

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

Promosi hanya untuk bahasa tertentu.
target_country

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
redemption_channel[]

RedemptionChannel

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

string

Hanya output. Sumber data utama promosi.
attributes

Attributes

Opsional. Daftar atribut promosi.
custom_attributes[]

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.
promotion_status

PromotionStatus

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

int64

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

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

Jika operasi dicegah, pengecualian yang dibatalkan akan ditampilkan.

PromotionStatus

Status promosi.

Kolom
destination_statuses[]

DestinationStatus

Hanya output. Tujuan yang dimaksud untuk promosi.
item_level_issues[]

ItemLevelIssue

Hanya output. Daftar masalah yang terkait dengan promosi.
creation_date

Timestamp

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

Timestamp

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.

Kolom
reporting_context

ReportingContextEnum

Hanya output. Nama tujuan promosi.
status

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 telah disetujui dan aktif.
STOPPED Promosi dihentikan oleh penjual.
EXPIRED Promosi tidak aktif lagi.
PENDING Promosi tidak dihentikan, dan semua ulasan disetujui, tetapi tanggal aktifnya akan datang di masa mendatang.

ItemLevelIssue

Masalah yang terkait dengan promosi.

Kolom
code

string

Hanya output. Kode error masalah.
severity

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 masalah disebabkan oleh satu atribut.
reporting_context

ReportingContextEnum

Hanya output. Tujuan tempat masalah terjadi.
description

string

Hanya output. Deskripsi masalah singkat 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.
applicable_countries[]

string

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

Tingkat keparahan

Tingkat keparahan masalah.

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

RedemptionChannel

Saluran promosi.

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

StoreApplicability

Kode toko atau daftar kode toko tempat promosi berlaku. 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.