Package google.shopping.merchant.notifications.v1beta

Indice

NotificationsApiService

Servizio per gestire le iscrizioni alle notifiche per i commercianti

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Crea un'iscrizione alle notifiche per un'attività commerciale. Per gli account autonomi o subaccount, l'attività può creare un abbonamento per se stessa. Per gli AMC, l'attività può creare un abbonamento per tutti gli account gestiti o per un subaccount specifico.

Consentiremo la coesistenza dei seguenti tipi di iscrizioni alle notifiche (per attività come abbonato per tipo di evento):

  1. Abbonamento per tutti gli account gestiti + abbonamento personale.

  2. Più abbonamenti "parziali" per account gestiti + abbonamento personale.

Non sono consentiti (per attività come abbonato per tipo di evento):

  1. Più abbonamenti personali.

  2. Più iscrizioni "tutti gli account gestiti".

  3. Abbonamento "Tutti gli account gestiti" e abbonamenti parziali contemporaneamente.

  4. Più abbonamenti parziali per lo stesso account di destinazione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica di OAuth 2.0.
DeleteNotificationSubscription

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

Consente di eliminare un abbonamento alle notifiche per un commerciante.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

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

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

Recupera le iscrizioni alle notifiche per un account.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica di OAuth 2.0.
ListNotificationSubscriptions

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

Recupera tutte le iscrizioni alle notifiche di un commerciante.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

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

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

Aggiorna un'iscrizione alle notifiche esistente per un commerciante.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica di OAuth 2.0.

Attributo

Enum per specificare l'attributo nella risorsa di cui viene inviata una notifica al commerciante.

Enum
ATTRIBUTE_UNSPECIFIED Attributo non specificato
STATUS Stato dell'entità modificata

CreateNotificationSubscriptionRequest

Messaggio di richiesta per il metodo CreateNotificationSubscription.

Campi
parent

string

Obbligatorio. L'account commerciante proprietario del nuovo abbonamento alle notifiche. Formato: accounts/{account}
notification_subscription

NotificationSubscription

Obbligatorio. L'iscrizione alle notifiche da creare.

DeleteNotificationSubscriptionRequest

Messaggio di richiesta per il metodo DeleteNotificationSubscription.

Campi
name

string

Obbligatorio. Il nome dell'abbonamento alle notifiche da eliminare.

GetNotificationSubscriptionRequest

Messaggio di richiesta per il metodo GetNotificationSubscription.

Campi
name

string

Obbligatorio. Il name dell'iscrizione alle notifiche.

ListNotificationSubscriptionsRequest

Messaggio di richiesta per il metodo ListNotificationSubscription.

Campi
parent

string

Obbligatorio. L'account commerciante proprietario delle iscrizioni alle notifiche. Formato: accounts/{account}
page_size

int32

Il numero massimo di iscrizioni alle notifiche da restituire in una pagina. Il valore predefinito per page_size è 100. Il valore massimo è 200. I valori superiori a 200 verranno forzati a 200.
page_token

string

Token (se fornito) per recuperare la pagina successiva. Tutti gli altri parametri devono corrispondere alla chiamata originale che ha fornito il token pagina.

ListNotificationSubscriptionsResponse

Messaggio di risposta per il metodo ListNotificationSubscription.

Campi
notification_subscriptions[]

NotificationSubscription

L'elenco delle iscrizioni alle notifiche richieste dal commerciante.
next_page_token

string

Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

NotificationSubscription

Rappresenta un abbonamento alle notifiche di proprietà di un account commerciante.

Campi
name

string

Solo output. Il name della configurazione di notifica. Generato dall'API Content al momento della creazione di un nuovo NotificationSubscription. account rappresenta l'ID commerciante del commerciante proprietario della configurazione. Formato: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event

NotificationEventType

L'evento per cui il commerciante vuole ricevere una notifica.
call_back_uri

string

URL da utilizzare per inviare la notifica al commerciante.

Campo unione interested_in.

interested_in può essere solo uno dei seguenti:
all_managed_accounts

bool

Se questo valore è true, all'account che effettua la richiesta viene inviata una notifica giornaliera dell'evento specificato per tutti gli account gestiti (possono essere subaccount o altri account collegati), inclusi gli account appena aggiunti.
target_account

string

Il name dell'account per cui vuoi ricevere le notifiche. Formato: accounts/{account}

NotificationEventType

Rappresenta il tipo di evento per cui il commerciante è interessato a ricevere notifiche.

Enum
NOTIFICATION_EVENT_TYPE_UNSPECIFIED Il tipo di evento Notifiche non è specificato.
PRODUCT_STATUS_CHANGE Notifica delle modifiche dello stato del prodotto, ad esempio quando il prodotto non viene approvato.

ProductChange

La modifica apportata al prodotto, inclusi il vecchio valore, il nuovo valore, il codice paese come codice regione e il contesto dei report.

Campi
old_value

string

Il vecchio valore della risorsa o dell'attributo modificato.
new_value

string

Il nuovo valore della risorsa o dell'attributo modificato.
region_code

string

Paesi interessati dalla modifica (se applicabile)
reporting_context

ReportingContextEnum

Contesti dei report che presentano la modifica (se applicabile)

ProductStatusChangeMessage

Il messaggio che il commerciante riceverà per la notifica dell'evento di variazione dello stato del prodotto

Campi
changes[]

ProductChange

Un messaggio per descrivere la modifica apportata al prodotto
account

string

L'account di destinazione proprietario dell'entità modificata. Formato : accounts/{merchant_id}
managing_account

string

L'account che gestisce l'account del commerciante può essere uguale all'ID commerciante se si tratta di un account autonomo. Formato : accounts/{service_provider_id}
resource_type

Resource

La risorsa che è cambiata, in questo caso sarà sempre Product.
attribute

Attribute

L'attributo nella risorsa che è stato modificato, in questo caso sarà sempre Status.
resource_id

string

L'ID prodotto.
resource

string

Il nome del prodotto. Formato: {product.name=accounts/{account}/products/{product}}

Risorsa

Enum per specificare la risorsa di cui viene inviata una notifica al commerciante.

Enum
RESOURCE_UNSPECIFIED Risorsa non specificata
PRODUCT Tipo di risorsa : prodotto

UpdateNotificationSubscriptionRequest

Messaggio di richiesta per il metodo UpdateNotificationSubscription.

Campi
notification_subscription

NotificationSubscription

Obbligatorio. La nuova versione dell'abbonamento alle notifiche da aggiornare.
update_mask

FieldMask

Elenco dei campi in fase di aggiornamento.