Method: labels.list

Wyświetl etykiety. Więcej informacji znajdziesz w artykule Wyszukiwanie etykiet.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
publishedOnly

boolean

Określa, czy w wynikach mają być uwzględniane tylko opublikowane etykiety.

  • Gdy wartość parametru to true, zwracane są tylko bieżące opublikowane wersje etykiet. Wyłączone etykiety są uwzględnione. Zwrócone nazwy zasobów etykiet odwołują się do opublikowanej wersji (labels/{id}/{revisionId}).
  • Gdy false, zwracane są bieżące wersje etykiety, które mogą nie być opublikowane. Zwrócone nazwy zasobów etykiet nie odwołują się do konkretnej wersji (labels/{id}).
customer

string

Klient, do którego ma być ograniczony zakres tego żądania listy. Na przykład: customers/abcd1234. Jeśli nie zostanie ustawiona, zwróci wszystkie etykiety w bieżącym koncie klienta.
languageCode

string

Kod języka w formacie BCP-47, który ma być używany do oceny zlokalizowanych etykiet pól. Jeśli nie zostanie określony, używane będą wartości w domyślnie skonfigurowanym języku.
pageSize

integer

Maksymalna liczba etykiet do zwrócenia na stronie. Wartość domyślna: 50. Maksymalnie 200.
pageToken

string

Token strony, która ma zostać zwrócona.
view

enum (LabelView)

Jeśli to pole jest określone, zwracane są tylko wybrane pola należące do wskazanego widoku.

Parametr unii access.

access może mieć tylko jedną z tych wartości:
useAdminAccess

boolean

Ustaw wartość true, aby używać danych logowania administratora użytkownika. Zwróci wszystkie etykiety w ramach klienta.
minimumRole

enum (LabelRole)

Określa poziom dostępu, jaki użytkownik musi mieć do zwróconych etykiet. Minimalna rola, jaką użytkownik musi mieć w przypadku etykiety. Domyślna wartość to READER.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź dotycząca etykiet na liście.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
Pola
labels[]

object (Label)

Etykiety.
nextPageToken

string

Token następnej strony w odpowiedzi.

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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

Więcej informacji znajdziesz w przewodniku po autoryzacji.