Kuruluşunuzun birden fazla etiketi olabilir. Etiketlerin birkaç alanı olabilir.
Etiketler API, etiketlerin okunmasını sağlamak için labels
koleksiyonunu sağlar.
Bu sayfada, etiketlerin nasıl aranacağı ve alınacağı açıklanmaktadır.
Yöntemler
labels
koleksiyonu, her biri belirli bir görevi göz önünde bulundurarak etiket değerlerini okumak için aşağıdaki yöntemleri sunar:
Aralık | Okuma |
---|---|
Kaynak adına göre tek etiket | labels.get |
Tüm etiketler | labels.list |
Kaynak adına göre etiket alın
Kaynak adına göre tek bir etiket almak için labels.get
yöntemini kullanın.
Gerekli olan bir etiket kaynağı adı şu şekilde yapılandırılabilir:
labels/{id}
veyalabels/{id}@latest
: En son etiket düzeltmesini alır.labels/{id}@published
- Yayınlanan mevcut etiket düzeltmesini alır.labels/{id}@{revisionId}
: Belirtilen düzeltme kimliğindeki etiketi alır.
Ayrıca aşağıdakileri de belirtmeniz gerekir:
- Etiket yanıtlarına uygulanan Kaynak görünümünü ayarlamak için
LabelView
LABEL_VIEW_FULL
değeridir.LABEL_VIEW_FULL
tüm olası alanları döndürür.
Bu örnekte, kaynak adına göre tek bir etiket almak için Name
kullanılmaktadır.
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);
});
Tüm etiketleri listele
Etiketlerin listesini almak için labels.list
yöntemini kullanın.
Ayrıca aşağıdakileri de belirtmeniz gerekir:
Bu liste isteğinin kapsamını belirlemek için
customer
.customer
ayarlanmazsa mevcut müşteri içindeki tüm etiketler döndürülür.Etiket yanıtlarına uygulanan Kaynak görünümünü ayarlamak için
LabelView
LABEL_VIEW_FULL
değeridir.LABEL_VIEW_FULL
tüm olası alanları döndürür.
Bu örnekte, etiket listesini almak için CUSTOMER
kullanılmaktadır.
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');
}
});