Informações do usuário recorrente

O Google Drive oferece duas opções para coletar informações sobre os usuários:

  • Usando o recurso about, é possível extrair informações sobre o usuário, as configurações do Drive e os recursos do sistema.

  • Usando o recurso apps, é possível extrair uma lista dos apps instalados do usuário, com informações sobre os tipos MIME, as extensões de arquivo e outros detalhes de cada app.

Este guia explica como recuperar informações do usuário no Drive.

Conferir detalhes sobre um usuário

Para retornar informações sobre um usuário do Drive como uma instância de about, use o método get(). Os valores retornados são medidos em bytes.

O método get() exige o parâmetro fields para listar os campos a serem retornados na resposta. Se você omitir o parâmetro, o método vai retornar um erro. Para retornar os campos exatos necessários, consulte Retornar campos específicos.

Mostrar um exemplo

O exemplo de código a seguir mostra como fornecer vários fields como um parâmetro de consulta na solicitação. A resposta retorna os valores de campo da solicitação.

Solicitação

GET https://www.googleapis.com/drive/v3/about/?fields=kind,user,storageQuota

Resposta

{
  "kind": "drive#about",
  "user": {
    "kind": "drive#user",
    "displayName": "DISPLAY_NAME",
    "photoLink": "PHOTO_LINK",
    "me": true,
    "permissionId": "PERMISSION_ID",
    "emailAddress": "EMAIL_ADDRESS"
  },
  "storageQuota": {
    "usage": "10845031958",
    "usageInDrive": "2222008387",
    "usageInDriveTrash": "91566"
  }
}

A resposta inclui os seguintes valores:

  • DISPLAY_NAME: o nome do usuário em texto simples.
  • PHOTO_LINK: o URL da foto do perfil do usuário.
  • PERMISSION_ID: o ID do usuário nos recursos Permission.
  • EMAIL_ADDRESS: o endereço de e-mail do usuário

Listar apps do usuário

Os apps do Google Drive estão listados no Google Workspace Marketplace e são usados para tornar o Drive mais conveniente, como o app Documentos Google ou um complemento usado nos Documentos para assinar documentos. Para mais informações, consulte Usar apps do Google Drive.

Para retornar uma lista de todos os apps instalados do usuário como uma instância de apps, use o método list() sem nenhum parâmetro.

É possível definir o parâmetro fields para listar os campos a serem retornados na resposta. Para retornar os campos exatos necessários, consulte Retornar campos específicos.

Mostrar um exemplo

O exemplo de código abaixo mostra como retornar uma lista de todos os apps instalados do usuário na solicitação. A resposta retorna os valores de campo da solicitação.

Solicitação

GET https://www.googleapis.com/drive/v3/apps

Resposta

{
  "kind": "drive#appList",
  "selfLink": "https://www.googleapis.com/drive/v3/apps",
  "items": [
    {
      "kind": "drive#app",
      "id": "ID",
      "name": "Google Sheets",
      "supportsCreate": true,
      "supportsImport": true,
      "supportsMultiOpen": false,
      "supportsOfflineCreate": true,
      "productUrl": "https://chrome.google.com/webstore/detail/felcaaldnbdncclmgdcncolpebgiejap",
      "productId": "PRODUCT_ID"
    }
  ],
  "defaultAppIds": [
    "ID"
  ]
}

A resposta inclui os seguintes valores:

  • ID: o ID do app.
  • PRODUCT_ID: o ID da ficha do produto para esse app.

Listar apps do usuário com parâmetros de consulta

Para encontrar um app específico, use um ou mais dos parâmetros de consulta opcionais:

  • appFilterExtensions: filtrar os resultados da pesquisa usando uma lista de extensões de arquivo separadas por vírgulas. Os apps no escopo da consulta que podem abrir as extensões de arquivo listadas são incluídos na resposta. Se appFilterMimeTypes também for fornecido, uma união das duas listas de apps resultantes será retornada. Exemplos de extensões incluem docx para o Microsoft Word e pptx para o Microsoft PowerPoint. Para mais exemplos de extensões de arquivo, consulte Exportar tipos MIME para documentos do Google Workspace.

    O exemplo de código abaixo mostra como fornecer várias extensões de arquivo como um parâmetro de consulta: GET https://www.googleapis.com/drive/v3/apps?appFilterExtensions=docx,pptx.

  • appFilterMimeTypes: filtrar os resultados da pesquisa usando uma lista de tipos MIME separada por vírgulas. Os apps no escopo da consulta que podem abrir os tipos MIME listados são incluídos na resposta. Se appFilterExtensions também for fornecido, uma união das duas listas de apps resultantes será retornada. Exemplos de tipos MIME incluem application/vnd.google-apps.form para o Google Forms e application/vnd.google-apps.site para o Google Sites. Para mais exemplos de tipos MIME, consulte Tipos MIME compatíveis com o Google Workspace e o Google Drive.

    O exemplo de código abaixo mostra como fornecer vários tipos MIME como um parâmetro de consulta: GET https://www.googleapis.com/drive/v3/apps?appFilterMimeTypes=application/vnd.google-apps.form,application/vnd.google-apps.site.

  • languageCode: filtrar os resultados da pesquisa usando um idioma ou código de localidade, conforme definido pelo BCP 47, com algumas extensões do formato LDML do Unicode. Exemplos de códigos de idioma incluem en-us para inglês (Estados Unidos) e fr-ca para francês (Canadá).

    O exemplo de código abaixo mostra como fornecer vários códigos de idioma como um parâmetro de consulta: GET https://www.googleapis.com/drive/v3/apps?languageCode=en-us,fr-ca.

Conseguir o app do usuário por ID

Para fazer o download das informações detalhadas do app como uma instância de apps, use o método get() com o ID do app.

Mostrar um exemplo

O exemplo de código a seguir mostra como fornecer um appId como parâmetro de consulta na solicitação. A resposta retorna os valores de campo da solicitação.

Solicitação

GET https://www.googleapis.com/drive/v3/apps/APP_ID

Resposta

{
  "kind": "drive#app",
  "id": "ID",
  "name": "Google Sheets",
  "supportsCreate": true,
  "supportsImport": true,
  "supportsMultiOpen": false,
  "supportsOfflineCreate": true,
  "productUrl": "https://chrome.google.com/webstore/detail/felcaaldnbdncclmgdcncolpebgiejap",
  "productId": "PRODUCT_ID"
}

A resposta inclui os seguintes valores:

  • ID: o ID do app.
  • PRODUCT_ID: o ID da ficha do produto para esse app.

Confira algumas etapas que você pode seguir: