Resuelve errores y reactiva una suscripción a Google Workspace

En esta página, se explica cómo reactivar una suscripción suspendida de Google Workspace resolviendo o solucionando errores y llamando al método subscriptions.reactivate.

Las suscripciones a Google Workspace se suspenden cuando un error impide que reciban eventos. Por ejemplo, una suscripción se suspende cuando no se puede encontrar su recurso de destino o extremo de notificación. Después de resolver los errores relacionados con la suscripción, puedes reactivarla para volver a recibir eventos.

Puedes obtener información sobre una suscripción suspendida de las siguientes maneras:

  • Tu app recibe un evento de ciclo de vida sobre la suspensión. Si se suspende tu suscripción debido a un error con su extremo, es posible que no recibas un evento de ciclo de vida.
  • Usas los métodos subscriptions.get o subscriptions.list para ver si el campo state de la suscripción está establecido en SUSPENDED.
  • Recibirás una notificación sobre una falla en la entrega en tu endpoint de notificación. Para obtener información sobre cómo supervisar las fallas en la entrega a temas de Google Cloud Pub/Sub, consulta Cómo controlar las fallas de mensajes.

Las suscripciones reactivadas conservan la fecha de vencimiento original. Para extender el tiempo de vencimiento de una suscripción, consulta Cómo actualizar o renovar una suscripción a Google Workspace.

Apps Script

  • Un proyecto de Apps Script:
    • Usa tu proyecto de Google Cloud en lugar del predeterminado que crea automáticamente Apps Script.
    • Para todos los permisos que agregaste para configurar la pantalla de consentimiento de OAuth, también debes agregar los permisos al archivo appsscript.json en tu proyecto de Apps Script. Por ejemplo, si especificaste el permiso chat.messages, agrega lo siguiente: 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages"
]
    • Habilita el servicio avanzado de Google Workspace Events.

Python

  • Python 3.6 o una versión posterior
  • La herramienta de administración de paquetes pip
  • Las bibliotecas cliente de Google más recientes para Python. Para instalarlos o actualizarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib

Identifica y resuelve errores

Para identificar el error de una suscripción, revisa el campo suspensionReason de la suscripción. Puedes encontrar este campo cuando recibas un evento de ciclo de vida sobre la suspensión o usando el método subscriptions.get para revisar todos los campos de la suscripción.

En la siguiente tabla, se muestran los posibles errores de una suscripción y, cuando es posible, cómo resolverlos. Si no puedes resolver el error, puedes borrar la suscripción o esperar a que venza. La API de Google Workspace Events borra automáticamente las suscripciones vencidas.

Error Descripción Formas de resolver el problema

USER_SCOPE_REVOKED

El usuario autorizante revocó el otorgamiento de uno o más permisos de OAuth que se requieren para la suscripción. Obtén otro token de acceso. Para obtener más información, consulta Cómo obtener un token de acceso del servidor de autorización de Google.

RESOURCE_DELETED

Se borró el recurso de destino de la suscripción. Si se restablece el recurso, llama al método reactivate. De lo contrario, no es necesario realizar ninguna acción, ya que no puedes reactivar una suscripción sin su recurso de destino original.

USER_AUTHORIZATION_FAILURE

El usuario autorizador ya no tiene acceso al recurso de la suscripción. No se requiere ninguna acción. No puedes reactivar la suscripción, ya que el usuario que la autorizó no puede acceder al recurso de destino.

ENDPOINT_PERMISSION_DENIED

La aplicación de Google Workspace no tiene acceso para entregar eventos a tu extremo de notificación. Otorga acceso a la cuenta de servicio para la aplicación de Google Workspace que entrega eventos.

Cuentas de servicio:
  • Eventos de Google Chat: chat-api-push@system.gserviceaccount.com
  • Eventos de Google Drive: drive-api-event-push@system.gserviceaccount.com
  • Eventos de Google Meet: meet-api-event-push@system.gserviceaccount.com

En el caso de los temas de Pub/Sub, otorga el rol de Publicador de Pub/Sub (roles/pubsub.publisher) ) a la cuenta de servicio.

