Method: labels.list

Listar rótulos. Para mais informações, consulte Pesquisar rótulos.

Solicitação HTTP

GET https://drivelabels.googleapis.com/v2/labels

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
publishedOnly

boolean

Se apenas os rótulos publicados serão incluídos nos resultados.

  • Quando true, apenas as revisões de rótulo publicadas atuais são retornadas. Os rótulos desativados estão incluídos. Os nomes de recursos de rótulo retornados fazem referência à revisão publicada (labels/{id}/{revisionId}).
  • Quando false, as revisões de rótulo atuais são retornadas, o que pode não ser publicado. Os nomes de recursos de rótulo retornados não fazem referência a uma revisão específica (labels/{id}).
customer

string

O cliente para restringir esta solicitação de lista. Por exemplo, customers/abcd1234. Se não for definido, vai retornar todos os rótulos do cliente atual.
languageCode

string

O código de idioma BCP-47 a ser usado para avaliar rótulos de campo localizados. Quando não especificados, os valores no idioma padrão configurado são usados.
pageSize

integer

Número máximo de rótulos a serem retornados por página. Padrão: 50. Máximo: 200.
pageToken

string

O token da página a ser retornada.
view

enum (LabelView)

Quando especificado, apenas alguns campos pertencentes à visualização indicada são retornados.

Parâmetro de união access.

access pode ser apenas de um dos tipos a seguir:
useAdminAccess

boolean

Defina como true para usar as credenciais de administrador do usuário. Isso vai retornar todos os rótulos do cliente.
minimumRole

enum (LabelRole)

Especifica o nível de acesso que o usuário precisa ter nos rótulos retornados. A função mínima que um usuário precisa ter em um marcador. O valor padrão é READER.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para listar rótulos.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
Campos
labels[]

object (Label)

Rótulos.
nextPageToken

string

O token da próxima página na resposta.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

Para mais informações, consulte o guia de autorização.