Recurso: Subscription
Una suscripción para recibir eventos sobre un recurso de Google Workspace. Para obtener más información sobre las suscripciones, consulta la descripción general de la API de Eventos de Google Workspace.
Representación JSON |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
Campos | |
---|---|
name |
Opcional. Inmutable. Identificador. Nombre del recurso de la suscripción. Formato: |
uid |
Solo salida. Es el identificador único asignado por el sistema para la suscripción. |
targetResource |
Obligatorio. Inmutable. El recurso de Google Workspace que se supervisa para detectar eventos, con el formato del nombre completo del recurso. Para obtener más información sobre los recursos objetivo y los eventos que admiten, consulta Eventos de Google Workspace admitidos. Un usuario solo puede autorizar tu app para que cree una suscripción para un recurso de destino determinado. Si la app intenta crear otra suscripción con las mismas credenciales de usuario, la solicitud mostrará un error |
eventTypes[] |
Obligatorio. Inmutable. Lista sin ordenar. Entrada para crear una suscripción. De lo contrario, solo el resultado. Uno o más tipos de eventos para recibir sobre el recurso objetivo. Tienen formato según la especificación de CloudEvents. Los tipos de eventos admitidos dependen del recurso de destino de tu suscripción. Para obtener más información, consulta los eventos de Google Workspace admitidos. De forma predeterminada, también recibes eventos sobre el ciclo de vida de tu suscripción. No es necesario que especifiques eventos de ciclo de vida para este campo. Si especificas un tipo de evento que no existe para el recurso de destino, la solicitud muestra un código de estado HTTP |
payloadOptions |
Opcional. Opciones sobre qué datos incluir en la carga útil del evento. Solo es compatible con eventos de Google Chat. |
notificationEndpoint |
Obligatorio. Inmutable. El extremo en el que la suscripción entrega eventos, como un tema de Pub/Sub. |
state |
Solo salida. Es el estado de la suscripción. Determina si la suscripción puede recibir eventos y entregarlos al extremo de notificación. |
suspensionReason |
Solo salida. El error que suspendió la suscripción. Para reactivar la suscripción, resuelve el error y llama al método |
authority |
Solo salida. El usuario que autorizó la creación de la suscripción. Formato: Para los usuarios de Google Workspace, el valor |
createTime |
Solo salida. Es la hora en que se creó la suscripción. |
updateTime |
Solo salida. Indica la última vez que se actualizó la suscripción. |
reconciling |
Solo salida. Si es |
etag |
Opcional. El servidor calcula esta suma de verificación según el valor de otros campos, y se puede enviar en solicitudes de actualización para garantizar que el cliente tenga un valor actualizado antes de continuar. |
Campo de unión El tiempo de vencimiento máximo depende de si tu suscripción incluye datos de recursos en cargas útiles de eventos (especificado en el campo
Una vez que vence una suscripción, se borra automáticamente. Recibirás eventos de ciclo de vida en Para evitar que venza una suscripción, puedes usar el método |
|
expireTime |
Valor predeterminado no vacío. Es la marca de tiempo en UTC de cuándo vence la suscripción. Siempre se muestra en el resultado, sin importar lo que se usó en la entrada. |
ttl |
Solo entrada. El tiempo de actividad (TTL) o la duración de la suscripción. Si no se especifica o se establece en |
PayloadOptions
Opciones sobre qué datos incluir en la carga útil del evento. Solo es compatible con eventos de Google Chat.
Representación JSON |
---|
{ "includeResource": boolean, "fieldMask": string } |
Campos | |
---|---|
includeResource |
Opcional. Indica si la carga útil del evento incluye datos sobre el recurso que cambió. Por ejemplo, para un evento en el que se creó un mensaje de Google Chat, si la carga útil contiene datos sobre el recurso |
fieldMask |
Opcional. Si Si especificas un campo que no existe para el recurso, el sistema lo ignorará. |
NotificationEndpoint
El extremo en el que la suscripción entrega eventos.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
pubsubTopic |
Inmutable. El tema de Cloud Pub/Sub que recibe los eventos de la suscripción Formato: Debes crear el tema en el mismo proyecto de Google Cloud en el que creaste esta suscripción. Cuando el tema recibe eventos, estos se codifican como mensajes de Cloud Pub/Sub. Si deseas obtener más detalles, consulta la vinculación de protocolo de Google Cloud Pub/Sub para CloudEvents. |
Estado
Estados posibles para la suscripción.
Enumeradores | |
---|---|
STATE_UNSPECIFIED |
Valor predeterminado Este valor no se usa. |
ACTIVE |
La suscripción está activa y puede recibir y entregar eventos a su extremo de notificación. |
SUSPENDED |
La suscripción no puede recibir eventos debido a un error. Para identificar el error, consulta el campo . |
DELETED |
Se borró la suscripción. |
ErrorType
Posibles errores para una suscripción.
Enumeradores | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Valor predeterminado Este valor no se usa. |
USER_SCOPE_REVOKED |
El usuario que autoriza revocó el otorgamiento de uno o más permisos de OAuth. Para obtener más información sobre la autorización de Google Workspace, consulta Configura la pantalla de consentimiento de OAuth. |
RESOURCE_DELETED |
El recurso de destino para la suscripción ya no existe. |
USER_AUTHORIZATION_FAILURE |
El usuario que autorizó la creación de la suscripción ya no tiene acceso al recurso de destino de la suscripción. |
ENDPOINT_PERMISSION_DENIED |
La aplicación de Google Workspace no tiene acceso para entregar eventos al extremo de notificación de tu suscripción. |
ENDPOINT_NOT_FOUND |
El extremo de notificación de la suscripción no existe o no se puede encontrar en el proyecto de Google Cloud en el que creaste la suscripción. |
ENDPOINT_RESOURCE_EXHAUSTED |
El extremo de notificación de la suscripción no pudo recibir eventos debido a que la cuota es insuficiente o a que alcanzó el límite de frecuencia. |
OTHER |
Se produjo un error desconocido. |
Métodos |
|
---|---|
|
Crea una suscripción a Google Workspace. |
|
Borra una suscripción a Google Workspace. |
|
Obtiene detalles sobre una suscripción a Google Workspace. |
|
Muestra una lista de las suscripciones a Google Workspace. |
|
Actualiza o renueva una suscripción a Google Workspace. |
|
Reactiva una suscripción suspendida a Google Workspace. |