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