Integrar o Google Picker a apps para computador e dispositivos móveis

Este documento explica como integrar o Google Picker aos seus apps para computador e dispositivos móveis usando a API Google Picker.

A API Google Picker é uma maneira de permitir que os usuários selecionem ou façam upload de arquivos do Google Drive. Os usuários podem conceder permissão ao seu app para computador, dispositivos móveis ou Web para acessar os dados do Drive, oferecendo uma maneira segura e autorizada de interagir com os arquivos.

Recursos

O Google Picker tem vários recursos:

  • Uma aparência semelhante à interface do Google Drive.
  • Várias visualizações mostrando prévias e miniaturas de arquivos do Drive.
  • Visualizações pré-filtradas que mostram apenas tipos de arquivos específicos (como PDFs ou imagens) ou determinadas pastas.
  • Um redirecionamento para o Google Picker em uma nova guia no navegador padrão do usuário.

Embora seja possível selecionar e fazer upload de arquivos com o Google Picker, ele não permite que os usuários organizem, movam ou copiem arquivos de uma pasta para outra. Para gerenciar arquivos, use a API Google Drive ou a interface do Drive.

Pré-requisitos

Os apps que usam o Google Picker precisam obedecer a todos os Termos de Serviço. O mais importante é se identificar corretamente nas solicitações.

Você também precisa ter um projeto do Google Cloud.

Configurar o ambiente

Para começar a usar a API Google Picker, configure seu ambiente.

Ativar a API

Antes de usar as APIs do Google, é necessário ativá-las em um projeto do Google Cloud. É possível ativar uma ou mais APIs em um único projeto do Google Cloud.
  • No console do Google Cloud, ative a API Google Picker.

    Ativar a API

Configurar a autenticação e a autorização

Para autenticar usuários finais e acessar dados do usuário no app, crie um ou mais IDs do cliente OAuth 2.0. Um ID do cliente é usado para identificar um único app nos servidores OAuth do Google. Se o app for executado em várias plataformas, crie um ID do cliente separado para cada uma delas.

Autorizar credenciais para um app para computador

Para criar um ID do cliente OAuth 2.0, siga estas etapas:

  1. No console de APIs do Google, acesse Menu > Plataforma de autenticação do Google > Clientes.

    Acessar "Clientes"

  2. Clique em Criar cliente.
  3. Clique em Tipo de aplicativo > Aplicativo para computador.
  4. No campo Nome, digite um nome para a credencial. Esse nome é mostrado apenas no console de APIs do Google.
  5. Clique em Criar.

    A credencial recém-criada aparece em "IDs de cliente OAuth 2.0".

Para que os apps recebam autorização para arquivos concedidos anteriormente, siga estas etapas:

  1. Você precisa conseguir um token do OAuth 2.0 com o escopo drive.file, drive ou drive.readonly usando estas instruções: Como usar o OAuth 2.0 para acessar as APIs do Google. Para mais informações sobre escopos, consulte Escolher escopos da API Google Drive.

  2. Transmita o token do OAuth 2.0 para a API Drive e leia e modifique arquivos em que o usuário concedeu acesso anteriormente.

Autorizar credenciais para seu app para dispositivos móveis

Para criar um ID do cliente OAuth 2.0, siga as etapas em Autorizar credenciais para um app para dispositivos móveis.

Autorizar credenciais para seu app da Web

Para criar um ID do cliente OAuth 2.0, siga as etapas em Autorizar credenciais para um app da Web.

Mostrar o Google Picker

A API Google Picker para apps de computador e dispositivos móveis redireciona para o Google Picker em uma nova guia no navegador padrão do usuário. Depois que o usuário concede acesso e escolhe os arquivos relevantes, o Google Picker retorna ao app de chamada pelo URL de callback.

Para abrir a API Google Picker em uma página do cliente, use a API Google Picker para apps da Web. Para mais informações, consulte Integrar o Google Picker a apps da Web.

