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

Ваша организация может иметь несколько ярлыков, причем ярлыки имеют несколько полей. API Labels предоставляет коллекцию 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');
  }
});