Package google.mybusiness.notifications.v1

Indice

NotificationSettings

Questo servizio consente agli utenti di gestire le impostazioni di notifica per i propri account aziendali.

GetNotificationSetting

rpc GetNotificationSetting(GetNotificationSettingRequest) returns (NotificationSetting)

Restituisce le impostazioni di notifica Pub/Sub per l'account.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
UpdateNotificationSetting

rpc UpdateNotificationSetting(UpdateNotificationSettingRequest) returns (NotificationSetting)

Configura l'impostazione di notifica Pub/Sub per l'account che indica a Google su quale argomento inviare le notifiche Pub/Sub. Utilizza il campo notification_types di notification_setting per manipolare gli eventi a cui un account vuole iscriversi.

Un account avrà una sola risorsa di impostazione delle notifiche e può essere impostato un solo argomento Pub/Sub. Per eliminare l'impostazione, aggiorna con un valore notification_types vuoto

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

ErrorCode

Tutti i codici di errore restituiti dall'API.

Enum
ERROR_CODE_UNSPECIFIED Codice di errore mancante.
SHARES_PUBSUB_TOPIC_MESSAGE_ACROSS_VERSIONS Il nome dell'argomento Pub/Sub fornito nel rpc "updateNotificationSetting" viene utilizzato da altre versioni di questa API. Fornisci un nuovo nome per l'argomento per ridurre il problema.
PUBLISH_PERMISSIONS_MISSING_FOR_PUBSUB_TOPIC Il nome dell'argomento Pub/Sub fornito per l'impostazione di notifica di aggiornamento non dispone delle autorizzazioni di pubblicazione per l'utente.
INVALID_PUBSUB_TOPIC Il nome dell'argomento Pub/Sub specificato per l'impostazione di notifica di aggiornamento non è valido.

GetNotificationSettingRequest

Messaggio di richiesta per NotificationSettings.GetNotificationSettings.

Campi
name

string

Obbligatorio. Il nome della risorsa dell'impostazione di notifica che stiamo cercando di recuperare.

NotificationSetting

Un argomento di Google Pub/Sub in cui è possibile pubblicare notifiche quando una sede viene aggiornata o ha una nuova recensione. Sarà presente una sola risorsa di impostazione delle notifiche per account.

Campi
name

string

Obbligatorio. Il nome della risorsa a cui si riferisce questa impostazione. Il formato è accounts/{account_id}/notificationSetting.
pubsub_topic

string

Campo facoltativo. L'argomento Google Pub/Sub che riceverà notifiche quando le località gestite da questo account vengono aggiornate. Se il criterio non viene configurato, non verranno pubblicate notifiche.

L'account mybusiness-api-pubsub@system.gserviceaccount.com deve disporre almeno delle autorizzazioni di pubblicazione per l'argomento Pub/Sub.
notification_types[]

NotificationType

I tipi di notifiche che verranno inviati all'argomento Pub/Sub. Per interrompere completamente la ricezione delle notifiche, utilizza NotificationSettings.UpdateNotificationSetting con un parametro notification_types vuoto o di impostare pubsub_topic su una stringa vuota.

NotificationType

Tipo di notifica inviata all'argomento Pub/Sub.

Enum
NOTIFICATION_TYPE_UNSPECIFIED Nessun tipo di notifica. Non corrisponderà ad alcuna notifica.
GOOGLE_UPDATE La sede presenta aggiornamenti Google per la revisione. Il campo location_name nella notifica fornirà il nome risorsa della località con gli aggiornamenti Google.
NEW_REVIEW È stata aggiunta una nuova recensione alla sede. Il campo review_name nella notifica fornirà il nome della risorsa della recensione aggiunta, mentre location_name avrà il nome della risorsa della località.
UPDATED_REVIEW È stata aggiornata una recensione sulla sede. Il campo review_name nella notifica fornirà il nome della risorsa della recensione aggiunta, mentre location_name avrà il nome della risorsa della località.
NEW_CUSTOMER_MEDIA Un nuovo elemento multimediale è stato aggiunto alla posizione da un utente di Google Maps. La notifica fornirà il nome della risorsa del nuovo elemento multimediale.
NEW_QUESTION Viene aggiunta una nuova domanda alla sede. La notifica indicherà il nome della risorsa in questione.
UPDATED_QUESTION Viene aggiornata una domanda relativa alla posizione. La notifica indicherà il nome della risorsa in questione.
NEW_ANSWER Una nuova risposta viene aggiunta alla posizione. La notifica fornirà il nome della risorsa della domanda e della risposta.
UPDATED_ANSWER Viene aggiornata una risposta sulla posizione. La notifica fornirà il nome della risorsa della domanda e della risposta.
DUPLICATE_LOCATION Indica se è stata apportata una modifica al campo della località duplicato dei metadati della località.
LOSS_OF_VOICE_OF_MERCHANT

Deprecato: migra gli utilizzi esistenti di questo valore al tipo più espanso "VOICE_OF_MERCHANT_UPDATED".
VOICE_OF_MERCHANT_UPDATED Indica se lo stato di Voice of Merchant (VOM) per la sede è aggiornato. VOM stabilisce se la sede è in regola e se il commerciante ha il controllo dell'attività su Google. Eventuali modifiche apportate alla sede verranno propagate a Maps dopo aver superato la fase di revisione. Per ulteriori dettagli, chiama GetVoiceOfMerchantState rpc.

UpdateNotificationSettingRequest

Messaggio di richiesta per NotificationSettings.UpdateNotificationSettings.

Campi
notification_setting

NotificationSetting

Obbligatorio. Le impostazioni di notifica aggiornate.
update_mask

FieldMask

Obbligatorio. I campi specifici da aggiornare. L'unico campo modificabile è notification_setting.