REST Resource: accounts.notificationsubscriptions

Recurso: NotificationSubscription

Representa uma assinatura de notificação que pertence a uma conta do 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 que tem a configuração. Formato: accounts/{account}/notificationsubscriptions/{notificationSubscription}

registeredEvent

enum (NotificationEventType)

O evento sobre o qual o comerciante quer ser notificado.

callBackUri

string

URL que 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 contas recém-adicionadas diariamente.

targetAccount

string

O name da conta sobre a qual você quer receber notificações. Formato: accounts/{account}

NotificationEventType

Representa o tipo de evento para o qual o comerciante está interessado em receber notificações.

Enums
NOTIFICATION_EVENT_TYPE_UNSPECIFIED O tipo de evento de notificações não foi especificado.
PRODUCT_STATUS_CHANGE Notificação de alterações no status do produto, por exemplo, quando ele é reprovado.

Métodos

create

Cria uma assinatura de notificação para um comerciante.

delete

Exclui a assinatura de notificação de um comerciante.

get

Recebe as inscrições de notificação de uma conta.

list

Recebe todas as inscrições de notificação de um comerciante.

patch

Atualiza uma assinatura de notificação existente de um comerciante.