Etiket arayın

Kuruluşunuzda birden fazla etiket olabilir ve bu etiketlerde birden fazla alan olabilir. Labels 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, etiket değerlerini okumak için her biri belirli bir görevi olan aşağıdaki yöntemleri sağlar:

Aralık Okuma
Kaynak adına göre tek etiket labels.get
Tüm etiketler labels.list

Kaynak adına göre etiket alma

Kaynak adına göre tek bir etiket almak için labels.get yöntemini kullanın.

Etiket kaynağı adı gereklidir ve şu şekilde yapılandırılabilir:

  • labels/{id} veya labels/{id}@latest: En son etiket düzeltmesini alır.
  • labels/{id}@published: Şu anda yayınlanan etiket düzeltmesini alır.
  • labels/{id}@{revisionId}: Belirtilen düzeltme kimliğindeki etiketi alır.

Ayrıca şu bilgileri de belirtmeniz gerekir:

  • LabelView, etiket yanıtlarına uygulanacak kaynak görünümünü ayarlamak için kullanılırLABEL_VIEW_FULL. 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

Etiketleri listelemek için labels.list yöntemini kullanın.

Ayrıca şu bilgileri de belirtmeniz gerekir:

  • Bu liste isteği için kapsamı belirleyen bir customer. customer ayarlanmamışsa geçerli müşterideki tüm etiketler döndürülür.

  • LabelView, etiket yanıtlarına uygulanacak kaynak görünümünü ayarlamak için kullanılırLABEL_VIEW_FULL. LABEL_VIEW_FULL, olası tüm 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');
  }
});