Introdução: desenvolver apps usando a API Data Portability

Com a API Data Portability, é possível criar aplicativos que solicitam autorização de um usuário para mover uma cópia dos dados dos serviços do Google para seu aplicativo. Isso permite a portabilidade de dados e facilita a troca de serviços.

Para saber como os usuários compartilham dados, consulte Compartilhar uma cópia dos seus dados com terceiros.

Pré-requisitos

Antes de lançar o app, ele precisa ser aprovado pelo Google.

Verifique também se a API Data Portability está disponível para os usuários no seu local. Para conferir uma lista de países e regiões com suporte, consulte as Perguntas frequentes na página "Compartilhar uma cópia dos seus dados com terceiros".

Fluxo de trabalho do desenvolvedor

Estas são as etapas a serem seguidas para criar um aplicativo que usa a API Data Portability.

As etapas que um desenvolvedor segue para criar um app usando a API Data Portability

  1. Implemente o fluxo de consentimento do OAuth para o usuário. Neste exemplo, o usuário está concedendo acesso aos dados de vídeo do YouTube.

    1. O usuário clica em Importar vídeos do YouTube e faz login na Conta do Google.

    2. O app encaminha o usuário para um URL de consentimento do OAuth. Observe que este URL de exemplo foi simplificado e não contém alguns parâmetros:

      https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.googleapis.com/auth/dataportability.myactivity.youtube

    3. O usuário clica em Próxima na tela de consentimento do OAuth, concorda em compartilhar os dados e fornece acesso à conta.

    4. O usuário é redirecionado para o app.

    5. O desenvolvedor obtém um token OAuth para o usuário.

  2. O app chama InitiatePortabilityArchive(resources = ["myactivity.youtube"]) com um token OAuth anexado que contém este escopo do OAuth:

    https://www.googleapis.com/auth/dataportability.myactivity.youtube

    Essa chamada inicia o processo de criação do arquivo de dados. Inicie o arquivo de portabilidade em até 24 horas após a autorização do usuário.

  3. O app chama GetPortabilityArchiveState(job_id) com um token OAuth anexado que contém este escopo do OAuth:

    https://www.googleapis.com/auth/dataportability.myactivity.youtube

    Chame esse método várias vezes para recuperar o status do job de arquivamento. O método retorna o estado do job. Se o estado for "COMPLETO", o arquivo estará pronto e os URLs assinados do Cloud Storage serão fornecidos. O tempo necessário para concluir a solicitação de arquivamento pode variar de minutos a horas, dependendo do tamanho dos dados.

  4. Faça o download do arquivo de dados usando os URLs assinados.

  5. Chame ResetAuthorization() com um token OAuth anexado para redefinir os recursos esgotados e remover todos os consentimentos OAuth.

Para mais informações sobre como usar os métodos da API Data Portability, consulte Chamar métodos da API Data Portability.

Como os usuários interagem com um app da API Data Portability

Este diagrama mostra como os usuários interagem com um app integrado à API Data Portability.

As etapas que um usuário segue para exportar os dados

  1. Primeiro, o usuário tem a opção de recuperar os dados.

  2. Em seguida, o usuário faz login na Conta do Google.

  3. Em seguida, o usuário clica em Próxima quando é solicitado que ele compartilhe os dados e em Entendi quando é solicitado que ele aceite a política de privacidade.

  4. Em seguida, o usuário vê uma tela de permissão OAuth que é usada para permitir que o aplicativo acesse os dados. As opções aqui correspondem aos escopos do OAuth que você configurou.

  5. Depois de permitir o acesso, a importação de dados é iniciada. Dependendo do tamanho dos dados, a solicitação pode levar de alguns minutos a várias horas para ser concluída.