Atualizar ou renovar uma assinatura do Google Workspace

Apps Script

• Uma assinatura do Google Workspace. Para criar uma, consulte Criar uma assinatura.

• Um projeto do Apps Script:
  • Use seu projeto do Google Cloud em vez do padrão criado automaticamente pelo Apps Script.
  • Para todos os escopos adicionados ao configurar a tela de permissão OAuth, você também precisa adicionar os escopos ao arquivo appsscript.json no seu projeto do Apps Script. Por exemplo, se você especificou o escopo chat.messages, adicione o seguinte:

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages"
  ]
      

  • Ative o serviço avançado do Google Workspace Events.

• Exige autenticação e um escopo de autorização adequado para cada tipo de evento na assinatura:

  • Para autenticação de usuário, exige um ou mais escopos que ofereçam suporte a pelo menos um dos tipos de evento da assinatura. Para identificar um escopo, consulte Escopos por tipo de evento.
  • Para se inscrever em um evento do Chat como um app do Chat, é necessário fazer a autenticação do app com aprovação única do administrador. A inscrição em um evento do Chat como um app do Chat está disponível na prévia para desenvolvedores.

Python

• Python 3.6 ou mais recente
• A ferramenta de gerenciamento de pacotes pip
• As bibliotecas de cliente mais recentes do Google para Python. Para instalar ou atualizar, execute o seguinte comando na interface de linha de comando:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

• Uma assinatura do Google Workspace. Para criar uma, consulte Criar uma assinatura.

• Exige autenticação e um escopo de autorização adequado para cada tipo de evento na assinatura:

  • Para autenticação de usuário, exige um ou mais escopos que ofereçam suporte a pelo menos um dos tipos de evento da assinatura. Para identificar um escopo, consulte Escopos por tipo de evento.
  • Para se inscrever em um evento do Chat como um app do Chat, é necessário fazer a autenticação do app com aprovação única do administrador. A inscrição em um evento do Chat como um app do Chat está disponível na prévia para desenvolvedores.

Apps Script

1. No projeto do Apps Script, crie um arquivo de script chamado updateSubscription e adicione o seguinte código:

   function updateSubscription() {
     // The name of the subscription to update.
     const name = 'subscriptions/SUBSCRIPTION_ID';
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.patch({
       ttl: '0s',
     }, name);
     console.log(response);
   }
   

   Substitua:

   • SUBSCRIPTION_ID: o ID da assinatura. Para conseguir o ID, use uma destas opções:
     • O valor do campo uid.
     • O ID do nome do recurso representado no campo name. Por exemplo, se o nome do recurso for subscriptions/subscription-123, use subscription-123.

2. Para atualizar a assinatura do Google Workspace, execute a função updateSubscription no seu projeto do Apps Script.

Python

1. No diretório de trabalho, crie um arquivo chamado update_subscription.py e adicione o seguinte código:

   """Update 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,
   )
   
   BODY = {
       'ttl': {'seconds': 0},
   }
   NAME = 'subscriptions/SUBSCRIPTION_ID'
   response = (
       service.subscriptions()
       .patch(name=NAME, updateMask='ttl', body=BODY)
       .execute()
   )
   print(response)
   

   Substitua:

   • SCOPES: um ou mais escopos do OAuth que oferecem suporte a cada tipo de evento da assinatura. Formatado como uma matriz de strings. Para listar vários escopos, separe-os por vírgulas. Por exemplo, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • SUBSCRIPTION_ID: o ID da assinatura. Para conseguir o ID, use uma destas opções:
     • O valor do campo uid.
     • O ID do nome do recurso representado no campo name. Por exemplo, se o nome do recurso for subscriptions/subscription-123, use subscription-123.

2. No seu diretório de trabalho, verifique se você armazenou as credenciais de ID do cliente OAuth e nomeou o arquivo como credentials.json. O exemplo de código usa esse arquivo JSON para autenticar com o Google Workspace e receber credenciais de usuário. Para instruções, consulte Criar credenciais de ID do cliente OAuth.

3. Para atualizar a assinatura do Google Workspace, execute o seguinte no terminal:

   python3 update_subscription.py

Python

  """Update 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',
  )

  BODY = {
      'ttl': {'seconds': 0},
  }
  NAME = 'subscriptions/SUBSCRIPTION_ID'
  response = (
      service.subscriptions()
      .patch(name=NAME, updateMask='ttl', body=BODY)
      .execute()
  )
  print(response)