Chamar a API Data Portability usando um script Python

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

Conteúdo do laboratório

Neste guia de início rápido, você vai usar 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.
  • Envie uma solicitação autenticada para o endpoint GetPortabilityArchiveState e faça o download dos dados. A resposta precisa conter um estado de job válido e, quando o job for concluído, um URL assinado.
  • Armazene o token OAuth com acesso baseado em tempo para reutilização posterior.
  • Envie uma solicitação autenticada para o endpoint ResetAuthorization. Essa solicitação revoga todos os escopos do OAuth concedidos pelo usuário.
  • Envie uma solicitação autenticada para o endpoint InitiatePortabilityArchive fornecendo um token OAuth válido com start_time ou end_time para aplicar um filtro de tempo à solicitação.

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 conferir uma lista de países e regiões com suporte, consulte Perguntas frequentes na página "Compartilhar uma cópia dos seus dados com terceiros".
  • Conclua as etapas de configuração da API Data Portability e verifique se você está usando um novo projeto.
  • Ter acesso a uma conta que pertence ou é controlada pela sua organização. Os dados de atividade de pesquisa dessa 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 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 de OAuth para aplicativos de servidor da Web. Ao configurar seu ID do cliente OAuth:
    • O Tipo de aplicativo precisa ser App para computador.
    • Depois de criar o ID do cliente, faça o download do segredo do cliente em formato JSON e nomeie o arquivo: client_secrets.json.
    • Ao configurar escopos para a API Data Portability, observe que este guia de início rápido usa estes grupos de recursos:

Configurar o Python

É necessário configurar o Python na máquina local para executar o script usado neste apresentação rápida. Para configurar o Python:

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

  • Instale o pacote google_auth_oauthlib para a biblioteca de cliente do Python executando este comando. Esse pacote fornece a integração da oauthlib com 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 OAuth. Essa opção exige que o aplicativo ouça em uma porta do localhost e abra o navegador do sistema para iniciar o fluxo de autorização do OAuth.

Clique neste link para abrir o script ou clique com o botão direito do mouse no link para fazer o download de uma cópia.

Script de quickstart da API Data Portability em Python

Para executar o script e exportar o corpus de dados completo, digite este comando:

python3 data-portability-quickstart.py

Para usar escopos diferentes, especifique-os usando --resources, por exemplo:

python3 data-portability-quickstart.py --resources myactivity.shopping myactivity.play

Para aplicar a filtragem de tempo, use o mesmo script com as flags start_time e end_time. Exemplo:

python3 data-portability-quickstart.py --start_time 2023-01-01T12:00:00Z --end_time 2024-01-01T12:00:00Z

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