Method: labels.list

Список меток. Подробнее см. в разделе Поиск меток .

HTTP-запрос

GET https://drivelabels.googleapis.com/v2/labels

URL использует синтаксис перекодировки gRPC .

Параметры запроса

Параметры
publishedOnly

boolean

Включать ли в результаты только опубликованные метки.

  • При значении true возвращаются только текущие опубликованные версии меток. Отключённые метки включаются. Возвращаемые имена ресурсов меток ссылаются на опубликованную версию ( labels/{id}/{revisionId} ).
  • При значении false возвращаются текущие версии меток, которые могут быть не опубликованы. Возвращаемые имена ресурсов меток не ссылаются на конкретную версию ( labels/{id} ).
customer

string

Клиент, к которому относится этот запрос списка. Например: customers/abcd1234 . Если не задано, будут возвращены все метки для текущего клиента.

languageCode

string

Код языка BCP-47, используемый для оценки локализованных меток полей. Если не указан, используются значения на языке, настроенном по умолчанию.

pageSize

integer

Максимальное количество возвращаемых меток на странице. По умолчанию: 50. Максимально: 200.

pageToken

string

Токен страницы, которую необходимо вернуть.

view

enum ( LabelView )

Если указано, возвращаются только определенные поля, принадлежащие указанному представлению.

access параметрам объединения.

access может быть только одним из следующих:

useAdminAccess

boolean

Установите значение true , чтобы использовать учетные данные администратора пользователя. Это вернет все метки в клиенте.

minimumRole

enum ( LabelRole )

Указывает уровень доступа, который должен иметь пользователь к возвращаемым меткам. Минимальная роль, которую пользователь должен иметь для метки. Значение по умолчанию — READER .

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ на листинговые метки.

В случае успеха тело ответа содержит данные со следующей структурой:

JSON-представление 
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
Поля
labels[]

object ( Label )

Этикетки.

nextPageToken

string

Токен следующей страницы в ответе.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

Более подробную информацию смотрите в Руководстве по авторизации .