Organizacja może mieć wiele etykiet, które mają kilka pól.
Interfejs Labels API udostępnia kolekcję labels
umożliwiającą odczytywanie etykiet.
Na tej stronie dowiesz się, jak wyszukiwać i pobierać etykiety.
Metody
Kolekcja labels
zawiera następujące metody odczytywania wartości etykiet, z myślą o konkretnych zadaniach:
Zakres | Reading |
---|---|
Pojedyncza etykieta według nazwy zasobu | labels.get |
Wszystkie etykiety | labels.list |
Pobierz etykietę według nazwy zasobu
Aby uzyskać pojedynczą etykietę według nazwy zasobu, użyj metody labels.get
.
Nazwa zasobu etykiety jest wymagana i może mieć taką strukturę:
labels/{id}
lublabels/{id}@latest
– pobiera najnowszą wersję etykiet.labels/{id}@published
– pobiera aktualnie opublikowaną wersję etykiety.labels/{id}@{revisionId}
– pobiera etykietę z określonego identyfikatora wersji.
Musisz też podać:
LabelView
toLABEL_VIEW_FULL
, aby ustawić widok zasobów stosowany do odpowiedzi z etykietami.LABEL_VIEW_FULL
zwraca wszystkie możliwe pola.
W tym przykładzie użyto elementu Name
do uzyskania pojedynczej etykiety według 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
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 listę wszystkich etykiet
Aby uzyskać listę etykiet, użyj metody labels.list
.
Musisz też podać:
Element
customer
określający zakres żądania dotyczącego listy. Jeśli zasadacustomer
jest nieskonfigurowana, zwracane są wszystkie etykiety w obrębie bieżącego klienta.LabelView
toLABEL_VIEW_FULL
, aby ustawić widok zasobów stosowany do odpowiedzi z etykietami.LABEL_VIEW_FULL
zwraca wszystkie możliwe pola.
W tym przykładzie do pobierania listy etykiet używany jest CUSTOMER
.
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');
}
});