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

getTemplateByMarker

الحصول على قالب واحد بواسطة علامته.

الوصف​

يجلب قالبًا حسب علامته ويُعيد ITemplateEntity. إذا لم يوجد قالب بهذه العلامة، يُعيد IError بالقيمة statusCode: 404.

.getTemplateByMarker(

,

);

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

المخطط

marker(مطلوب): string
علامة القالب المراد جلبه.
مثال: "template_12345"

langCode: string
رمز اللغة. الافتراضي: langCode المُمرَّر إلى defineOneEntry ("en_US" إذا لم يُمرَّر).
مثال: "en_US"

أمثلة​

مثال بسيط​

const response = await Templates.getTemplateByMarker('template');

مثال مع langCode​

const response = await Templates.getTemplateByMarker('template', '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
علامة مجموعة السمات، أو null إذا لم تُعيَّن.
مثال: "attribute_set_1"

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

generalTypeId: number
معرّف النوع العام.
مثال: 67890

identifier: string
المعرّف النصي (العلامة) للكائن.
مثال: "template_12345"

version: number
رقم إصدار الكائن؛ يتغير مع كل تحديث.
مثال: 1

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

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

{
  "color": {
    "type": "string",
    "value": "red",
    "isIcon": false,
    "position": 0,
    "additionalFields": {}
  }
}

position: number
موضع الكائن، يُستخدم للفرز.
مثال: 1