getTemplatesPreviewByMarker

Lấy một đối tượng mẫu theo marker

TemplatePreviews.getTemplatesPreviewByMarker(marker, langCode)

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

Schema

marker:* chuỗi
Marker sản phẩm
ví dụ: my-marker

langCode: chuỗi
Tham số tùy chọn mã ngôn ngữ
ví dụ: en_US

Phương thức này lấy một đối tượng mẫu duy nhất dựa trên định danh văn bản (marker) của nó từ API. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng TemplatePreviewsEntity.

Ví dụ trả về:

{
  "id": 1,
  "version": 0,
  "identifier": "preview-templates",
  "attributeValues": {
    "marker": {
      "value": "",
      "type": "string",
      "position": 1,
      "isProductPreview": false,
      "isIcon": false,
      "attributeFields": {
        "marker": {
          "type": "string",
          "value": "test"
        }
      }
    }
  },
  "attributeSetIdentifier": "my-set",
  "proportion": {
    "vertical": {
      "width": "2",
      "height": "3",
      "alignmentType": "leftTop",
      "marker": "v"
    },
    "horizontal": {
      "width": "234",
      "height": "324",
      "alignmentType": "middleBottom",
      "marker": "h"
    },
    "square": {
      "side": "3",
      "alignmentType": "middleBottom",
      "marker": "s"
    }
  },
  "title": "Preview Templates",
  "position": 1
}

Schema

id: số
định danh đối tượng
ví dụ: 1764

version số
số phiên bản của đối tượng đã được sửa đổi
ví dụ: 10

identifier: chuỗi
định danh văn bản cho một trường trong bản ghi
ví dụ: catalog

proportion ITemplateProportionType
các tham số tỷ lệ mẫu
ví dụ:

{
  "horizontal": {
    "height": 200,
    "weight": 10,
    "marker": "horizontal",
    "title": "Horizontal",
    "alignmentType": "left"
  },
  "vertical": {
    "height": 10,
    "weight": 200,
    "marker": "vertical",
    "title": "Vertical",
    "alignmentType": "left"
  },
  "square": {
    "marker": "square",
    "title": "Square",
    "slide": 3,
    "alignmentType": "center"
  }
}

title: chuỗi
tên mẫu
ví dụ: mẫu trang

positionId đối tượng
số vị trí
ví dụ: 0

positionId: số
định danh đối tượng vị trí
ví dụ: 12