Kuruluşunuzun birden fazla etiketi olabilir ve etiketlerde çeşitli alanlar bulunabilir.
Labels API, etiketlerin okunmasını sağlamak için
labels
koleksiyonunu sunar.
Bu sayfada, etiketlerin nasıl aranacağı ve alınacağı açıklanmaktadır.
Yöntemler
labels
koleksiyonu, etiket değerlerini okumak için aşağıdaki yöntemleri sunar. Bu yöntemlerin her biri belirli bir görev için tasarlanmıştır:
Aralık | Okuma |
---|---|
Kaynak adına göre tek etiket | labels.get |
Tüm etiketler | labels.list |
Kaynak adına göre etiket alma
Tek bir etiketi kaynak adına göre almak için labels.get
yöntemini kullanın.
Etiket kaynak adı gereklidir ve ş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 şunları da belirtmeniz gerekir:
LabelView
isLABEL_VIEW_FULL
, etiket yanıtlarına uygulanan Kaynak görünümünü ayarlamak için kullanılır.LABEL_VIEW_FULL
olası tüm alanları döndürür.
Bu örnekte, kaynak adına göre tek bir etiket almak için Name
kullanılı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 listeleme
Etiketlerin listesini almak için labels.list
yöntemini kullanın.
Ayrıca şunları da belirtmeniz gerekir:
Bu liste isteğinin kapsamını belirlemek için
customer
.customer
ayarlanmamışsa mevcut müşterideki tüm etiketler döndürülür.LabelView
isLABEL_VIEW_FULL
, etiket yanıtlarına uygulanan Kaynak görünümünü ayarlamak için kullanılır.LABEL_VIEW_FULL
olası tüm alanları döndürür.
Bu örnekte, etiket listesini almak için CUSTOMER
kullanılı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');
}
});