Pesquisar marcadores

Sua organização pode ter vários rótulos, cada um com diversos campos. A API Labels fornece a coleção labels para permitir a leitura de marcadores.

Nesta página, descrevemos como pesquisar e recuperar rótulos.

Métodos

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

Receber rótulo pelo nome do recurso

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

O nome de um recurso de marcador é obrigatório e pode ser estruturado da seguinte forma:

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

Você também precisa especificar:

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

Este exemplo usa Name para receber um único rótulo pelo nome do recurso.

# 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()

# 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 receber uma lista de rótulos, use o método labels.list.

Você também precisa especificar:

• Um customer para definir o escopo desta solicitação de lista. Se customer não estiver definido, todas as etiquetas do cliente atual serão retornadas.

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

Neste exemplo, usamos CUSTOMER para recuperar a lista de rótulos.

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

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');
  }
});