Package google.shopping.merchant.notifications.v1beta

Indeks

NotificationsApiService

Layanan untuk mengelola langganan notifikasi bagi penjual

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Membuat langganan notifikasi untuk bisnis. Untuk akun mandiri atau sub-akun, bisnis dapat membuat langganan untuk dirinya sendiri. Untuk MCA, bisnis dapat membuat langganan untuk semua akun terkelola atau untuk sub-akun tertentu.

Kami akan mengizinkan jenis langganan notifikasi berikut untuk ada bersama-sama (per bisnis sebagai pelanggan per jenis peristiwa):

  1. Langganan untuk semua akun terkelola + langganan untuk diri sendiri.

  2. Beberapa langganan "sebagian" untuk akun terkelola + langganan untuk diri sendiri.

kami tidak akan mengizinkan (per bisnis sebagai pelanggan per jenis peristiwa):

  1. Beberapa langganan mandiri.

  2. Beberapa langganan "semua akun terkelola".

  3. Langganan "Semua akun terkelola" dan langganan sebagian secara bersamaan.

  4. Beberapa langganan parsial untuk akun target yang sama.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

DeleteNotificationSubscription

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

Menghapus langganan notifikasi untuk penjual.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

GetNotificationSubscription

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

Mendapatkan langganan notifikasi untuk akun.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

ListNotificationSubscriptions

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

Mendapatkan semua langganan notifikasi untuk penjual.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

UpdateNotificationSubscription

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

Memperbarui langganan notifikasi yang ada untuk penjual.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

Atribut

Enum untuk menentukan atribut dalam resource yang diubah untuk memberi tahu penjual.

Enum
ATTRIBUTE_UNSPECIFIED Atribut tidak ditentukan
STATUS Status entitas yang diubah

CreateNotificationSubscriptionRequest

Pesan permintaan untuk metode CreateNotificationSubscription.

Kolom
parent

string

Wajib. Akun penjual yang memiliki langganan notifikasi baru. Format: accounts/{account}

notification_subscription

NotificationSubscription

Wajib. Langganan notifikasi yang akan dibuat.

DeleteNotificationSubscriptionRequest

Pesan permintaan untuk metode DeleteNotificationSubscription.

Kolom
name

string

Wajib. Nama langganan notifikasi yang akan dihapus.

GetNotificationSubscriptionRequest

Pesan permintaan untuk metode GetNotificationSubscription.

Kolom
name

string

Wajib. name langganan notifikasi.

ListNotificationSubscriptionsRequest

Pesan permintaan untuk metode ListNotificationSubscription.

Kolom
parent

string

Wajib. Akun penjual yang memiliki langganan notifikasi. Format: accounts/{account}

page_size

int32

Jumlah maksimum langganan notifikasi yang akan ditampilkan di halaman. Nilai default untuk page_size adalah 100. Nilai maksimumnya adalah 200. Nilai di atas 200 akan dikonversi menjadi 200.

page_token

string

Token (jika tersedia) untuk mengambil halaman selanjutnya. Semua parameter lainnya harus cocok dengan panggilan asli yang menyediakan token halaman.

ListNotificationSubscriptionsResponse

Pesan respons untuk metode ListNotificationSubscription.

Kolom
notification_subscriptions[]

NotificationSubscription

Daftar langganan notifikasi yang diminta oleh penjual.

next_page_token

string

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

NotificationSubscription

Merepresentasikan langganan notifikasi yang dimiliki oleh akun Penjual.

Kolom
name

string

Hanya output. name konfigurasi notifikasi. Dibuat oleh Content API setelah pembuatan NotificationSubscription baru. account mewakili ID penjual dari penjual yang memiliki konfigurasi. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}

registered_event

NotificationEventType

Peristiwa yang ingin diberi tahu oleh penjual.

call_back_uri

string

URL yang akan digunakan untuk mengirim notifikasi ke penjual.

Kolom union interested_in.

interested_in hanya dapat berupa salah satu dari yang berikut:

all_managed_accounts

bool

Jika nilai ini benar, akun yang meminta akan diberi tahu tentang peristiwa yang ditentukan untuk semua akun terkelola (dapat berupa sub-akun atau akun tertaut lainnya) termasuk akun yang baru ditambahkan setiap hari.

target_account

string

name akun yang notifikasinya ingin Anda terima. Format: accounts/{account}

NotificationEventType

Menampilkan jenis peristiwa yang notifikasinya ingin diterima penjual.

Enum
NOTIFICATION_EVENT_TYPE_UNSPECIFIED Jenis peristiwa notifikasi tidak ditentukan.
PRODUCT_STATUS_CHANGE Notifikasi perubahan status produk, misalnya saat produk tidak disetujui.

ProductChange

Perubahan yang terjadi pada produk termasuk nilai lama, nilai baru, kode negara sebagai kode wilayah, dan konteks pelaporan.

Kolom
old_value

string

Nilai lama dari aset atau atribut yang diubah.

new_value

string

Nilai baru dari resource atau atribut yang diubah.

region_code

string

Negara yang mengalami perubahan (jika ada)

reporting_context

ReportingContextEnum

Konteks pelaporan yang memiliki perubahan (jika ada)

ProductStatusChangeMessage

Pesan yang akan diterima penjual untuk memberi tahu tentang peristiwa perubahan status produk

Kolom
changes[]

ProductChange

Pesan untuk menggambarkan perubahan yang terjadi pada produk

account

string

Akun target yang memiliki entitas yang diubah. Format : accounts/{merchant_id}

managing_account

string

Akun yang mengelola akun penjual. Dapat sama dengan ID penjual jika merupakan akun mandiri. Format : accounts/{service_provider_id}

resource_type

Resource

Resource yang berubah, dalam hal ini akan selalu berupa Product.

attribute

Attribute

Atribut dalam resource yang berubah, dalam hal ini akan selalu Status.

resource_id

string

ID produk.

resource

string

Nama produk. Format: {product.name=accounts/{account}/products/{product}}

Resource

Enum untuk menentukan resource yang diubah untuk memberi tahu penjual.

Enum
RESOURCE_UNSPECIFIED Resource yang tidak ditentukan
PRODUCT Jenis resource : produk

UpdateNotificationSubscriptionRequest

Pesan permintaan untuk metode UpdateNotificationSubscription.

Kolom
notification_subscription

NotificationSubscription

Wajib. Versi baru langganan notifikasi yang harus diperbarui.

update_mask

FieldMask

Daftar kolom yang sedang diperbarui.