Termos e operadores da consulta de pesquisa

Este guia de referência fornece termos e operadores de consulta que podem ser usados com a API Google Drive para filtrar arquivos, pastas e drives compartilhados.

Para conferir exemplos de pesquisa de arquivos, consulte Pesquisar arquivos e pastas.

Para ver exemplos de pesquisas de drives compartilhados, consulte Pesquisar drives compartilhados.

Sintaxe da string de consulta

Uma string de consulta contém as três partes a seguir:

query_term operator values

Em que:

  • query_term é o termo ou campo de consulta a ser pesquisado.

  • operator especifica a condição para o termo da consulta.

  • values são os valores específicos que você quer usar para filtrar os resultados da pesquisa.

Operadores de consulta

A tabela a seguir lista os operadores de consulta válidos:

Operador Uso
contains O conteúdo de uma string está presente na outra.
= O conteúdo de uma string ou um booleano é igual ao do outro.
!= O conteúdo de uma string ou booleano não é igual ao outro.
< Um valor é menor que outro.
<= Um valor é menor ou igual a outro.
> Um valor é maior que outro.
>= Um valor é maior ou igual a outro.
in Um elemento está contido em uma coleção.
and Retorna itens que correspondem às duas consultas.
or Retorna itens que correspondem a qualquer uma das consultas.
not Nega uma consulta de pesquisa.
has Uma coleção contém um elemento que corresponde aos parâmetros.

Termos de consulta específicos do arquivo

A tabela a seguir lista todos os termos de consulta de arquivo válidos. Para tipos e descrições de dados, consulte a referência de recursos files.

Termo de consulta Operadores válidos Uso
name contains, =, != Nome do arquivo. Coloque aspas simples (') e evite aspas simples em consultas com \', como 'Valentine\'s Day'.
fullText contains Se as propriedades name, description, indexableText ou o texto no conteúdo ou nos metadados do arquivo correspondem. Use aspas simples ('). Use \' para escapar de aspas simples em consultas, como 'Valentine\'s Day'.
mimeType contains, =, != Tipo MIME do arquivo. Use aspas simples ('). Use \' para escapar de aspas simples em consultas, como 'Valentine\'s Day'. Para mais informações sobre os tipos MIME, consulte Tipos MIME compatíveis com o Google Workspace e o Google Drive.
modifiedTime <=, <, =, !=, >, >= Data da última modificação do arquivo. Formato RFC 3339, o fuso horário padrão é UTC, como 2012-06-04T12:00:00-08:00. Os campos do tipo date não são comparáveis entre si, apenas a datas constantes.
viewedByMeTime <=, <, =, !=, >, >= Data da última vez que o usuário acessou um arquivo. Formato RFC 3339, o fuso horário padrão é UTC, como 2012-06-04T12:00:00-08:00. Os campos do tipo date não são comparáveis entre si, apenas a datas constantes.
trashed =, != Se o arquivo está na lixeira ou não. Pode ser true ou false.
starred =, != Se o arquivo tem ou não estrela. Pode ser true ou false.
parents in Se a coleção principal contém o ID especificado.
owners in Usuários que são proprietários do arquivo.
writers in Usuários ou grupos que têm permissão para modificar o arquivo. Consulte a referência do recurso permissions.
readers in Usuários ou grupos que têm permissão para ler o arquivo. Consulte a referência do recurso permissions.
sharedWithMe =, != Arquivos que estão na coleção "Compartilhados comigo" do usuário. Todos os usuários do arquivo estão na lista de controle de acesso (ACL) do arquivo. Pode ser true ou false.
createdTime <=, <, =, !=, >, >= Data de criação do drive compartilhado. Use o formato RFC 3339. O fuso horário padrão é UTC, como 2012-06-04T12:00:00-08:00.
properties has Propriedades de arquivo personalizadas públicas.
appProperties has Propriedades de arquivo personalizadas particulares.
visibility =, != O nível de visibilidade do arquivo. Os valores válidos são anyoneCanFind, anyoneWithLink, domainCanFind, domainWithLink e limited. Coloque o texto entre aspas simples (').
shortcutDetails.targetId =, != O ID do item para o qual o atalho aponta.

Confira a seguir as combinações de operador e termo de consulta:

  • O operador contains só executa a correspondência de prefixo para um termo name. Por exemplo, suponha que você tenha um nome de HelloWorld. Uma consulta de name contains 'Hello' retorna um resultado, mas uma consulta de name contains 'World' não.

  • O operador contains só realiza a correspondência em tokens de string inteiros para o termo fullText. Por exemplo, se o texto completo de um documento contiver a string "HelloWorld", somente a consulta fullText contains 'HelloWorld' vai retornar um resultado.

  • O operador contains corresponde a uma frase alfanumérica exata se ela estiver entre aspas duplas. Por exemplo, se o fullText de um documento tiver a string "Hello there world", a consulta fullText contains '"Hello there"' retornará um resultado, mas a consulta fullText contains '"Hello world"' não. Além disso, como a pesquisa é alfanumérica, se o texto completo de um documento contiver a string "Hello_world", a consulta fullText contains '"Hello world"' vai retornar um resultado.

  • Os termos owners, writers e readers são refletidos indiretamente na lista permissions e se referem ao role na permissão. Para conferir uma lista completa de permissões de função, consulte Papéis e permissões.

Para mais exemplos de pesquisas de strings de consulta de arquivo, consulte exemplos de strings de consulta de arquivo.

Termos de consulta específicos de drives compartilhados

A tabela a seguir lista todos os termos de consulta válidos para o Drive compartilhado. Para tipos e descrições de dados, consulte a referência de recurso drives.

Termo de consulta Operadores válidos Uso Configuração de useDomainAdminAccess
createdTime <=, <, =, !=, >, >= Data de criação do drive compartilhado. RFC 3339, o fuso horário padrão é UTC, como 2012-06-04T12:00:00-08:00. true
hidden =, != Especifica se o drive compartilhado está oculto. Pode ser true ou false. false
memberCount <=, <, =, !=, >, >= Número de usuários e grupos que são membros do drive compartilhado. Recebe um valor numérico. true
name contains, =, != Nome do drive compartilhado. Use aspas simples ('). Use \' para escapar de aspas simples em consultas, como 'Valentine\'s Day'. true
organizerCount <=, <, =, !=, >, >= Número de usuários e grupos que são organizadores do drive compartilhado. Recebe um valor numérico. true
orgUnitId =, != O ID da unidade organizacional de um drive compartilhado. Recebe um valor de string. true

Para mais exemplos de pesquisas de string de consulta, consulte exemplos de string de consulta de drives compartilhados.