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

يمكن أن يكون لدى مؤسستك تصنيفات متعددة، ويمكن أن تحتوي التصنيفات على عدة حقول. توفّر 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');
  }
});