REST Resource: accounts.notificationsubscriptions
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: NotificationSubscription
Representa uma assinatura de notificação de uma conta de comerciante.
| Representação 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.
} |
| Campos |
name |
string
Apenas saída. O name da configuração de notificação. Gerado pela API Content após a criação de um novo NotificationSubscription. O account representa o ID do comerciante proprietário da configuração. Formato: accounts/{account}/notificationsubscriptions/{notificationSubscription}
|
registeredEvent |
enum (NotificationEventType)
O evento sobre o qual o comerciante quer receber notificações.
|
callBackUri |
string
URL a ser usado para enviar a notificação ao comerciante.
|
Campo de união interested_in. interested_in pode ser apenas de um dos tipos a seguir:
|
allManagedAccounts |
boolean
Se esse valor for verdadeiro, a conta solicitante será notificada sobre o evento especificado para todas as contas gerenciadas (podem ser subcontas ou outras contas vinculadas), incluindo as contas recém-adicionadas, diariamente.
|
targetAccount |
string
O name da conta para a qual você quer receber notificações. Formato: accounts/{account}
|
NotificationEventType
Representa o tipo de evento para o qual o comerciante quer receber notificações.
| Enums |
NOTIFICATION_EVENT_TYPE_UNSPECIFIED |
O tipo de evento de notificação não foi especificado. |
PRODUCT_STATUS_CHANGE |
Notificação de mudanças no status do produto, por exemplo, quando o produto é reprovado. |
Métodos |
|
|
Cria uma assinatura de notificação para uma empresa. |
|
|
Exclui uma assinatura de notificação de um comerciante. |
|
|
Recebe as assinaturas de notificação de uma conta. |
|
|
Recebe todas as assinaturas de notificação de um comerciante. |
|
|
Atualiza uma assinatura de notificação de um comerciante. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-11-24 UTC.
[null,null,["Última atualização 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. |"]]
