Informações do usuário recorrente

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

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

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

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

Receber 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.

É obrigatório definir o parâmetro de sistema fields no método get para especificar os campos a serem retornados na resposta. Na maioria dos métodos do Drive, essa ação só é necessária para retornar campos não padrão, mas é obrigatória para o recurso about. Se você omitir o parâmetro, o método vai retornar um erro. Para mais informações, consulte Retornar campos específicos.

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 são listados no Google Workspace Marketplace e 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 os 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 parâmetros.

Se você quiser especificar os campos a serem retornados na resposta, defina o parâmetro do sistema fields. Se você não especificar o parâmetro fields, o servidor vai retornar um conjunto padrão de campos. Para mais informações, consulte Retornar campos específicos.

O exemplo de código a seguir 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 página do produto para este 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: filtre os resultados da pesquisa usando uma lista separada por vírgulas de extensões de arquivo. 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 forem fornecidos, uma união das duas listas de apps resultantes será retornada. Exemplos de extensões incluem docx para Microsoft Word e pptx para Microsoft PowerPoint. Para mais exemplos de extensões de arquivo, consulte Exportar tipos MIME para documentos do Google Workspace.

    O exemplo de código a seguir 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: filtre os resultados da pesquisa usando uma lista separada por vírgulas de tipos MIME. Os apps no escopo da consulta que podem abrir os tipos MIME listados são incluídos na resposta. Se appFilterExtensions também forem fornecidos, será retornada uma união das duas listas de apps resultantes. Exemplos de tipos MIME incluem application/vnd.google-apps.form para o Formulários Google 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 a seguir 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: filtre os resultados da pesquisa usando um código de idioma ou 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 a seguir 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.

Receber o app do usuário por ID

Para baixar as informações detalhadas do app como uma instância de apps, use o método get com o ID do app.

O exemplo de código a seguir mostra como fornecer um appId 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/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 página do produto para este app.

Confira algumas das próximas etapas que você pode tentar: