Package google.shopping.merchant.notifications.v1beta

Índice

NotificationsApiService

Serviço para gerenciar assinaturas de notificação para comerciantes

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Cria uma assinatura de notificação para um comerciante. Os seguintes tipos de inscrições para notificações poderão ser usados juntos (por comerciante como assinante e tipo de evento): 1. Assinatura para todas as contas gerenciadas + assinatura para si mesmo 2. Várias assinaturas "parciais" para contas gerenciadas + assinatura para você

não permitiremos (por comerciante como assinante por tipo de evento): 1. Várias assinaturas próprias. 2. Várias assinaturas de "todas as contas gerenciadas". 3. todas as assinaturas e parciais ao mesmo tempo. 4. Várias assinaturas parciais para a mesma conta de destino

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
DeleteNotificationSubscription

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
GetNotificationSubscription

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListNotificationSubscriptions

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateNotificationSubscription

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

Atributo

Enumeração para especificar o atributo no recurso que está sendo alterado para notificar o comerciante.

Enums
ATTRIBUTE_UNSPECIFIED Atributo não especificado
STATUS Status da entidade alterada

CreateNotificationSubscriptionRequest

Mensagem de solicitação para o método CreateNotificationSubscription.

Campos
parent

string

Obrigatório. A conta do comerciante proprietária da nova assinatura de notificação. Formato: accounts/{account}
notification_subscription

NotificationSubscription

Obrigatório. A inscrição de notificação a ser criada.

DeleteNotificationSubscriptionRequest

Mensagem de solicitação para o método DeleteNotificationSubscription.

Campos
name

string

Obrigatório. O nome da inscrição de notificação que será excluída.

GetNotificationSubscriptionRequest

Mensagem de solicitação para o método GetNotificationSubscription.

Campos
name

string

Obrigatório. O name da inscrição de notificação.

ListNotificationSubscriptionsRequest

Mensagem de solicitação para o método ListNotificationSubscription.

Campos
parent

string

Obrigatório. A conta do comerciante proprietária das assinaturas de notificação. Formato: accounts/{account}
page_size

int32

O número máximo de inscrições de notificação a serem retornadas em uma página. O valor padrão de page_size é 100. O valor máximo é 200. Valores acima de 200 serão convertidos para 200.
page_token

string

Token (se fornecido) para recuperar a página subsequente. Todos os outros parâmetros precisam corresponder à chamada original que forneceu o token da página.

ListNotificationSubscriptionsResponse

Mensagem de resposta para o método ListNotificationSubscription.

Campos
notification_subscriptions[]

NotificationSubscription

A lista de assinaturas de notificação solicitadas pelo comerciante.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

NotificationSubscription

Representa uma assinatura de notificação que pertence a uma conta do comerciante.

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/{notification_subscription}
registered_event

NotificationEventType

O evento sobre o qual o comerciante quer ser notificado.
call_back_uri

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:
all_managed_accounts

bool

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

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.

ProductChange

A mudança que ocorreu no produto, incluindo valor antigo, valor novo, código do país como código de região e contexto do relatório.

Campos
old_value

string

O valor antigo do recurso ou atributo alterado.
new_value

string

O novo valor do recurso ou atributo alterado.
region_code

string

Países que tiveram a mudança (se aplicável)
reporting_context

ReportingContextEnum

Contextos de relatórios que mudaram (se aplicável)

ProductStatusChangeMessage

A mensagem que o comerciante receberá para notificar sobre o evento de alteração do status do produto

Campos
changes[]

ProductChange

Uma mensagem para descrever a mudança que ocorreu no produto.
account

string

A conta de destino que é proprietária da entidade que foi alterada. Formato : accounts/{merchant_id}
managing_account

string

A conta que gerencia a conta do comerciante pode ser igual ao ID do comerciante se for independente. Formato : accounts/{service_provider_id}
resource_type

Resource

O recurso que mudou. Neste caso, será sempre Product.
attribute

Attribute

O atributo no recurso que mudou. Neste caso, será sempre Status.
resource_id

string

O ID do produto.
resource

string

O nome do produto. Formato: {product.name=accounts/{account}/products/{product}}

Recurso

Enumeração para especificar o recurso que está sendo alterado para notificar o comerciante.

Enums
RESOURCE_UNSPECIFIED Recurso não especificado
PRODUCT Tipo de recurso : produto

UpdateNotificationSubscriptionRequest

Mensagem de solicitação para o método UpdateNotificationSubscription.

Campos
notification_subscription

NotificationSubscription

Obrigatório. A nova versão da inscrição de notificação que deve ser atualizada.
update_mask

FieldMask

Lista de campos sendo atualizados.