REST Resource: accounts.notificationsubscriptions

Ressource: NotificationSubscription

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

Représentation JSON
{
  "name": string,
  "registeredEvent": enum (NotificationEventType),
  "callBackUri": string,

  // Union field interested_in can be only one of the following:
  "allManagedAccounts": boolean,
  "targetAccount": string
  // End of list of possible types for union field interested_in.
}
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/{notificationSubscription}

registeredEvent

enum (NotificationEventType)

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

callBackUri

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 :

allManagedAccounts

boolean

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.

targetAccount

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é.

Méthodes

create

Crée un abonnement aux notifications pour un établissement.

delete

Supprime un abonnement aux notifications pour un marchand.

get

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

list

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

patch

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