getBlockByMarker

Lấy một đối tượng block duy nhất theo marker.

Mô tả

Phương thức này trả về một đối tượng block theo marker. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IBlockEntity.

Blocks.getBlockByMarker(

marker, langCode, offset, limit

);

Sơ đồ tham số

Sơ đồ

marker(bắt buộc): string
Marker của Block
ví dụ: "product_block"

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

offset: number
Tham số cho phân trang. Mặc định: 0
ví dụ: 0

limit: number
Tham số cho phân trang. Mặc định: 30
ví dụ: 30

Ví dụ

Ví dụ tối thiểu

const response = await Blocks.getBlockByMarker('my-marker');

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

const response = await Blocks.getBlockByMarker('my-marker', 'en_US', 0, 30);

Ví dụ phản hồi

{
  "id": 3,
  "localizeInfos": {
    "title": "Block"
  },
  "version": 0,
  "position": 1,
  "identifier": "block",
  "type": "common_block",
  "templateIdentifier": null,
  "isVisible": true,
  "attributeValues": {}
}

Sơ đồ phản hồi

Sơ đồ: IBlockEntity

attributeValues: AttributeType
Loại thuộc tính được sử dụng trong block.
ví dụ:

{
  "block-text": {
    "type": "string",
    "value": "some text",
    "isIcon": false,
    "position": 0,
    "additionalFields": [],
    "isProductPreview": false
  }
}

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

localizeInfos: ILocalizeInfo
Thông tin địa phương hóa cho block.
ví dụ:

{
  "key": "value"
}

version: number
Phiên bản của thực thể block.
ví dụ: 1

identifier: string
Định danh chuỗi duy nhất cho block.
ví dụ: "block1"

type: string
Loại của block, chẳng hạn như 'product', 'error_page', v.v.
ví dụ: "product"

templateIdentifier: string | null
Định danh cho mẫu được sử dụng bởi block, hoặc null nếu không áp dụng.
ví dụ: "template1"

isVisible: boolean
Chỉ ra liệu block có hiển thị hay không.
ví dụ: true

countElementsPerRow: number
Số lượng phần tử hiển thị trên mỗi hàng trong block, nếu có.
ví dụ: 3

quantity: number
Số lượng mặt hàng trong block, nếu có.
ví dụ: 5

similarProducts: IProductsResponse
Phản hồi chứa các sản phẩm tương tự liên quan đến block.
ví dụ:

{
  "total": 10,
  "items": []
}

products: IProductsEntity[]
Mảng các thực thể sản phẩm liên quan đến block.
ví dụ:

[
  {
    "id": 1,
    "name": "Sản phẩm 1"
  },
  {
    "id": 2,
    "name": "Sản phẩm 2"
  }
]

---