Package google.shopping.merchant.notifications.v1beta

Index

NotificationsApiService

Service permettant aux marchands de gérer leurs abonnements aux notifications

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Crée un abonnement aux notifications pour un établissement. Pour les comptes autonomes ou les sous-comptes, l'entreprise peut créer un abonnement pour elle-même. Pour les MC, l'entreprise peut créer un abonnement pour tous les comptes gérés ou pour un sous-compte spécifique.

Nous autoriserons les types d'abonnements aux notifications suivants à coexister (par entreprise en tant qu'abonné et par type d'événement):

  1. Abonnement pour tous les comptes gérés et abonnement pour vous-même.

  2. Plusieurs abonnements "partiels" pour les comptes gérés, plus un abonnement pour vous-même.

Nous n'autorisons pas (par entreprise en tant qu'abonné et par type d'événement):

  1. Plusieurs abonnements personnels

  2. Plusieurs abonnements "Tous les comptes gérés".

  3. Abonnement "Tous les comptes gérés" et abonnements partiels en même temps

  4. Plusieurs abonnements partiels pour le même compte cible

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez OAuth 2.0 Overview.
DeleteNotificationSubscription

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

Supprime un abonnement aux notifications pour un marchand.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez OAuth 2.0 Overview.
GetNotificationSubscription

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

Récupère les abonnements aux notifications pour un compte.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez OAuth 2.0 Overview.
ListNotificationSubscriptions

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

Récupère tous les abonnements aux notifications d'un marchand.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez OAuth 2.0 Overview.
UpdateNotificationSubscription

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

Met à jour un abonnement aux notifications existant pour un marchand.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez OAuth 2.0 Overview.

Attribut

Énumération permettant de spécifier l'attribut de la ressource qui est modifié pour en informer le marchand.

Enums
ATTRIBUTE_UNSPECIFIED Attribut non spécifié
STATUS État de l'entité modifiée

CreateNotificationSubscriptionRequest

Message de requête pour la méthode CreateNotificationSubscription.

Champs
parent

string

Obligatoire. Compte marchand propriétaire du nouvel abonnement aux notifications. Format : accounts/{account}
notification_subscription

NotificationSubscription

Obligatoire. Abonnement aux notifications à créer.

DeleteNotificationSubscriptionRequest

Message de requête pour la méthode DeleteNotificationSubscription.

Champs
name

string

Obligatoire. Nom de l'abonnement aux notifications à supprimer.

GetNotificationSubscriptionRequest

Message de requête pour la méthode GetNotificationSubscription.

Champs
name

string

Obligatoire. name de l'abonnement aux notifications.

ListNotificationSubscriptionsRequest

Message de requête pour la méthode ListNotificationSubscription.

Champs
parent

string

Obligatoire. Compte marchand propriétaire des abonnements aux notifications. Format : accounts/{account}
page_size

int32

Nombre maximal d'abonnements aux notifications à renvoyer sur une page. La valeur par défaut de page_size est 100. La valeur maximale est 200. Les valeurs supérieures à 200 seront réduites à 200.
page_token

string

Jeton (le cas échéant) permettant de récupérer la page suivante. Tous les autres paramètres doivent correspondre à l'appel d'origine ayant fourni le jeton de page.

ListNotificationSubscriptionsResponse

Message de réponse pour la méthode ListNotificationSubscription.

Champs
notification_subscriptions[]

NotificationSubscription

Liste des abonnements aux notifications demandés par le marchand.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

NotificationSubscription

Représente un abonnement aux notifications appartenant à un compte marchand.

Champs
name

string

Uniquement en sortie. name de la configuration de notification. Généré par l'API Content lors de la création d'un NotificationSubscription. account représente l'ID du marchand propriétaire de la configuration. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event

NotificationEventType

Événement pour lequel le marchand souhaite être averti.
call_back_uri

string

URL à utiliser pour envoyer la notification au marchand.

Champ d'union interested_in.

interested_in ne peut être qu'un des éléments suivants :
all_managed_accounts

bool

Si cette valeur est définie sur "true", le compte à l'origine de la demande est informé de l'événement spécifié pour tous les comptes gérés (sous-comptes ou autres comptes associés), y compris les comptes nouvellement ajoutés, sur une base quotidienne.
target_account

string

name du compte pour lequel vous souhaitez recevoir des notifications. Format : accounts/{account}

NotificationEventType

Représente le type d'événement pour lequel le marchand souhaite recevoir des notifications.

Enums
NOTIFICATION_EVENT_TYPE_UNSPECIFIED Le type d'événement de notification n'est pas spécifié.
PRODUCT_STATUS_CHANGE Notification des changements d'état des produits, par exemple lorsqu'un produit est refusé.

ProductChange

Modification apportée au produit, y compris l'ancienne valeur, la nouvelle valeur, le code pays en tant que code de région et le contexte de création du rapport.

Champs
old_value

string

Ancienne valeur de la ressource ou de l'attribut modifiés.
new_value

string

Nouvelle valeur de la ressource ou de l'attribut modifiés.
region_code

string

Pays concernés par la modification (le cas échéant)
reporting_context

ReportingContextEnum

Contextes de création de rapports concernés par le changement (le cas échéant)

ProductStatusChangeMessage

Message que le marchand recevra pour l'informer d'un événement de changement d'état du produit

Champs
changes[]

ProductChange

Message décrivant le changement apporté au produit
account

string

Compte cible propriétaire de l'entité modifiée. Format : accounts/{merchant_id}
managing_account

string

Le compte qui gère le compte du marchand peut être le même que l'ID du marchand s'il s'agit d'un compte autonome. Format : accounts/{service_provider_id}
resource_type

Resource

La ressource qui a changé, dans ce cas, il s'agit toujours de Product.
attribute

Attribute

Attribut de la ressource qui a changé. Dans ce cas, il s'agit toujours de Status.
resource_id

string

ID du produit.
resource

string

Nom du produit. Format : {product.name=accounts/{account}/products/{product}}
expiration_time

Timestamp

Date d'expiration du produit. Ce champ ne sera pas défini si la notification est envoyée pour un événement de suppression de produit.

Ressource

Énumération permettant de spécifier la ressource modifiée pour en informer le marchand.

Enums
RESOURCE_UNSPECIFIED Ressource non spécifiée
PRODUCT Type de ressource : produit

UpdateNotificationSubscriptionRequest

Message de requête pour la méthode UpdateNotificationSubscription.

Champs
notification_subscription

NotificationSubscription

Obligatoire. Nouvelle version de l'abonnement aux notifications à mettre à jour.
update_mask

FieldMask

Liste des champs mis à jour.