Method: labels.list

Перечислить ярлыки.

HTTP-запрос

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

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

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

Параметры
publishedOnly

boolean

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

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

string

Клиент, на которого будет распространяться запрос этого списка. Например: «клиенты/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

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