البحث عن تصنيفات

يمكن أن يكون لمؤسستك تصنيفات متعددة، تشتمل على عدة حقول. توفر واجهة labels API labels لتفعيل وقراءة التسميات.

توضح هذه الصفحة كيفية البحث عن التصنيفات واستردادها.

الطُرق

توفِّر مجموعة labels الطرق التالية لقراءة قيم التسمية، مع وضع كل مهمة في الاعتبار:

النطاق القراءة
تصنيف واحد حسب اسم المورد labels.get
جميع التصنيفات labels.list

الحصول على تصنيف حسب اسم المورد

للحصول على تصنيف واحد حسب اسم المورد الخاص به، استخدم labels.get.

يجب إدخال اسم مورد التصنيف، ويمكن تنظيمه على النحو التالي:

  • labels/{id} أو labels/{id}@latest: للحصول على أحدث مراجعة للتصنيف.
  • labels/{id}@published: للحصول على النسخة الحالية من التصنيف المنشورة.
  • labels/{id}@{revisionId}: للحصول على التصنيف في رقم تعريف النسخة السابقة المحدّد.

يجب أيضًا تحديد ما يلي:

  • LabelView هو LABEL_VIEW_FULL لضبط طريقة عرض "المورد" التي يتم تطبيقها على الردود على التصنيفات. تعرض LABEL_VIEW_FULL جميع الحقول الممكنة.

يستخدم هذا المثال Name للحصول على تصنيف واحد حسب اسم المورد.

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);
});

سرد جميع التصنيفات

للحصول على قائمة بالتصنيفات، استخدِم labels.list.

يجب أيضًا تحديد ما يلي:

  • customer لتحديد نطاق ذلك طلب القائمة. في حال ترك customer بدون ضبط، ستكون جميع التصنيفات ضمن القيمة الحالية رجوع العملاء.

  • LabelView هو LABEL_VIEW_FULL لضبط طريقة عرض "المورد" التي يتم تطبيقها على الردود على التصنيفات. تعرض الدالة LABEL_VIEW_FULL جميع الحقول الممكنة.

يستخدم هذا المثال 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');
  }
});