getProductBlockById
Dapatkan objek ContentPageBlock berdasarkan pengenal produk.
Deskripsi
Metode ini mendapatkan objek blok produk berdasarkan id produk. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi array objek blok produk IProductBlock.
Produk.getProductBlockById(
id*);
Skema parameter
Skema
id(diperlukan): number
Id produk
contoh: 12345
Contoh
Contoh minimal
const response = await Products.getProductBlockById(1764);
Contoh respons
[
{
"id": 1,
"attributeSetIdentifier": null,
"localizeInfos": {
"title": "Product Block"
},
"version": 0,
"position": 1,
"identifier": "product_block",
"type": "product_block",
"customSettings": {
"productConfig": {
"quantity": "1",
"sortType": 0,
"sortOrder": 0,
"countElementsPerRow": "1"
},
"similarProductRules": [],
"condition": {
"name": "cost",
"costTo": 130,
"costFrom": 0
},
"sliderDelay": null,
"sliderDelayType": null
},
"templateIdentifier": null,
"isVisible": true,
"isSync": false,
"attributeValues": {}
},
{
"id": 4,
"attributeSetIdentifier": "block",
"localizeInfos": {
"title": "test"
},
"version": 31,
"position": 2,
"identifier": "test",
"type": "common_block",
"customSettings": {
"productConfig": {},
"similarProductRules": [],
"condition": {},
"sliderDelay": null,
"sliderDelayType": null
},
"templateIdentifier": null,
"isVisible": true,
"isSync": true,
"attributeValues": {
"block-text": {
"type": "string",
"value": "some text",
"position": 0,
"additionalFields": {}
},
"interval": {
"type": "timeInterval",
"value": [
{
"values": [
{
"id": "bbc82c9f-1bc4-4c86-b83c-c062016eb7cb",
"dates": [
"2025-04-14T00:00:00.000Z",
"2025-04-14T00:00:00.000Z"
],
"times": [
[
{
"hours": 9,
"minutes": 0
},
{
"hours": 10,
"minutes": 0
}
],
[
{
"hours": 10,
"minutes": 0
},
{
"hours": 11,
"minutes": 0
}
],
[
{
"hours": 11,
"minutes": 0
},
{
"hours": 12,
"minutes": 0
}
],
"..."
],
"intervals": [],
"exceptions": [],
"intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12",
"inEveryWeek": true,
"inEveryMonth": true,
"timeIntervals": [
[
"2025-04-07T09:00:00.000Z",
"2025-04-07T10:00:00.000Z"
],
[
"2025-04-07T10:00:00.000Z",
"2025-04-07T11:00:00.000Z"
],
[
"2025-04-07T11:00:00.000Z",
"2025-04-07T12:00:00.000Z"
],
"..."
]
}
],
"intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12"
}
],
"position": 1,
"additionalFields": {}
}
}
},
{
"id": 2,
"attributeSetIdentifier": "block",
"localizeInfos": {
"title": "similar"
},
"version": 31,
"position": 3,
"identifier": "similar",
"type": "similar_products_block",
"customSettings": {
"productConfig": {
"countElementsPerRow": "1"
},
"similarProductRules": [
{
"id": "812ee2bb-a90f-4743-9643-663f87acedf5",
"title": "",
"pageUrls": [],
"statusMarker": "",
"conditionValue": "Blue",
"attributeMarker": "nameofproduct_3",
"conditionMarker": "in"
}
],
"condition": {},
"sliderDelay": null,
"sliderDelayType": null
},
"templateIdentifier": "block-template",
"isVisible": true,
"isSync": true,
"attributeValues": {
"block-text": {
"type": "string",
"value": "",
"position": 0,
"additionalFields": {}
},
"interval": {
"type": "timeInterval",
"value": "",
"position": 1,
"additionalFields": {}
}
}
}
]
Skema respons
Skema: IProductBlock
id: number
Pengenal unik dari blok produk.
contoh: 3289
attributeSetIdentifier: string | null
Pengenal dari set atribut yang digunakan dalam blok produk, atau null jika tidak berlaku.
contoh: "product_block"
localizeInfos: ILocalizeInfo
Informasi lokalisasi untuk blok produk.
contoh:
{
"title": "Box"
}
version: number
Versi dari entitas blok produk.
contoh: 1
position: number
Posisi blok produk dalam daftar atau tata letak.
contoh: 1
identifier: string
Pengenal string unik untuk blok produk.
contoh: "product_block_12345"
type: BlockType
Tipe blok produk, seperti "produk", "halaman_error", dll.
contoh: "produk"
customSettings: object
Pengaturan kustom untuk blok produk, termasuk penundaan slider, konfigurasi produk, aturan produk serupa, dan kondisi.
contoh:
{}
templateIdentifier: string | null
Pengenal untuk template yang digunakan oleh blok produk, atau null jika tidak berlaku.
contoh: "template_12345"
isVisible: boolean
Menunjukkan apakah blok produk terlihat.
contoh: true
isSync: boolean
Menunjukkan apakah blok produk disinkronkan.
contoh: false
attributeValues: IAttributeValues
Array nilai atribut dari indeks, yang direpresentasikan sebagai pasangan id atribut pengguna dan nilai atribut.
contoh:
[
{
"id": "color",
"value": "red"
}
]
sliderDelay: number | null
Penundaan auto-maju slider.
contoh: 5000
sliderDelayType: string | null
Satuan dari sliderDelay (misalnya "ms", "s").
contoh: "ms"
productConfig: IProductBlockProductConfig
Konfigurasi tata letak untuk produk di dalam blok.
productConfig.quantity: string | number
Jumlah produk yang akan dirender.
contoh: 9
productConfig.countElementsPerRow: string | number
Produk per baris.
contoh: 3
productConfig.sortType: string | number
Bidang pengurutan.
contoh: "harga"
productConfig.sortOrder: string | number
Arah pengurutan.
contoh: "ASC"
similarProductRules: IProductBlockSimilarRule[]
Aturan yang digunakan untuk menemukan produk serupa.
similarProductRules.property: string
Properti produk untuk dicocokkan.
contoh: "kategori"
similarProductRules.includes: string
Strategi pencocokan (misalnya "any", "all").
contoh: "any"
similarProductRules.keywords: string
Kata kunci yang digunakan untuk pencocokan.
contoh: "foo,bar"
similarProductRules.strict: string
Flag ketelitian ("true"/"false") dari pencocokan.
contoh: "false"
condition: Record<string, unknown>
Kondisi filter yang diterapkan pada produk dalam blok; set bidang bervariasi berdasarkan jenis kondisi (misalnya { name: "cost", costFrom: 0, costTo: 130 }).
frequentlyOrderedConfig: Record<string, unknown> | null
Konfigurasi untuk fitur produk yang sering dipesan, atau null jika tidak dikonfigurasi.
quantity: string | number
Jumlah produk yang akan dirender.
contoh: 9
countElementsPerRow: string | number
Produk per baris.
contoh: 3
sortType: string | number
Bidang pengurutan.
contoh: "harga"
sortOrder: string | number
Arah pengurutan.
contoh: "ASC"
property: string
Properti produk untuk dicocokkan.
contoh: "kategori"
includes: string
Strategi pencocokan (misalnya "any", "all").
contoh: "any"
keywords: string
Kata kunci yang digunakan untuk pencocokan.
contoh: "foo,bar"
strict: string
Flag ketelitian ("true"/"false") dari pencocokan.
contoh: "false"