ENDPOINT_NOT_FOUND

El extremo de notificación no existe o no se puede encontrar. Verifica que el extremo siga activo y funcionando. Para solucionar problemas relacionados con los temas de Pub/Sub, consulta la documentación de solución de problemas.

ENDPOINT_RESOURCE_EXHAUSTED

El extremo de notificación no recibió eventos debido a que la cuota es insuficiente o se alcanzó el límite de frecuencia. Solicita un aumento de la cuota.

APP_SCOPE_REVOKED

El administrador del dominio revocó el otorgamiento de uno o más permisos de OAuth para la app de Chat. Recibir la aprobación del administrador

APP_AUTHORIZATION_FAILURE

La app de Chat que autorizó la creación de la suscripción ya no tiene acceso al recurso de destino de la suscripción. Recupera el acceso al recurso de destino. Por ejemplo, si el recurso de destino es un espacio de Chat, es posible que la app de Chat necesite ser miembro del espacio.

Cómo reactivar una suscripción

Después de resolver el error que suspendió tu suscripción, puedes usar el método reactivate para permitir que la suscripción vuelva a recibir eventos. El método verifica que se hayan resuelto todos los errores y cambia el campo state de tu suscripción de SUSPENDED a ACTIVE.

Para reactivar una suscripción a Google Workspace, haz lo siguiente:

Apps Script

  1. En tu proyecto de Apps Script, crea un archivo de secuencia de comandos nuevo llamado reactivateSubscription y agrega el siguiente código:

    function reactivateSubscription() {
  // The name of the subscription to reactivate.
  const name = 'subscriptions/SUBSCRIPTION_ID';

  // Call the Workspace Events API using the advanced service.
  const response = WorkspaceEvents.Subscriptions.reactivate({}, name);
  console.log(response);
}

    Reemplaza lo siguiente:

    • SUBSCRIPTION_ID: ID de la suscripción. Para obtener el ID, puedes usar cualquiera de las siguientes opciones:
      • El valor del campo uid.
      • ID del nombre del recurso representado en el campo name. Por ejemplo, si el nombre del recurso es subscriptions/subscription-123, usa subscription-123.

  2. Para reactivar la suscripción a Google Workspace, ejecuta la función reactivateSubscription en tu proyecto de Apps Script.

