Package google.mybusiness.notifications.v1

Chỉ mục

NotificationSettings

Dịch vụ này cho phép người dùng quản lý các chế độ cài đặt thông báo cho tài khoản doanh nghiệp của họ.

GetNotificationSetting

rpc GetNotificationSetting(GetNotificationSettingRequest) returns (NotificationSetting)

Trả về chế độ cài đặt thông báo pubsub cho tài khoản.

Phạm vi uỷ quyền

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

  • https://www.googleapis.com/auth/business.manage

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

UpdateNotificationSetting

rpc UpdateNotificationSetting(UpdateNotificationSettingRequest) returns (NotificationSetting)

Đặt cài đặt thông báo pubsub cho tài khoản để thông báo cho Google chủ đề cần gửi thông báo pubsub. Sử dụng trường notification_types trong notification_setting để thao tác với các sự kiện mà tài khoản muốn đăng ký.

Mỗi tài khoản sẽ chỉ có một tài nguyên cài đặt thông báo và chỉ có thể đặt một chủ đề pubsub. Để xoá chế độ cài đặt này, hãy cập nhật bằng thông báo_type trống

Phạm vi uỷ quyền

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

  • https://www.googleapis.com/auth/business.manage

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

ErrorCode

Tất cả các mã lỗi mà API trả về.

Enum
ERROR_CODE_UNSPECIFIED Thiếu mã lỗi.
SHARES_PUBSUB_TOPIC_MESSAGE_ACROSS_VERSIONS Tên chủ đề pub/sub được cung cấp trong rpc 'updateNotificationSettings' đang được các phiên bản khác của API này sử dụng. Vui lòng cung cấp tên chủ đề mới để giảm thiểu vấn đề này.
PUBLISH_PERMISSIONS_MISSING_FOR_PUBSUB_TOPIC Tên chủ đề xuất bản/phụ được cung cấp cho chế độ cài đặt thông báo cập nhật không có quyền xuất bản đối với người dùng.
INVALID_PUBSUB_TOPIC Tên chủ đề xuất bản/phụ được cung cấp cho chế độ cài đặt thông báo cập nhật không hợp lệ.

GetNotificationSettingRequest

Thông báo yêu cầu cho NotificationSettings.GetNotificationSettings.

Các trường
name

string

Bắt buộc. Tên tài nguyên của chế độ cài đặt thông báo mà chúng ta đang cố gắng tìm nạp.

NotificationSetting

Chủ đề Google Pub/Sub trong đó có thể xuất bản thông báo khi vị trí được cập nhật hoặc có bài đánh giá mới. Mỗi tài khoản sẽ chỉ có một tài nguyên cài đặt thông báo.

Các trường
name

string

Bắt buộc. Tên tài nguyên mà chế độ cài đặt này dành cho. Mã này có dạng accounts/{account_id}/notificationSetting.

pubsub_topic

string

Không bắt buộc. Chủ đề Google Pub/Sub sẽ nhận được thông báo khi vị trí do tài khoản này quản lý được cập nhật. Nếu bạn không đặt chính sách này thì sẽ không có thông báo nào được đăng.

Tài khoản mybusiness-api-pubsub@system.gserviceaccount.com tối thiểu phải có quyền Xuất bản đối với chủ đề Pub/Sub.

notification_types[]

NotificationType

Các loại thông báo sẽ được gửi đến chủ đề Pub/Sub. Để ngừng nhận hoàn toàn thông báo, hãy sử dụng NotificationSettings.UpdateNotificationSet với thông báo kiểu thông báo trống hoặc đặt pubsub_topic thành một chuỗi trống.

NotificationType

Loại thông báo được gửi đến chủ đề Pub/Sub.

Enum
NOTIFICATION_TYPE_UNSPECIFIED Không có loại thông báo nào. Sẽ không khớp với bất kỳ thông báo nào.
GOOGLE_UPDATE Vị trí có nội dung cập nhật của Google cần xem xét. Trường location_name trên thông báo sẽ cung cấp tên tài nguyên của vị trí có nội dung cập nhật của Google.
NEW_REVIEW Một bài đánh giá mới đã được thêm vào vị trí này. Trường review_name trên thông báo sẽ cung cấp tên tài nguyên của bài đánh giá đã được thêm, còn location_name sẽ có tên tài nguyên của vị trí.
UPDATED_REVIEW Chúng tôi đã cập nhật một bài đánh giá về vị trí đó. Trường review_name trên thông báo sẽ cung cấp tên tài nguyên của bài đánh giá đã được thêm, còn location_name sẽ có tên tài nguyên của vị trí.
NEW_CUSTOMER_MEDIA Một người dùng Google Maps đã thêm một mục nội dung đa phương tiện mới vào vị trí. Thông báo sẽ cung cấp tên tài nguyên của mục nội dung đa phương tiện mới.
NEW_QUESTION Một câu hỏi mới đã được thêm vào địa điểm này. Thông báo sẽ cung cấp tên tài nguyên của câu hỏi.
UPDATED_QUESTION Câu hỏi về vị trí đã được cập nhật. Thông báo sẽ cung cấp tên tài nguyên của câu hỏi.
NEW_ANSWER Một câu trả lời mới sẽ được thêm vào vị trí đó. Thông báo sẽ cung cấp tên tài nguyên của câu hỏi và câu trả lời.
UPDATED_ANSWER Đã cập nhật câu trả lời của vị trí. Thông báo sẽ cung cấp tên tài nguyên của câu hỏi và câu trả lời.
DUPLICATE_LOCATION Cho biết liệu trường vị trí trùng lặp của siêu dữ liệu vị trí có thay đổi hay không.
LOSS_OF_VOICE_OF_MERCHANT

Không dùng nữa: Di chuyển cách sử dụng hiện tại của giá trị này sang "VOICE_OF_MERCHANT_UPDATED" được mở rộng hơn.

VOICE_OF_MERCHANT_UPDATED Cho biết liệu vị trí có cập nhật trạng thái của Voice of Merchant (VOM) hay không. VOM cho biết liệu vị trí đó có ở trạng thái tốt hay không và người bán có quyền kiểm soát doanh nghiệp trên Google. Mọi nội dung chỉnh sửa đối với vị trí sẽ được áp dụng trên Maps sau khi vượt qua giai đoạn đánh giá. Hãy gọi GetVoiceOfMerchantState rpc để biết thêm chi tiết.

UpdateNotificationSettingRequest

Thông báo yêu cầu cho NotificationSettings.UpdateNotificationSettings.

Các trường
notification_setting

NotificationSetting

Bắt buộc. Chế độ cài đặt thông báo đã cập nhật.

update_mask

FieldMask

Bắt buộc. Các trường cụ thể cần được cập nhật. Trường có thể chỉnh sửa duy nhất là notification_setting.