Etiket arayın

Kuruluşunuzun birden çok etiketi ve birden fazla 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, etiket değerlerini okumak için her biri belirli bir görevi göz önünde bulunduran 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 - Geçerli yayınlanan etiket düzeltmesini alır.
  • labels/{id}@{revisionId} - Belirtilen düzeltme kimliğindeki etiketi alır.

Şunları da belirtmeniz gerekir:

  • LabelView, etiket yanıtlarına uygulanan Kaynak görünümünü ayarlamak için LABEL_VIEW_FULL değeridir. LABEL_VIEW_FULL, mümkün olan tüm alanları döndürür.

Bu örnekte, kaynak adına göre tek bir etiket almak için Name kullanılmıştı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

Etiket listesini almak için labels.list yöntemini kullanın.

Şunları da belirtmeniz gerekir:

  • Bu liste isteğinin kapsamına alınacak bir customer. customer ayarlanmazsa mevcut müşteri içindeki tüm etiketler döndürülür.

  • LabelView, etiket yanıtlarına uygulanan Kaynak görünümünü ayarlamak için LABEL_VIEW_FULL değeridir. LABEL_VIEW_FULL, mümkün olan tüm alanları döndürür.

Bu örnekte, etiket listesini almak için CUSTOMER kullanılmıştı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');
  }
});