Wyszukaj etykiety

Twoja organizacja może mieć wiele etykiet, a każda z nich może mieć kilka pól. Interfejs API etykiet w Dysku Google udostępnia zasób labels, który umożliwia odczytywanie etykiet.

Z tego dokumentu dowiesz się, jak wyszukiwać i pobierać etykiety za pomocą interfejsu Drive Labels API.

Metody

Zasób labels udostępnia te metody odczytywania wartości etykiet, z których każda ma określone zadanie:

Zakres Metoda
Pojedyncza etykieta według nazwy zasobu labels.get
Wszystkie etykiety labels.list

Pobieranie etykiety według nazwy zasobu

Aby pobrać pojedynczą etykietę według jej nazwy zasobu, użyj metody get w zasobie labels.

Wymagany jest zasób etykiety name, który może mieć taką strukturę:

  • labels/{id} lub labels/{id}@latest: pobiera najnowszą wersję etykiety.
  • labels/{id}@published: pobiera bieżącą opublikowaną wersję etykiety.
  • labels/{id}@{revisionId}: pobiera etykietę o określonym identyfikatorze wersji.

Aby ustawić widok zasobu, który jest stosowany do odpowiedzi etykiet, musisz określić obiekt LabelView jako LABEL_VIEW_FULL. LABEL_VIEW_FULL zwraca wszystkie możliwe pola.

Poniższy przykładowy kod pokazuje, jak użyć etykiety name, aby pobrać pojedynczą etykietę według jej nazwy zasobu:

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

Zastąp NAME nazwą etykiety.

Wyświetlanie listy wszystkich etykiet

Aby uzyskać listę etykiet, użyj metody list w zasobie labels.

Musisz też określić:

  • Parametr zapytania customer , aby ograniczyć zakres tego żądania listy. Jeśli parametr customer nie jest ustawiony, zwracane są wszystkie etykiety w ramach bieżącego klienta.

  • Obiekt LabelView jako LABEL_VIEW_FULL, aby ustawić widok zasobu, który jest stosowany do odpowiedzi etykiet. LABEL_VIEW_FULL zwraca wszystkie możliwe pola.

Poniższy przykładowy kod pokazuje, jak użyć parametru zapytania customer, aby uzyskać listę etykiet:

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

Zastąp CUSTOMER nazwą klienta.