Package google.shopping.merchant.notifications.v1beta

Chỉ mục

NotificationsApiService

Dịch vụ quản lý gói thuê bao thông báo cho người bán

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Tạo gói thuê bao thông báo cho một doanh nghiệp. Đối với tài khoản độc lập hoặc tài khoản phụ, doanh nghiệp có thể tự tạo gói thuê bao. Đối với tài khoản MCA, doanh nghiệp có thể tạo gói thuê bao cho tất cả tài khoản được quản lý hoặc cho một tài khoản phụ cụ thể.

Chúng tôi sẽ cho phép các loại gói thuê bao thông báo sau đây cùng tồn tại (mỗi doanh nghiệp là một người đăng ký cho mỗi loại sự kiện):

  1. Gói thuê bao cho tất cả tài khoản được quản lý + gói thuê bao cho chính bạn.

  2. Nhiều gói thuê bao "một phần" cho tài khoản được quản lý + gói thuê bao cho chính bạn.

chúng tôi sẽ không cho phép (mỗi doanh nghiệp là một người đăng ký theo mỗi loại sự kiện):

  1. Nhiều gói thuê bao tự đăng ký.

  2. Nhiều gói thuê bao "tất cả tài khoản được quản lý".

  3. Gói thuê bao "Tất cả tài khoản được quản lý" và gói thuê bao một phần cùng một lúc.

  4. Nhiều gói thuê bao một phần cho cùng một tài khoản mục tiêu.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.
DeleteNotificationSubscription

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

Xoá gói thuê bao thông báo cho người bán.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.
GetNotificationSubscription

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

Lấy thông tin đăng ký thông báo cho một tài khoản.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.
ListNotificationSubscriptions

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

Lấy tất cả các gói thuê bao thông báo cho một người bán.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.
UpdateNotificationSubscription

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

Cập nhật gói thuê bao thông báo hiện có cho người bán.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.

Thuộc tính

Enum để chỉ định thuộc tính trong tài nguyên đang được thay đổi để thông báo cho người bán.

Enum
ATTRIBUTE_UNSPECIFIED Thuộc tính chưa được chỉ định
STATUS Trạng thái của thực thể đã thay đổi

CreateNotificationSubscriptionRequest

Yêu cầu thông báo cho phương thức CreateNotificationSubscription.

Trường
parent

string

Bắt buộc. Tài khoản người bán sở hữu gói thuê bao thông báo mới. Định dạng accounts/{account}
notification_subscription

NotificationSubscription

Bắt buộc. Gói thuê bao thông báo cần tạo.

DeleteNotificationSubscriptionRequest

Thông báo yêu cầu cho phương thức DeleteNotificationSubscription.

Trường
name

string

Bắt buộc. Tên của gói thuê bao thông báo cần xoá.

GetNotificationSubscriptionRequest

Thông báo yêu cầu cho phương thức GetNotificationSubscription.

Trường
name

string

Bắt buộc. name của gói thuê bao thông báo.

ListNotificationSubscriptionsRequest

Thông báo yêu cầu cho phương thức ListNotificationSubscription.

Trường
parent

string

Bắt buộc. Tài khoản người bán sở hữu gói thuê bao thông báo. Định dạng accounts/{account}
page_size

int32

Số lượng gói thuê bao thông báo tối đa cần trả về trong một trang. Giá trị mặc định của page_size là 100. Giá trị tối đa là 200. Các giá trị trên 200 sẽ được ép thành 200.
page_token

string

Mã thông báo (nếu có) để truy xuất trang tiếp theo. Tất cả các thông số khác phải khớp với lệnh gọi ban đầu đã cung cấp mã thông báo trang.

ListNotificationSubscriptionsResponse

Thông báo phản hồi cho phương thức ListNotificationSubscription.

Trường
notification_subscriptions[]

NotificationSubscription

Danh sách gói thuê bao thông báo do người bán yêu cầu.
next_page_token

string

Mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

NotificationSubscription

Biểu thị một gói thuê bao thông báo do Tài khoản người bán sở hữu.

Trường
name

string

Chỉ có đầu ra. name của cấu hình thông báo. Được Content API tạo khi tạo một NotificationSubscription mới. account đại diện cho mã người bán của người bán sở hữu cấu hình. Định dạng: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event

NotificationEventType

Sự kiện mà người bán muốn được thông báo.
call_back_uri

string

URL dùng để đẩy thông báo đến người bán.

Trường hợp hợp nhất interested_in.

interested_in chỉ có thể là một trong những giá trị sau:
all_managed_accounts

bool

Nếu giá trị này là true, thì tài khoản yêu cầu sẽ được thông báo về sự kiện đã chỉ định cho tất cả tài khoản được quản lý (có thể là tài khoản phụ hoặc tài khoản được liên kết khác), bao gồm cả tài khoản mới thêm hằng ngày.
target_account

string

name của tài khoản mà bạn muốn nhận thông báo. Định dạng: accounts/{account}

NotificationEventType

Biểu thị loại sự kiện mà người bán muốn nhận thông báo.

Enum
NOTIFICATION_EVENT_TYPE_UNSPECIFIED Loại sự kiện thông báo chưa được chỉ định.
PRODUCT_STATUS_CHANGE Thông báo về các thay đổi về trạng thái sản phẩm, chẳng hạn như khi sản phẩm bị từ chối.

ProductChange

Thay đổi đã xảy ra đối với sản phẩm, bao gồm giá trị cũ, giá trị mới, mã quốc gia dưới dạng mã khu vực và ngữ cảnh báo cáo.

Trường
old_value

string

Giá trị cũ của tài nguyên hoặc thuộc tính đã thay đổi.
new_value

string

Giá trị mới của tài nguyên hoặc thuộc tính đã thay đổi.
region_code

string

Các quốc gia có thay đổi (nếu có)
reporting_context

ReportingContextEnum

Báo cáo các ngữ cảnh có thay đổi (nếu có)

ProductStatusChangeMessage

Thông báo mà người bán sẽ nhận được để thông báo về sự kiện thay đổi trạng thái sản phẩm

Trường
changes[]

ProductChange

Thông báo mô tả thay đổi đã xảy ra với sản phẩm
account

string

Tài khoản mục tiêu sở hữu thực thể đã thay đổi. Định dạng : accounts/{merchant_id}
managing_account

string

Tài khoản quản lý tài khoản của người bán. Tài khoản này có thể giống với mã người bán nếu là tài khoản độc lập. Định dạng : accounts/{service_provider_id}
resource_type

Resource

Tài nguyên đã thay đổi, trong trường hợp này sẽ luôn là Product.
attribute

Attribute

Thuộc tính trong tài nguyên đã thay đổi, trong trường hợp này, thuộc tính này sẽ luôn là Status.
resource_id

string

Mã sản phẩm.
resource

string

Tên sản phẩm. Định dạng {product.name=accounts/{account}/products/{product}}
expiration_time

Timestamp

Thời gian hết hạn của sản phẩm. Trường này sẽ không được đặt nếu thông báo được gửi cho một sự kiện xoá sản phẩm.

Tài nguyên

Enum để chỉ định tài nguyên đang được thay đổi để thông báo cho người bán.

Enum
RESOURCE_UNSPECIFIED Tài nguyên không xác định
PRODUCT Loại tài nguyên : sản phẩm

UpdateNotificationSubscriptionRequest

Thông báo yêu cầu cho phương thức UpdateNotificationSubscription.

Trường
notification_subscription

NotificationSubscription

Bắt buộc. Phiên bản mới của gói thuê bao thông báo cần được cập nhật.
update_mask

FieldMask

Danh sách các trường đang được cập nhật.