Python

  1. En tu directorio de trabajo, crea un archivo llamado reactivate_subscription.py y agrega el siguiente código:

    """Reactivate subscription."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [SCOPES]

# Authenticate with Google Workspace and get user authentication.
flow = InstalledAppFlow.from_client_secrets_file('credentials.json', SCOPES)
CREDENTIALS = flow.run_local_server()

# Call the Workspace Events API using the service endpoint.
service = build(
    'workspaceevents',
    'v1',
    credentials=CREDENTIALS,
)

NAME = 'subscriptions/SUBSCRIPTION_ID'
response = service.subscriptions().reactivate(name=NAME).execute()
print(response)

    Reemplaza lo siguiente:

    • SCOPES: Uno o más permisos de OAuth que admiten cada tipo de evento para la suscripción. Se da formato como un array de cadenas. Para enumerar varios permisos, sepáralos con comas. Por ejemplo, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
    • SUBSCRIPTION_ID: ID de la suscripción. Para obtener el ID, puedes usar cualquiera de las siguientes opciones:
      • El valor del campo uid.
      • ID del nombre del recurso representado en el campo name. Por ejemplo, si el nombre del recurso es subscriptions/subscription-123, usa subscription-123.

  2. En tu directorio de trabajo, asegúrate de haber almacenado tus credenciales de ID de cliente de OAuth y de haber nombrado el archivo credentials.json. La muestra de código usa este archivo JSON para autenticarse en Google Workspace y obtener credenciales de usuario. Para obtener instrucciones, consulta Crea credenciales de ID de cliente de OAuth.

  3. Para reactivar la suscripción a Google Workspace, ejecuta el siguiente comando en la terminal:

    python3 reactivate_subscription.py
La API de Google Workspace Events devuelve una operación de larga duración que contiene la instancia del recurso Subscription.

Si la solicitud falla, consulta la siguiente sección para solucionar problemas adicionales.

Cómo reactivar una suscripción como una app de Google Chat

Puedes reactivar una suscripción a eventos de Chat como una app de Chat en lugar de como un usuario. El proceso es similar, excepto por lo siguiente:

  1. En lugar de la autenticación de usuarios, autentícate como una app de Chat con la aprobación única del administrador.

  2. Especifica los alcances de autorización que permiten que la app de Chat se suscriba a los eventos de Chat. Estos permisos de autorización siempre comienzan con chat.app y incluyen lo siguiente:

    • https://www.googleapis.com/auth/chat.app.memberships: Suscríbete a los eventos de miembros del espacio de Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly: Suscríbete a los eventos de mensajes y reacciones del espacio de Chat.
    • https://www.googleapis.com/auth/chat.app.spaces: Suscríbete a los eventos del espacio de Chat.

Crea una clave de API

Para llamar a un método de la API de la versión preliminar para desarrolladores, debes usar una versión preliminar para desarrolladores no pública del documento de descubrimiento de la API. Para autenticar la solicitud, debes pasar una clave de API.

Para crear la clave de API, abre el proyecto de Google Cloud de tu app y haz lo siguiente:

  1. En la consola de Google Cloud, ve a Menú > APIs y servicios > Credenciales.

    Ir a Credenciales

  2. Haz clic en Crear credenciales > Clave de API.
  3. Se mostrará tu nueva clave de API.
    • Haz clic en Copiar para copiar tu clave de API y usarla en el código de tu app. La clave de API también se puede encontrar en la sección "Claves de API" de las credenciales de tu proyecto.
    • Para evitar el uso no autorizado, te recomendamos restringir dónde y para qué APIs se puede usar la clave de API. Para obtener más detalles, consulta Agrega restricciones de API.

Escribe una secuencia de comandos que llame a la API de Google Workspace Events

En la siguiente muestra de código, se reactiva la suscripción a Google Workspace de una app de Chat:

Python 

  """Reactivate subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = [SCOPES]

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # Call the Workspace Events API using the service endpoint.
  service = build(
      'workspaceevents',
      'v1beta',
      credentials=CREDENTIALS,
      discoveryServiceUrl='https://workspaceevents.googleapis.com/$discovery/rest?version=v1beta&labels=DEVELOPER_PREVIEW&key=API_KEY',
  )

  NAME = 'subscriptions/SUBSCRIPTION_ID'
  response = service.subscriptions().reactivate(name=NAME).execute()
  print(response)

Reemplaza lo siguiente:

  • SCOPES: Especifica los permisos de autorización que permiten que la app de Chat se suscriba a los eventos de Chat. Estos permisos de autorización siempre comienzan con chat.app y incluyen lo siguiente:

    • https://www.googleapis.com/auth/chat.app.memberships: Suscríbete a los eventos de miembros del espacio de Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly: Suscríbete a los eventos de mensajes y reacciones del espacio de Chat.
    • https://www.googleapis.com/auth/chat.app.spaces: Suscríbete a los eventos del espacio de Chat.

  • API_KEY: Es la clave de API que creaste para compilar el extremo de servicio de la API de Google Workspace Events.

  • SUBSCRIPTION_ID: ID de la suscripción. Para obtener el ID, puedes usar cualquiera de las siguientes opciones:

    • El valor del campo uid.
    • ID del nombre del recurso representado en el campo name. Por ejemplo, si el nombre del recurso es subscriptions/subscription-123, usa subscription-123.

Soluciona problemas relacionados con varios errores

Si resolviste el error que suspendió la suscripción y el método reactivate falla, es posible que se haya producido otro error después de que se suspendió la suscripción.

Para identificar errores adicionales, revisa el resultado de la solicitud fallida. La salida contiene los errores que aún están presentes.

Cuando tu suscripción tiene varios errores, el valor del campo suspensionReason siempre usa el error original que suspendió tu suscripción.