getTemplatePreviewByMarker

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

الوصف

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

.getTemplatePreviewByMarker(

,

);

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

المخطط

marker(مطلوب): string
العلامة الفريدة للمنتج المستخدمة لتحديد القالب. إذا لم يتم توفيرها، قد يحدث سلوك افتراضي أو خطأ
مثال: "template_12345"

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

أمثلة

مثال بسيط

const response = await TemplatePreviews.getTemplatePreviewByMarker('my-marker');

مثال مع السمات

const response = await TemplatePreviews.getTemplatePreviewByMarker('my-marker', 'en_US');

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

{
  "id": 3,
  "title": "Preview Templates",
  "proportions": {
    "default": {
      "horizontal": {
        "width": 234,
        "height": 324,
        "alignmentType": "middleBottom",
        "weight": 234
      },
      "vertical": {
        "width": 2,
        "height": 3,
        "alignmentType": "leftTop",
        "weight": 2
      },
      "square": {
        "side": 360,
        "alignmentType": "middleMiddle"
      },
      "default": true
    }
  },
  "identifier": "preview-templates",
  "version": 1,
  "position": 1,
  "isUsed": true
}

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

المخطط: ITemplatePreviewsEntity

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

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

proportions: object
كائن يحتوي على معلومات حول نسب معاينة القالب.
مثال:

{
  "default": {
    "horizontal": {
      "width": 234,
      "height": 324,
      "alignmentType": "middleBottom"
    },
    "vertical": {
      "width": 2,
      "height": 3,
      "alignmentType": "leftTop"
    },
    "square": {
      "side": 3,
      "alignmentType": "leftTop"
    }
  }
}

proportions.horizontal: IProportion | null
النسبة الأفقية لمعاينة القالب.
مثال:

{
  "width": 234,
  "height": 324,
  "alignmentType": "middleBottom"
}

proportions.horizontal.width: string | number | null
عرض معاينة القالب.
مثال: 100

proportions.horizontal.height: string | number | null
ارتفاع معاينة القالب.
مثال: 200

proportions.horizontal.alignmentType: string
نوع المحاذاة لمعاينة القالب.
مثال: "center"

proportions.vertical: IProportion | null
النسبة الرأسية لمعاينة القالب.
مثال:

{
  "width": 2,
  "height": 3,
  "alignmentType": "leftTop"
}

proportions.square: ISquare
النسبة المربعة لمعاينة القالب.
مثال:

{
  "side": 3,
  "alignmentType": "leftTop"
}

proportions.square.side: number | string
طول جانب معاينة القالب المربع، يمكن أن يكون رقمًا أو سلسلة.
مثال: 100

proportions.square.alignmentType: string
نوع المحاذاة لمعاينة القالب المربع.
مثال: "center"

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

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

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

isUsed: boolean
تشير إلى ما إذا كانت معاينة القالب مستخدمة.
مثال: true

---