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

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

В этом документе описывается, как искать и получать метки с помощью API Drive Labels.

Методы

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

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

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

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

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

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

Для установки представления ресурса, применяемого к ответам с метками, необходимо указать объект LabelView в качестве параметра LABEL_VIEW_FULL . LABEL_VIEW_FULL возвращает все возможные поля.

В следующем примере кода показано, как получить одну метку по имени ресурса, используя name метки:

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

Замените NAME на название этикетки.

Перечислите все метки

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

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

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

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

В следующем примере кода показано, как использовать параметр запроса customer для получения списка меток:

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

Замените CUSTOMER на имя клиента.