getTemplatesPreviewByMarker

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

Mô tả

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 xem trước mẫu ITemplatePreviewsEntity.

TemplatePreviews.getTemplatesPreviewByMarker(

marker*, langCode

);

Sơ đồ tham số

Sơ đồ

marker(required): string
Marker sản phẩm duy nhất được sử dụng để xác định mẫu. Nếu không được cung cấp, có thể xảy ra hành vi mặc định hoặc lỗi
ví dụ: "template_12345"

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

Ví dụ

Ví dụ tối thiểu

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

Ví dụ với các thuộc tính

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

Ví dụ phản hồi

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

Sơ đồ phản hồi

Sơ đồ: ITemplatePreviewsEntity

id: number
Định danh duy nhất của vị trí.
ví dụ: 3

title: string
Tên của mẫu xem trước.
ví dụ: "Mẫu Sản Phẩm"

proportions: object
Đối tượng chứa thông tin về tỷ lệ mẫu xem trước.
ví dụ:

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

proportions.horizontal: IProportion | null
Tỷ lệ ngang của mẫu xem trước.
ví dụ:

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

proportions.horizontal.width: string | number | null
Chiều rộng của mẫu xem trước.
ví dụ: 100

proportions.horizontal.height: string | number | null
Chiều cao của mẫu xem trước.
ví dụ: 200

proportions.horizontal.alignmentType: string
Loại căn chỉnh của mẫu xem trước.
ví dụ: "center"

proportions.vertical: IProportion | null
Tỷ lệ dọc của mẫu xem trước.
ví dụ:

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

proportions.square: ISquare
Tỷ lệ vuông của mẫu xem trước.
ví dụ:

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

proportions.square.side: number | string
Chiều dài cạnh của mẫu xem trước vuông, có thể là số hoặc chuỗi.
ví dụ: 100

proportions.square.alignmentType: string
Loại căn chỉnh của mẫu xem trước vuông.
ví dụ: "center"

identifier: string
Định danh văn bản cho trường bản ghi.
ví dụ: "preview-templates"

version: number
Số phiên bản của đối tượng.
ví dụ: 1

attributeValues: AttributeType
Giá trị thuộc tính từ chỉ mục.
ví dụ:

position: number
Vị trí của đối tượng.
ví dụ: 1

isUsed: boolean
Chỉ ra liệu mẫu xem trước có được sử dụng hay không.
ví dụ: true

attributeSetIdentifier: string | null
Định danh văn bản được sử dụng cho một tập hợp thuộc tính.
ví dụ: "attribute_set_1"

---