Chamar a API Data Portability usando um script Python

Neste guia de início rápido, você recebe um token OAuth para sua conta e envia solicitações para os endpoints da API Data Portability usando um script Python.

Conteúdo do laboratório

Neste guia de início rápido, você usa um script Python para:

  • Envie uma solicitação autenticada para o endpoint InitiatePortabilityArchive fornecendo um token OAuth válido. A resposta é um job_id válido.
  • Enviar uma solicitação autenticada para o endpoint GetPortabilityArchiveState e fazer o download dos dados. A resposta precisa conter um estado de job válido e, quando o job for concluído, um URL assinado.
  • Envie uma solicitação autenticada ao endpoint ResetAuthorization. Essa solicitação revoga todos os escopos OAuth concedidos pelo usuário.

Pré-requisitos

Para executar este guia de início rápido, você precisa:

  • Verifique se a API Data Portability está disponível para você. Para uma lista de países e regiões compatíveis, consulte as Perguntas comuns na página "Compartilhar uma cópia dos seus dados com um terceiro".
  • Conclua as etapas de configuração da API Data Portability e verifique se você está usando um novo projeto.
  • ter acesso a uma conta da sua organização ou controlada por ela. Os dados da atividade de pesquisa desta conta são exportados neste guia de início rápido.

Antes de começar este guia de início rápido, você também precisa configurar o OAuth, o Python e o pacote do OAuth para as bibliotecas de cliente do Python.

Configurar o OAuth

  • Siga as etapas para configurar o OAuth para aplicativos instalados. Esse fluxo é semelhante ao fluxo do OAuth para aplicativos de servidor da Web. Ao configurar o ID do cliente OAuth:
    • O Tipo de aplicativo deve ser App para computador.
    • Depois de criar o ID do cliente, faça o download da chave secreta do cliente no formato JSON e nomeie o arquivo: client_secrets.json.
    • Quando você configura escopos da API Data Portability, este guia de início rápido usa estes grupos de recursos:

Configurar o Python

É necessário configurar o Python na sua máquina local para executar o script usado neste guia de início rápido. Para configurar o Python:

  • Instale a ferramenta de gerenciamento de pacotes Pip e o Python 3.9 (ou versão mais recente).
  • Instale a biblioteca de cliente da API do Google para Python.

  • Execute este comando para instalar o pacote google_auth_oauthlib da biblioteca de cliente do Python. Esse pacote fornece integração oauthlib com a google-auth, a biblioteca de autenticação do Google para Python.

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

Executar o script

Esse script usa um redirecionamento de localhost no fluxo do OAuth. Essa opção exige que o aplicativo detecte em uma porta localhost e abra o navegador do sistema para iniciar o fluxo de autorização OAuth.

Clique nele para abrir o script ou faça o download de uma cópia dele clicando com o botão direito do mouse nele.

Script do guia de início rápido da API Data Portability em Python

Para executar o script, insira este comando:

python3 data-portability-quickstart.py

As ações realizadas pelo script estão detalhadas nos comentários.