Pesquisar marcadores

Sua organização pode ter vários rótulos, com vários campos. A API Google Drive Labels fornece o labels recurso para permitir a leitura de rótulos.

Este documento descreve como pesquisar e recuperar rótulos usando a API Drive Labels.

Métodos

O recurso labels fornece os seguintes métodos para ler valores de rótulos, cada um com uma tarefa específica:

Intervalo Método
Rótulo único por nome do recurso labels.get
Todos os rótulos labels.list

Receber rótulo por nome do recurso

Para receber um único rótulo pelo nome do recurso, use o get método no labels recurso.

Um recurso de rótulo name é obrigatório e pode ser estruturado como:

  • labels/{id} ou labels/{id}@latest: recebe a revisão mais recente do rótulo.
  • labels/{id}@published: recebe a revisão publicada atual do rótulo.
  • labels/{id}@{revisionId}: recebe o rótulo no ID de revisão especificado.

É necessário especificar um LabelView objeto como LABEL_VIEW_FULL para definir uma visualização de recurso que é aplicada às respostas de rótulo. LABEL_VIEW_FULL retorna todos os campos possíveis.

O exemplo de código a seguir mostra como usar o name do rótulo para receber um único rótulo pelo nome do recurso:

Python

# Label name, with or without revision:
#
# Revision specified:
# labels/LABEL_ID@published
# labels/LABEL_ID@latest
# labels/LABEL_ID@1
#
# No revision specified, returns latest revision:
# labels/LABEL_ID
name = 'labels/NAME@published'

# Label view controls level of data in response
view = 'LABEL_VIEW_FULL'

label = service.labels().get(
    name=name,
    view=view
).execute()

Node.js

// Label name, with or without revision:
//
// Revision specified:
// labels/LABEL_ID@published
// labels/LABEL_ID@latest
// labels/LABEL_ID@1
//
// No revision specified, returns latest revision:
// labels/LABEL_ID
const name = 'labels/NAME@published';

// Label view controls level of data in response
const view = 'LABEL_VIEW_FULL';

service.labels.get({
  name: name,
  view: view
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Substitua NAME pelo nome do rótulo.

Listar todos os rótulos

Para receber uma lista de rótulos, use o list método no labels recurso.

Você também precisa especificar:

  • Um customer parâmetro de consulta para definir o escopo dessa solicitação de lista. Se customer não estiver definido, todos os rótulos do cliente atual serão retornados.

  • Um LabelView objeto como LABEL_VIEW_FULL para definir uma visualização de recurso que é aplicada às respostas de rótulo. LABEL_VIEW_FULL retorna todos os campos possíveis.

O exemplo de código a seguir mostra como usar o parâmetro de consulta customer para receber uma lista de rótulos:

Python

response = service.labels().list(
    customer='customers/CUSTOMER',
    view='LABEL_VIEW_FULL'
).execute()

Node.js

const params = {
  customer: 'customers/CUSTOMER',
  view: 'LABEL_VIEW_FULL'
};

service.labels.list(params, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  const labels = res.data.labels;
  if (labels) {
    labels.forEach((label) => {
      const name = label.name;
      const title = label.properties.title;
      console.log(`${name}\t${title}`);
    });
  } else {
    console.log('No Labels');
  }
});

Substitua CUSTOMER pelo nome do cliente.