Package google.shopping.merchant.notifications.v1beta

Index

NotificationsApiService

Service de gestion des abonnements aux notifications pour les marchands

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Crée un abonnement aux notifications pour un marchand. Les types d'abonnements aux notifications suivants peuvent coexister (par marchand en tant qu'abonné et par type d'événement): 1. Abonnement pour tous les comptes gérés + abonnement individuel 2. Plusieurs abonnements "partiels" pour des comptes gérés + abonnement individuel

Nous n'autorisons pas (par marchand en tant qu'abonné et par type d'événement): 1. plusieurs abonnements automatiques. 2. plusieurs abonnements "tous les comptes gérés" ; 3. tous les abonnements et les 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 la présentation d'OAuth 2.0.
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 la présentation d'OAuth 2.0.
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 la présentation d'OAuth 2.0.
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 la présentation d'OAuth 2.0.
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 la présentation d'OAuth 2.0.

Attribut

Énumération spécifiant l'attribut qui fait l'objet de modifications dans la ressource afin d'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 auquel appartient le 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. La name de l'abonnement aux notifications.

ListNotificationSubscriptionsRequest

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

Champs
parent

string

Obligatoire. Compte marchand qui possède les abonnements aux notifications. Format : accounts/{account}
page_size

int32

Nombre maximal d'abonnements aux notifications à afficher sur une page. La valeur par défaut de page_size est 100. La valeur maximale est 200. Les valeurs supérieures à 200 seront forcées en 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 qui a 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. Le name de la configuration de notification. Générées par Content API 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é chaque jour de l'événement spécifié pour tous les comptes gérés (il peut s'agir de sous-comptes ou d'autres comptes associés), y compris les nouveaux comptes.
target_account

string

Le 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 notifications n'est pas spécifié.
PRODUCT_STATUS_CHANGE Notification de changement de l'état d'un produit, par exemple lorsqu'il est refusé

ProductChange

Modification apportée au produit, y compris l'ancienne valeur, la nouvelle valeur, le code pays comme code régional et le contexte de création de rapports.

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 signalement ayant subi le changement (le cas échéant)

ProductStatusChangeMessage

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

Champs
changes[]

ProductChange

Un message pour décrire le changement apporté au produit
account

string

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

string

Le compte qui gère le compte du marchand peut être identique à la référence marchand s'il s'agit d'un compte individuel. Format : accounts/{service_provider_id}
resource_type

Resource

Ressource modifiée. Dans ce cas, il s'agit toujours de Product.
attribute

Attribute

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

string

ID produit.
resource

string

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

Ressource

Énumération spécifiant la ressource en cours de modification pour 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 qui doit être mise à jour.
update_mask

FieldMask

Liste des champs en cours de mise à jour.