Package google.mybusiness.notifications.v1

색인

NotificationSettings

이 서비스를 사용하면 사용자가 비즈니스 계정의 알림 설정을 관리할 수 있습니다.

GetNotificationSetting

rpc GetNotificationSetting(GetNotificationSettingRequest) returns (NotificationSetting)

계정의 Pub/Sub 알림 설정을 반환합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.
UpdateNotificationSetting

rpc UpdateNotificationSetting(UpdateNotificationSettingRequest) returns (NotificationSetting)

Google에 Pub/Sub 알림을 보낼 주제를 알리는 계정의 Pub/Sub 알림 설정을 설정합니다. notification_setting의 notification_types 필드를 사용하여 계정에서 구독하려는 이벤트를 조작할 수 있습니다.

계정에는 하나의 알림 설정 리소스만 있으며 Pub/Sub 주제는 1개만 설정할 수 있습니다. 설정을 삭제하려면 비어 있는 notification_types로 업데이트하세요.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.

ErrorCode

API에서 반환된 모든 오류 코드입니다.

열거형
ERROR_CODE_UNSPECIFIED 오류 코드가 누락되었습니다.
SHARES_PUBSUB_TOPIC_MESSAGE_ACROSS_VERSIONS 'updateNotificationSetting' RPC에 제공된 게시/구독 주제 이름이 이 API의 다른 버전에서 사용되고 있습니다. 이 문제를 완화할 수 있도록 새 주제 이름을 입력하세요.
PUBLISH_PERMISSIONS_MISSING_FOR_PUBSUB_TOPIC 업데이트 알림 설정에 제공된 Pub/Sub 주제 이름에 사용자의 게시 권한이 없습니다.
INVALID_PUBSUB_TOPIC 업데이트 알림 설정에 제공된 Pub/Sub 주제 이름이 잘못되었습니다.

GetNotificationSettingRequest

NotificationSettings.GetNotificationSettings 요청 메시지입니다.

필드
name

string

필수 항목입니다. 가져오려는 알림 설정의 리소스 이름입니다.

NotificationSetting

위치가 업데이트되거나 새 리뷰가 있으면 알림을 게시할 수 있는 Google Pub/Sub 주제입니다. 알림 설정 리소스는 계정당 하나만 있습니다.

필드
name

string

필수 항목입니다. 이 설정이 적용되는 리소스 이름입니다. 형식은 accounts/{account_id}/notificationSetting입니다.
pubsub_topic

string

선택사항입니다. 이 계정에서 관리하는 위치가 업데이트되면 알림을 수신할 Google Pub/Sub 주제입니다. 설정하지 않으면 알림이 게시되지 않습니다.

mybusiness-api-pubsub@system.gserviceaccount.com 계정에는 최소한 Pub/Sub 주제에 대한 게시 권한이 있어야 합니다.
notification_types[]

NotificationType

Pub/Sub 주제로 전송될 알림 유형입니다. 알림 수신을 완전히 중지하려면 notification_types가 비어 있는 NotificationSettings.UpdateNotificationSetting을 사용하거나 pubsub_topic을 빈 문자열로 설정하세요.

NotificationType

Pub/Sub 주제로 전송되는 알림 유형입니다.

열거형
NOTIFICATION_TYPE_UNSPECIFIED 알림 유형이 없습니다. 알림과 일치하지 않습니다.
GOOGLE_UPDATE 위치에 검토할 Google 업데이트가 있습니다. 알림의 location_name 입력란에는 Google 업데이트가 포함된 위치의 리소스 이름이 표시됩니다.
NEW_REVIEW 위치에 새 리뷰가 추가되었습니다. 알림의 review_name 입력란은 추가된 리뷰의 리소스 이름을 제공하며 location_name은 위치의 리소스 이름을 갖습니다.
UPDATED_REVIEW 위치에 대한 리뷰가 업데이트되었습니다. 알림의 review_name 입력란은 추가된 리뷰의 리소스 이름을 제공하며 location_name은 위치의 리소스 이름을 갖습니다.
NEW_CUSTOMER_MEDIA Google 지도 사용자가 위치에 새 미디어 항목을 추가했습니다. 알림에서 새 미디어 항목의 리소스 이름을 제공합니다.
NEW_QUESTION 새 질문이 위치에 추가됩니다. 알림에 질문의 리소스 이름이 표시됩니다.
UPDATED_QUESTION 위치에 관한 질문이 업데이트되었습니다. 알림에 질문의 리소스 이름이 표시됩니다.
NEW_ANSWER 새 답변이 위치에 추가됩니다. 알림에 질문과 답변의 리소스 이름이 표시됩니다.
UPDATED_ANSWER 위치의 답변이 업데이트됩니다. 알림에 질문과 답변의 리소스 이름이 표시됩니다.
DUPLICATE_LOCATION 위치 메타데이터의 중복 위치 필드가 변경되었는지 여부를 나타냅니다.
LOSS_OF_VOICE_OF_MERCHANT

지원 중단됨: 이 값의 기존 사용을 더 확장된 'VOICE_OF_MERCHANT_UPDATED'로 이전합니다.
VOICE_OF_MERCHANT_UPDATED 위치에 판매자 음성 (VOM) 상태가 업데이트되었는지 여부를 나타냅니다. VOM은 위치가 양호한지와 판매자가 Google에서 비즈니스를 관리하는지 여부를 결정합니다. 위치에 대한 모든 수정사항은 검토 단계를 통과한 후 지도에 적용됩니다. 자세한 내용을 보려면 GetVoiceOfMerchantState RPC를 호출하세요.

UpdateNotificationSettingRequest

NotificationSettings.UpdateNotificationSettings 요청 메시지입니다.

필드
notification_setting

NotificationSetting

필수 항목입니다. 업데이트된 알림 설정
update_mask

FieldMask

필수 항목입니다. 업데이트해야 하는 특정 필드 수정 가능한 유일한 필드는 notification_setting입니다.