Поиск ярлыков

В вашей организации может быть несколько меток, каждая из которых может содержать несколько полей. API меток предоставляет коллекцию labels для их чтения.

На этой странице описывается, как искать и извлекать метки.

Методы

Коллекция labels предоставляет следующие методы считывания значений меток, каждый из которых предназначен для определенной задачи:

Диапазон Чтение
Единая метка по названию ресурса labels.get
Все этикетки labels.list

Получить метку по названию ресурса

Чтобы получить отдельную метку по имени ее ресурса, используйте метод labels.get .

Имя ресурса метки является обязательным и может иметь следующую структуру:

  • labels/{id} или labels/{id}@latest — получает последнюю версию этикетки.
  • labels/{id}@published — Получает текущую опубликованную версию этикетки.
  • labels/{id}@{revisionId} — получает метку по указанному идентификатору ревизии.

Также необходимо указать:

  • LabelView — это LABEL_VIEW_FULL , чтобы задать представление ресурсов, применяемое к ответам на метки. LABEL_VIEW_FULL возвращает все возможные поля.

В этом примере используется Name для получения одной метки по имени ее ресурса.

Питон 

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

Список всех меток

Чтобы получить список меток, используйте метод labels.list .

Также необходимо указать:

  • customer , к которому относится этот запрос списка. Если customer не задан, возвращаются все метки для текущего клиента.

  • LabelView — это LABEL_VIEW_FULL , чтобы задать представление ресурсов, применяемое к ответам на метки. LABEL_VIEW_FULL возвращает все возможные поля.

В этом примере CUSTOMER используется для получения списка меток.

Питон 

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