Method: labels.list

Wyświetl listę etykiet.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
publishedOnly

boolean

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

  • W przypadku ustawienia true zwracane są tylko aktualnie opublikowane wersje etykiet. Wyłączone etykiety są uwzględniane. Zwracane nazwy zasobów etykiet odnoszą się do opublikowanej wersji (labels/{id}/{revisionId}).
  • Gdy false, zwracane są bieżące wersje etykiet, które mogą nie zostać opublikowane. Nazwy zasobów zwracanych etykiet nie odwołują się do konkretnej wersji (labels/{id}).
customer

string

Klient, do którego należy zawęzić żądanie listy. Na przykład: „customers/abcd1234”. Jeśli zasada jest nieskonfigurowana, zwraca wszystkie etykiety bieżącego klienta.

languageCode

string

Kod języka BCP-47 używany do oceny zlokalizowanych etykiet pól. Jeśli nie określono tego ustawienia, używane są wartości w domyślnym skonfigurowanym języku.

pageSize

integer

Maksymalna liczba etykiet do zwrócenia na stronę. Wartość domyślna: 50. Maks.: 200.

pageToken

string

Token strony do zwrócenia.

view

enum (LabelView)

Po ich określeniu zwracane są tylko niektóre pola należące do wskazanego widoku.

Parametr sumy access.

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

useAdminAccess

boolean

Ustaw jako true, aby móc korzystać z danych logowania administratora użytkownika. Spowoduje to zwrócenie wszystkich etykiet klienta.

minimumRole

enum (LabelRole)

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na wyświetlenie listy etykiet.

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 protokołu 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 na temat autoryzacji.