يمكن أن يكون لدى مؤسستك تصنيفات متعددة، ويمكن أن تحتوي التصنيفات على عدة حقول.
توفّر Google Drive Labels API المورد
labels لتفعيل
قراءة التصنيفات.
يوضّح هذا المستند كيفية البحث عن التصنيفات واستردادها باستخدام Drive Labels API.
الطُرق
يوفّر المرجع labels الطرق التالية لقراءة قيم التصنيفات،
كلّ منها مخصّص لمهمة معيّنة:
| النطاق | الطريقة |
|---|---|
| تصنيف واحد حسب اسم المورد | labels.get |
| جميع التصنيفات | labels.list |
الحصول على تصنيف حسب اسم المورد
للحصول على تصنيف واحد حسب اسم مصدره، استخدِم طريقة
get على مصدر
labels.
مورد تصنيف name مطلوب ويمكن أن يكون منظَّمًا على النحو التالي:
-
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
const name = 'labels/NAME@published';
// Label view controls level of data in response
const 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);
});
استبدِل NAME باسم التصنيف.
عرض قائمة بجميع التصنيفات
للحصول على قائمة بالتصنيفات، استخدِم طريقة
list في المورد
labels.
يجب أيضًا تحديد ما يلي:
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');
}
});
استبدِل CUSTOMER باسم العميل.