REST Resource: accounts.notificationsubscriptions
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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 |
|
|
Crée un abonnement aux notifications pour un établissement. |
|
|
Supprime un abonnement aux notifications pour un marchand. |
|
|
Récupère les abonnements aux notifications pour un compte. |
|
|
Récupère tous les abonnements aux notifications d'un marchand. |
|
|
Met à jour un abonnement aux notifications existant pour un marchand. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2024/11/24 (UTC).
[null,null,["Dernière mise à jour le 2024/11/24 (UTC)."],[[["\u003cp\u003eNotificationSubscription enables merchants to receive notifications about specific events related to their account.\u003c/p\u003e\n"],["\u003cp\u003eMerchants can configure which events trigger notifications, such as product status changes, and provide a callback URL to receive them.\u003c/p\u003e\n"],["\u003cp\u003eThe API offers methods to create, delete, retrieve, and update notification subscriptions.\u003c/p\u003e\n"],["\u003cp\u003eIt allows merchants to receive notifications for events occurring on all managed accounts or a specific target account.\u003c/p\u003e\n"]]],["Merchants can create `NotificationSubscription` resources to receive updates about specific events. Each subscription includes a `name`, a `registeredEvent` (e.g., `PRODUCT_STATUS_CHANGE`), and a `callBackUri` for notification delivery. Merchants can specify if they want to receive events regarding `allManagedAccounts` or a `targetAccount`. Available methods include `create`, `delete`, `get`, `list`, and `patch` for managing these subscriptions. Notification event type can be `PRODUCT_STATUS_CHANGE` or `NOTIFICATION_EVENT_TYPE_UNSPECIFIED`.\n"],null,["# REST Resource: accounts.notificationsubscriptions\n\n- [Resource: NotificationSubscription](#NotificationSubscription)\n - [JSON representation](#NotificationSubscription.SCHEMA_REPRESENTATION)\n- [NotificationEventType](#NotificationEventType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: NotificationSubscription\n----------------------------------\n\nRepresents a notification subscription owned by a Merchant account.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"registeredEvent\": enum (/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions#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`. } ``` |\n\n| Fields ||\n|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notificationSubscription}` |\n| `registeredEvent` | `enum (`[NotificationEventType](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions#NotificationEventType)`)` The event that the merchant wants to be notified about. |\n| `callBackUri` | `string` URL to be used to push the notification to the merchant. |\n| Union field `interested_in`. `interested_in` can be only one of the following: ||\n| `allManagedAccounts` | `boolean` If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. |\n| `targetAccount` | `string` The `name` of the account you want to receive notifications for. Format: `accounts/{account}` |\n\nNotificationEventType\n---------------------\n\nRepresents the event type that the merchant is interested in receiving notifications for.\n\n| Enums ||\n|---------------------------------------|---------------------------------------------------------------------------------------|\n| `NOTIFICATION_EVENT_TYPE_UNSPECIFIED` | Notifications event type is unspecified. |\n| `PRODUCT_STATUS_CHANGE` | Notification of product status changes, for example when product becomes disapproved. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|\n| ### [create](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions/create) | Creates a notification subscription for a business. |\n| ### [delete](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions/delete) | Deletes a notification subscription for a merchant. |\n| ### [get](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions/get) | Gets notification subscriptions for an account. |\n| ### [list](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions/list) | Gets all the notification subscriptions for a merchant. |\n| ### [patch](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions/patch) | Updates an existing notification subscription for a merchant. |"]]
