Package google.shopping.merchant.notifications.v1beta

Índice

NotificationsApiService

Serviço para gerenciar assinaturas de notificações para comerciantes

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Cria uma assinatura de notificação para uma empresa. Para contas independentes ou subcontas, a empresa pode criar uma assinatura para si mesma. Para MCAs, a empresa pode criar uma assinatura para todas as contas gerenciadas ou para uma subconta específica.

Vamos permitir que os seguintes tipos de assinaturas de notificação existam juntos (por empresa como assinante por tipo de evento):

  1. Assinatura para todas as contas gerenciadas + assinatura para você.

  2. Várias assinaturas "parciais" para contas gerenciadas + assinatura para si mesmo.

Não permitimos (por empresa como assinante por tipo de evento):

  1. Várias assinaturas próprias.

  2. Várias assinaturas de "todas as contas gerenciadas".

  3. Assinatura "Todas as contas gerenciadas" e assinaturas 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 uma 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 assinaturas 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 assinaturas 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 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 assinatura de notificação a ser criada.

DeleteNotificationSubscriptionRequest

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

Campos
name

string

Obrigatório. O nome da assinatura de notificação a ser excluída.

GetNotificationSubscriptionRequest

Solicita uma mensagem para o método GetNotificationSubscription.

Campos
name

string

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

ListNotificationSubscriptionsRequest

Solicita mensagem 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 assinaturas de notificação 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 em 200.
page_token

string

Token (se fornecido) para recuperar a página seguinte. 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 de uma conta de 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 proprietário da configuração. Formato: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event

NotificationEventType

O evento sobre o qual o comerciante quer receber notificações.
call_back_uri

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:
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 as contas recém-adicionadas, diariamente.
target_account

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.

ProductChange

A mudança que aconteceu no produto, incluindo o valor antigo, o valor novo, o código do país como o código da região e o 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 têm a mudança (se aplicável)
reporting_context

ReportingContextEnum

Contextos de relatórios que têm a mudança (se aplicável)

ProductStatusChangeMessage

A mensagem que o comerciante vai receber para notificar sobre o evento de mudança de status do produto

Campos
changes[]

ProductChange

Uma mensagem para descrever a mudança que aconteceu 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 do comerciante. Pode ser o mesmo ID do comerciante se for uma conta independente. Formato : accounts/{service_provider_id}
resource_type

Resource

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

Attribute

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

string

O ID do produto.
resource

string

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

Timestamp

O tempo de expiração do produto. Esse campo não será definido se a notificação for enviada para um evento de exclusão de produto.

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

Solicita uma mensagem para o método UpdateNotificationSubscription.

Campos
notification_subscription

NotificationSubscription

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

FieldMask

Lista de campos que estão sendo atualizados.