Package google.shopping.merchant.notifications.v1beta

Índice

NotificationsApiService

Servicio para administrar las suscripciones a notificaciones de los comercios

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Crea una suscripción a notificaciones para un comercio. Permitiremos que existan juntos los siguientes tipos de suscripciones a notificaciones (por comercio como suscriptor por tipo de evento): 1. Suscripción para todas las cuentas administradas + suscripción propia 2. Múltiples suscripciones "parciales" para cuentas administradas + suscripción propia

No permitiremos (por comerciante como suscriptor por tipo de evento): 1. múltiples autosuscripciones. 2. múltiples suscripciones a “todas las cuentas administradas”. 3. Todas las suscripciones y parciales al mismo tiempo. 4. Suscripciones parciales múltiples para la misma cuenta de destino

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
DeleteNotificationSubscription

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

Borra una suscripción a notificaciones de un comercio.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
GetNotificationSubscription

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

Obtiene las suscripciones a notificaciones de una cuenta.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
ListNotificationSubscriptions

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

Obtiene todas las suscripciones a notificaciones de un comercio.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
UpdateNotificationSubscription

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

Actualiza una suscripción a notificaciones existente de un comercio.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

Atributo

Es una enumeración que especifica el atributo en el recurso que se cambiará para notificar al comercio.

Enumeradores
ATTRIBUTE_UNSPECIFIED Atributo sin especificar
STATUS Estado de la entidad modificada

CreateNotificationSubscriptionRequest

Mensaje de solicitud para el método CreateNotificationSubscription.

Campos
parent

string

Obligatorio. La cuenta del comerciante propietaria de la nueva suscripción a notificaciones Formato: accounts/{account}
notification_subscription

NotificationSubscription

Obligatorio. La suscripción a notificaciones que se creará.

DeleteNotificationSubscriptionRequest

Mensaje de solicitud para el método DeleteNotificationSubscription.

Campos
name

string

Obligatorio. El nombre de la suscripción a notificaciones que se borrará.

GetNotificationSubscriptionRequest

Mensaje de solicitud para el método GetNotificationSubscription.

Campos
name

string

Obligatorio. El name de la suscripción a la notificación.

ListNotificationSubscriptionsRequest

Mensaje de solicitud para el método ListNotificationSubscription.

Campos
parent

string

Obligatorio. La cuenta del comerciante propietaria de las suscripciones a notificaciones Formato: accounts/{account}
page_size

int32

La cantidad máxima de suscripciones a notificaciones que se mostrarán en una página. El valor predeterminado para page_size es 100. El valor máximo es 200. Los valores superiores a 200 se convertirán en 200.
page_token

string

Es el token (si se proporciona) para recuperar la página siguiente. Todos los demás parámetros deben coincidir con la llamada original que proporcionó el token de la página.

ListNotificationSubscriptionsResponse

Mensaje de respuesta para el método ListNotificationSubscription.

Campos
notification_subscriptions[]

NotificationSubscription

Es la lista de suscripciones a notificaciones que solicita el comercio.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

NotificationSubscription

Representa una suscripción a notificaciones que pertenece a una cuenta de comerciante.

Campos
name

string

Solo salida. El name de la configuración de notificaciones. Lo genera Content API cuando se crea un NotificationSubscription nuevo. El account representa el ID del comercio al que pertenece la configuración. Formato: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event

NotificationEventType

El evento sobre el que el comercio desea recibir notificaciones
call_back_uri

string

URL que se usará para enviar la notificación al comercio.

Campo de unión interested_in.

interested_in puede ser una de las siguientes opciones:
all_managed_accounts

bool

Si este valor es verdadero, la cuenta solicitante recibe una notificación a diario del evento especificado para todas las cuentas administradas (pueden ser cuentas secundarias u otras cuentas vinculadas), incluidas las cuentas agregadas recientemente.
target_account

string

El name de la cuenta de la que quieres recibir notificaciones. Formato: accounts/{account}

NotificationEventType

Representa el tipo de evento para el que el comercio está interesado en recibir notificaciones.

Enumeradores
NOTIFICATION_EVENT_TYPE_UNSPECIFIED El tipo de evento de notificaciones no está especificado.
PRODUCT_STATUS_CHANGE Notificación sobre cambios en el estado del producto, por ejemplo, cuando se rechaza el producto

ProductChange

El cambio que se produjo en el producto, incluidos el valor anterior, el valor nuevo, el código de país como código regional y el contexto de los informes.

Campos
old_value

string

El valor anterior del recurso o atributo que se modificó.
new_value

string

El valor nuevo del recurso o atributo que se modificó.
region_code

string

Países donde se realizó el cambio (si corresponde)
reporting_context

ReportingContextEnum

Contextos de informes que tienen el cambio (si corresponde)

ProductStatusChangeMessage

El mensaje que recibirá el comercio para notificar sobre el evento de cambio de estado del producto

Campos
changes[]

ProductChange

Un mensaje para describir el cambio que se produjo en el producto
account

string

La cuenta de destino propietaria de la entidad que cambió. Formato : accounts/{merchant_id}
managing_account

string

La cuenta que administra la cuenta del comercio puede ser la misma que el ID del comerciante si es una cuenta independiente. Formato : accounts/{service_provider_id}
resource_type

Resource

El recurso que cambió, en este caso, siempre será Product.
attribute

Attribute

El atributo que cambió en el recurso; en este caso, siempre será Status.
resource_id

string

Es el ID del producto.
resource

string

Es el nombre del producto. Formato: {product.name=accounts/{account}/products/{product}}

Recurso

Es una enumeración que especifica el recurso que se cambiará para notificar al comercio.

Enumeradores
RESOURCE_UNSPECIFIED Recurso no especificado
PRODUCT Resource type : product

UpdateNotificationSubscriptionRequest

Mensaje de solicitud para el método UpdateNotificationSubscription.

Campos
notification_subscription

NotificationSubscription

Obligatorio. La nueva versión de la suscripción a la notificación que se debe actualizar.
update_mask

FieldMask

Lista de campos que se están actualizando.