Wyszukaj etykiety

Organizacja może mieć wiele etykiet z kilkoma polami. Interfejs Etykiety API udostępnia labels, aby włączyć czytanie etykiet.

Na tej stronie dowiesz się, jak wyszukiwać i pobierać etykiety.

Metody

Kolekcja labels zawiera: Oto metody odczytywania wartości etykiet, z myślą o określonych zadaniach:

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

Pobierz etykietę według nazwy zasobu

Aby uzyskać jedną etykietę według nazwy jej zasobu, użyj funkcji labels.get.

Nazwa zasobu etykiety jest wymagana i może mieć strukturę:

  • labels/{id} lub labels/{id}@latest – pobiera najnowszą wersję etykiety.
  • labels/{id}@published – pobiera aktualnie opublikowaną wersję etykiety.
  • labels/{id}@{revisionId} – pobiera etykietę o podanym identyfikatorze wersji.

Musisz też określić:

  • LabelView to LABEL_VIEW_FULL, aby ustawić widok zasobu stosowany do odpowiedzi etykiet. Funkcja LABEL_VIEW_FULL zwraca wszystkie możliwe pola.

W tym przykładzie użyto obiektu Name, aby uzyskać 1 etykietę według nazwy jej 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

name = "labels/NAME@published"

# Label view controls level of data in response
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);
});

Wyświetl wszystkie etykiety

Aby wyświetlić listę etykiet, użyj funkcji labels.list.

Musisz też określić:

  • customer do tego zakresu żądania listy. Jeśli zasada customer jest nieskonfigurowana, wszystkie etykiety w bieżącej klienci.

  • LabelView to LABEL_VIEW_FULL, aby ustawić widok zasobu stosowany do odpowiedzi etykiet. Funkcja LABEL_VIEW_FULL zwraca wszystkie możliwe pola.

W tym przykładzie użyto elementu CUSTOMER do pobrania listy 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');
  }
});