انتقل إلى المحتوى الرئيسي

getTemplateByMarker

الحصول على كائن قالب واحد بواسطة العلامة.

الوصف

تسترجع هذه الطريقة كائن قالب واحد بناءً على معرفه (العلامة) من واجهة برمجة التطبيقات. تعيد Promise التي تحل إلى كائن قالب ITemplateEntity.

Templates.getTemplateByMarker(

marker*, langCode

);

مخطط المعلمات

المخطط

marker(مطلوب): string
العلامة الفريدة للقالب الذي سيتم استرجاعه
مثال: "template_12345"

langCode: string
رمز اللغة. الافتراضي: "en_US"
مثال: "en_US"

أمثلة

مثال بسيط

const response = await Templates.getTemplateByMarker('my-marker');

مثال مع خاصية langCode

const response = await Templates.getTemplateByMarker('my-marker', 'en_US');

استجابة المثال

{
"id": 4,
"attributeSetIdentifier": null,
"title": "Template",
"generalTypeId": 4,
"identifier": "template",
"version": 0,
"generalTypeName": "catalog_page",
"attributeValues": {},
"position": 1
}

مخطط الاستجابة

المخطط: ITemplateEntity

id: number
المعرف الفريد للموقع.
مثال: 12345

attributeSetIdentifier: string | null
مجموعة معرفات السمات.
مثال: "attribute_set_1"

title: string
اسم القالب.
مثال: "قالب المنتج"

generalTypeId: number
معرف الكيان العام.
مثال: 67890

identifier: string
المعرف النصي لحقل السجل.
مثال: "template_12345"

version: number
رقم إصدار الكائن.
مثال: 1

generalTypeName: BlockType
اسم النوع العام.
مثال: "منتج"

attributeValues: IAttributeValues
خريطة لقيم السمات مفاتيحها العلامة؛ كائن فارغ عند عدم وجودها.
مثال:

{
"id": 1,
"value": "some"
}

position: number
موضع الكائن.
مثال: 1