Para permitir que os usuários concedam acesso a outros arquivos ou escolham arquivos para usar no fluxo do app, siga estas etapas:

  1. Solicite acesso ao escopo drive.file para abrir a página de acesso do OAuth 2.0 em uma nova guia do navegador usando estas instruções: Como usar o OAuth 2.0 para acessar as APIs do Google. Para mais informações sobre escopos, consulte Escolher escopos da API Google Drive.

    Apenas o escopo drive.file é permitido para esses apps, e ele não pode ser combinado com nenhum outro escopo.

  2. A URL da nova guia do navegador aceita todos os parâmetros de string de consulta OAuth padrão.

    É preciso anexar os parâmetros de URL prompt e trigger_onepick à sua solicitação de URL de autorização do OAuth 2.0. Se quiser, personalize o Google Picker com vários outros parâmetros:

    Parâmetro Descrição Status
    prompt=consent Solicitar acesso a arquivos. Obrigatório
    trigger_onepick=true Ative o Google Picker. Obrigatório
    allow_multiple=true Se for "true", permite que o usuário selecione vários arquivos. Opcional
    mimetypes=MIMETYPES Uma lista separada por vírgulas de tipos MIME para filtrar os resultados da pesquisa. Se não estiver definido, os arquivos de todos os tipos MIME serão mostrados na visualização. Opcional
    file_ids=FILE_IDS Uma lista separada por vírgulas de IDs de arquivo para filtrar os resultados da pesquisa. Se não for definido, todos os arquivos serão mostrados na visualização. Opcional
    allow_folder_selection=true Se for verdadeiro, permite que o usuário também selecione pastas. Opcional

    O exemplo a seguir mostra uma solicitação de URL de autorização do OAuth 2.0:

    https://accounts.google.com/o/oauth2/v2/auth? \
    client_id=CLIENT_ID \
    &scope=https://www.googleapis.com/auth/drive.file \
    &redirect_uri=REDIRECT_URI \
    &response_type=code \
    &access_type=offline \
    &prompt=consent \
    &trigger_onepick=true
    

    Substitua:

    • CLIENT_ID: o ID do cliente do app.

    • REDIRECT_URI: para onde o servidor de autorização redireciona o navegador do usuário após a autenticação bem-sucedida. Por exemplo, https://www.cymbalgroup.com/oauth2callback.

      O redirect_uri especificado precisa ser um URL HTTPS público. Se você quiser usar um protocolo personalizado ou um URL localhost para seu redirect_uri, use um URL HTTPS público que redirecione para o protocolo personalizado ou o URL localhost.

  3. Depois que o usuário concede acesso e escolhe os arquivos relevantes, o OAuth redireciona para o redirect_uri especificado na solicitação com os seguintes parâmetros de URL anexados:

    • picked_file_ids: se o usuário concedeu acesso e escolheu arquivos, uma lista separada por vírgulas de IDs de arquivos selecionados.

    • code: o token de acesso ou o código de acesso com base no parâmetro response_type definido na solicitação. Esse parâmetro inclui um novo código de autorização.

    • scope: os escopos incluídos na solicitação.

    • error: se o usuário cancelou a solicitação no fluxo de consentimento, um erro será mostrado.

    O exemplo a seguir mostra uma resposta de URL de autorização do OAuth 2.0:

    https://REDIRECT_URI?picked_file_ids=PICKED_FILE_IDS&code=CODE&scope=SCOPES
    
  4. Os apps precisam trocar o código de autorização da etapa 3 por um novo token do OAuth 2.0. Para mais informações, consulte Trocar código de autorização por tokens de atualização e de acesso.

  5. Em seguida, os apps podem usar os IDs de arquivo do parâmetro de URL na etapa 3 e o token do OAuth 2.0 obtido na etapa 4 para chamar a API Drive. Para mais informações, consulte Visão geral da API Google Drive.

Usar o Google Picker com apps Android

Você também pode usar o Google Picker nos seus apps para dispositivos móveis Android.

Autorizar credenciais para um app para dispositivos móveis

Para usar o Google Picker no seu app Android, você precisa autorizar os usuários usando o OAuth 2.0, semelhante aos apps para computador. Para mais detalhes sobre a autenticação do Android, consulte Autorizar o acesso aos dados do usuário do Google.

Para mostrar o Google Picker durante a autorização, crie um AuthorizationRequest e use o parâmetro de recurso PICKER_OAUTH_TRIGGER no objeto AuthorizationRequest.ResourceParameter.

Ao criar o AuthorizationRequest:

  • Use o escopo drive.file.

  • Chame setOptOutIncludingGrantedScopes para true e garantir que o token retornado seja apenas para o escopo drive.file e não para escopos concedidos anteriormente.

  • Defina o campo AuthorizationRequest.Prompt como CONSENT para pedir o consentimento do usuário mesmo que ele já tenha sido concedido.

  • Você também pode usar o operador "OR" de bitmap (|) para definir o campo AuthorizationRequest.Prompt como SELECT_ACCOUNT e permitir que o usuário selecione uma conta antes da solicitação de consentimento.

Chamar o Google Picker

Assim como nos apps para computador, é possível personalizar o Google Picker com vários parâmetros opcionais:

  • PICKER_ALLOW_MULTIPLE: permite que os usuários selecionem vários arquivos.
  • PICKER_MIMETYPES: aceita uma lista separada por vírgulas de tipos MIME para filtrar os resultados da pesquisa. Se não for definido, os arquivos de todos os tipos MIME serão mostrados na visualização.
  • PICKER_FILE_IDS: aceita uma lista separada por vírgulas de IDs de arquivos para filtrar os resultados da pesquisa. Se não for definido, todos os arquivos serão mostrados na visualização.
  • PICKER_ALLOW_FOLDER_SELECTION: permite que os usuários também escolham pastas.

Para mais informações sobre os parâmetros opcionais em apps para computador, consulte Mostrar o Google Picker.

Depois que o usuário concede acesso e escolhe os arquivos relevantes, o objeto getTokenResponseParams do recurso AuthorizationResult é retornado. Se o usuário concedeu acesso, esse objeto contém o valor picked_file_ids, que é uma lista separada por vírgulas de IDs de arquivos selecionados.