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

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

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

الطُرق

توفّر مجموعة labels ال methods التالية لقراءة قيم التصنيفات، ولكل منها مهمة محدّدة:

النطاق القراءة
تصنيف واحد حسب اسم المورد 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');
  }
});