Pesquisar marcadores

Sua organização pode ter vários marcadores, que podem ter vários campos. A API Labels oferece a coleção labels para ativar a leitura de rótulos.

Nesta página, descrevemos como pesquisar e recuperar marcadores.

Métodos

A coleção labels oferece os seguintes métodos para ler valores de rótulo, cada um com uma tarefa específica em mente:

Intervalo Leitura
Rótulo único por nome de recurso labels.get
Todos os rótulos labels.list

Receber rótulo por nome de recurso

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

Um nome de recurso de rótulo é obrigatório e pode ser estruturado da seguinte forma:

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

Também é necessário especificar:

  • LabelView é LABEL_VIEW_FULL para definir a visualização de recursos aplicada às respostas de marcadores. LABEL_VIEW_FULL retorna todos os campos possíveis.

Este exemplo usa Name 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

name = "labels/NAME@published"

# Label view controls level of data in response
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);
});

Listar todos os rótulos

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

Também é necessário especificar:

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

  • LabelView é LABEL_VIEW_FULL para definir a visualização de recursos aplicada às respostas de marcadores. LABEL_VIEW_FULL retorna todos os campos possíveis.

Este exemplo usa CUSTOMER para recuperar a 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');
  }
});