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 la suscripción reciba 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 de 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 tu suscripción está suspendida debido a un error con su extremo, es posible que no recibas un evento de ciclo de vida.
  • Usa los métodos subscriptions.get() o subscriptions.list() para ver si el campo state de la suscripción está configurado como SUSPENDED.
  • Se te notifica una falla de entrega en tu extremo de notificación. Para obtener más información sobre la supervisión de fallas de entrega en los temas de Google Cloud Pub/Sub, consulta Soluciona errores 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.

Apps Script

  • Un proyecto de Apps Script tiene las siguientes características:
    • Usa tu proyecto de Google Cloud en lugar del predeterminado que crea Apps Script automáticamente.
    • Para 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: 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages.readonly"
]
    • Habilita el servicio avanzado Google Workspace Events.

Python

  • Python 3.6 o superior
  • 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 la 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 recibes un evento de ciclo de vida sobre la suspensión o cuando usas 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 sea 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

USER_SCOPE_REVOKED

El usuario autorizado revocó la concesión de uno o más permisos de OAuth necesarios para la suscripción. Obtén otro token de acceso. Para obtener más información, consulta Obtén un token de acceso del servidor de autorización de Google.

RESOURCE_DELETED

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

USER_AUTHORIZATION_FAILURE

El usuario que autoriza ya no tiene acceso al recurso para 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 de la aplicación de Google Workspace que entrega eventos.

Para los eventos de Google Chat, la cuenta de servicio es chat-api-push@system.gserviceaccount.com. Para los eventos de Google Meet, la cuenta de servicio es meet-api-event-push@system.gserviceaccount.com.

Para 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 pudo recibir eventos debido a que la cuota es insuficiente o se alcanzó el límite de frecuencia. Solicita un aumento de la cuota.

Cómo reactivar una suscripción

Una vez que resuelvas 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 resuelvan todos los errores y cambia el campo state de tu suscripción de SUSPENDED a ACTIVE.

Para reactivar una suscripción a Google Workspace, sigue estos pasos:

Apps Script

  1. En tu proyecto de Apps Script, crea un nuevo archivo de secuencia de comandos 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: Es el ID de la suscripción. Para obtener el ID, puedes usar cualquiera de las siguientes opciones:
      • El valor del campo uid.
      • Es el 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('client_secrets.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 alcances de OAuth que admitan cada tipo de evento para la suscripción. Tiene el formato de 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: Es el ID de la suscripción. Para obtener el ID, puedes usar cualquiera de las siguientes opciones:
      • El valor del campo uid.
      • Es el 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 las credenciales de tu ID de cliente de OAuth y de haber nombrado el archivo client_secrets.json. La muestra de código usa este archivo JSON para autenticarse con Google Workspace y obtener credenciales del 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 muestra 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 errores adicionales.

Cómo solucionar 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 que falló. El resultado contiene cualquier error que aún esté presente.

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