Package google.shopping.merchant.notifications.v1beta

Índice

• NotificationsApiService (interfaz)
• Attribute (enumeración)
• CreateNotificationSubscriptionRequest (mensaje)
• DeleteNotificationSubscriptionRequest (mensaje)
• GetNotificationSubscriptionRequest (mensaje)
• ListNotificationSubscriptionsRequest (mensaje)
• ListNotificationSubscriptionsResponse (mensaje)
• NotificationSubscription (mensaje)
• NotificationSubscription.NotificationEventType (enumeración)
• ProductChange (mensaje)
• ProductStatusChangeMessage (mensaje)
• Resource (enumeración)
• UpdateNotificationSubscriptionRequest (mensaje)

NotificationsApiService

Servicio para administrar suscripciones a notificaciones de comercios

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription) Crea una suscripción a notificaciones para una empresa. En el caso de las cuentas independientes o secundarias, la empresa puede crear una suscripción por su cuenta. En el caso de las MCA, la empresa puede crear una suscripción para todas las cuentas administradas o para una cuenta secundaria específica. Permitiremos que los siguientes tipos de suscripciones a notificaciones coexistan (por empresa como suscriptor por tipo de evento): Suscripción para todas las cuentas administradas + suscripción personal Varias suscripciones "parciales" para cuentas administradas + suscripción personal No permitiremos lo siguiente (por empresa como suscriptor por tipo de evento): Varias suscripciones propias Varias suscripciones a "todas las cuentas administradas" La suscripción a “Todas las cuentas administradas” y las suscripciones parciales al mismo tiempo Varias suscripciones parciales 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 suscripciones a notificaciones para 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 para especificar el atributo del recurso que se cambiará para notificar al comercio.

Enumeraciones
ATTRIBUTE_UNSPECIFIED	Atributo no especificado
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 la notificación que se creará.

DeleteNotificationSubscriptionRequest

Es un mensaje de solicitud para el método DeleteNotificationSubscription.

Campos
name	string Obligatorio. Es el nombre de la suscripción a notificaciones que se borrará.

GetNotificationSubscriptionRequest

Mensaje de solicitud para el método GetNotificationSubscription.

Campos
name	string Obligatorio. Es el name de la suscripción a notificaciones.

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 Es 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 a 200.
page_token	string 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 solicitó 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. account representa el ID del comerciante que es propietario de la configuración. Formato: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event	NotificationEventType Es el evento sobre el que el comercio desea recibir notificaciones.
call_back_uri	string Es la 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 recibirá una notificación diaria del evento especificado para todas las cuentas administradas (pueden ser cuentas secundarias o de otro tipo vinculadas), incluidas las cuentas recién agregadas.
target_account	string El name de la cuenta para la que quieres recibir notificaciones. Formato: accounts/{account}

NotificationEventType

Representa el tipo de evento para el que al comercio le interesa recibir notificaciones.

Enumeraciones
NOTIFICATION_EVENT_TYPE_UNSPECIFIED	No se especificó el tipo de evento de notificaciones.
PRODUCT_STATUS_CHANGE	Notificación de cambios en el estado del producto, por ejemplo, cuando se rechaza un producto.

ProductChange

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

Campos
old_value	string Es el valor anterior del recurso o atributo modificado.
new_value	string Es el valor nuevo del recurso o atributo modificado.
region_code	string Países que tienen el cambio (si corresponde)
reporting_context	ReportingContextEnum Contextos de informes que tienen el cambio (si corresponde)

ProductStatusChangeMessage

Es 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 a la que pertenece 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 comercio 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 del recurso que cambió, 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}}
expiration_time	Timestamp Es la hora de vencimiento del producto. Este campo no se establecerá si la notificación se envía para un evento de eliminación de productos.

Recurso

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

Enumeraciones
RESOURCE_UNSPECIFIED	Recurso no especificado
PRODUCT	Tipo de recurso : producto

UpdateNotificationSubscriptionRequest

Es un mensaje de solicitud para el método UpdateNotificationSubscription.

Campos
notification_subscription	NotificationSubscription Obligatorio. Es la nueva versión de la suscripción a notificaciones que se debe actualizar.
update_mask	FieldMask Es la lista de campos que se actualizarán.