getRootPages
Lấy tất cả các đối tượng trang cấp cao nhất (parentId = null).
Mô tả
Phương thức này truy xuất tất cả các đối tượng trang cấp cao nhất từ API. Nó trả về một Promise mà khi hoàn thành sẽ trả về một mảng các đối tượng trang cấp cao nhất IPagesEntity hoặc một mảng rỗng [] nếu không có dữ liệu.
Pages.getRootPages(langCode);
Sơ đồ tham số
Sơ đồ
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 Pages.getRootPages();
Ví dụ phản hồi
[
{
"id": 8,
"config": {},
"depth": 0,
"parentId": null,
"pageUrl": "blog",
"attributeSetIdentifier": "page",
"localizeInfos": {
"title": "Blog",
"htmlContent": "",
"plainContent": "",
"menuTitle": "Blog"
},
"isVisible": true,
"products": 0,
"childrenCount": 2,
"type": "common_page",
"position": 1,
"templateIdentifier": "template",
"isSync": true,
"categoryPath": "blog",
"rating": {},
"attributeValues": {
"text": {
"type": "string",
"value": "some text",
"isIcon": false,
"position": 0,
"additionalFields": {},
"isProductPreview": false
},
"number": {
"type": "integer",
"value": 5,
"isIcon": false,
"position": 1,
"additionalFields": {},
"isProductPreview": false
},
"real": {
"type": "real",
"value": "10",
"isIcon": false,
"position": 2,
"additionalFields": {},
"isProductPreview": false
},
"float": {
"type": "float",
"value": 12,
"isIcon": false,
"position": 3,
"additionalFields": {},
"isProductPreview": false
}
},
"moduleFormConfigs": [
{
"id": 9,
"formIdentifier": "full_form",
"moduleIdentifier": "content",
"isGlobal": false,
"isClosed": false,
"isModerate": true,
"viewOnlyMyData": false,
"commentOnlyMyData": false,
"entityIdentifiers": [
{
"id": "blog",
"isNested": false
}
],
"formDataCount": 4827,
"ratingCalculation": "average",
"allowHalfRatings": null,
"maxRatingScale": null,
"isAnonymous": null,
"allowRerating": null,
"isRating": null,
"entityFormDataCount": {
"blog": 4827
},
"nestedEntityIdentifiers": [],
"exceptionIds": []
},
{
"id": 3,
"formIdentifier": "file_form",
"moduleIdentifier": "content",
"isGlobal": false,
"isClosed": false,
"isModerate": false,
"viewOnlyMyData": false,
"commentOnlyMyData": false,
"entityIdentifiers": [
{
"id": "blog",
"isNested": false
}
],
"formDataCount": 556,
"ratingCalculation": "average",
"allowHalfRatings": null,
"maxRatingScale": null,
"isAnonymous": null,
"allowRerating": null,
"isRating": null,
"entityFormDataCount": {
"blog": 556
},
"nestedEntityIdentifiers": [],
"exceptionIds": []
},
{
"id": 2,
"formIdentifier": "test-form",
"moduleIdentifier": "content",
"isGlobal": false,
"isClosed": false,
"isModerate": false,
"viewOnlyMyData": false,
"commentOnlyMyData": false,
"entityIdentifiers": [
{
"id": "blog",
"isNested": false
}
],
"formDataCount": 775,
"ratingCalculation": "average",
"allowHalfRatings": null,
"maxRatingScale": null,
"isAnonymous": null,
"allowRerating": null,
"isRating": null,
"entityFormDataCount": {
"blog": 775
},
"nestedEntityIdentifiers": [],
"exceptionIds": []
}
],
"template": {
"id": 4,
"attributeSetIdentifier": null,
"title": "Template",
"generalTypeId": 4,
"identifier": "template",
"version": 0,
"generalTypeName": "catalog_page",
"attributeValues": {},
"position": 1
}
},
{
"id": 10,
"config": {},
"depth": 0,
"parentId": null,
"pageUrl": "catalog",
"attributeSetIdentifier": "page",
"localizeInfos": {
"title": "Catalog",
"htmlContent": "",
"plainContent": "",
"menuTitle": "Catalog"
},
"isVisible": true,
"products": 6,
"childrenCount": 0,
"type": "catalog_page",
"position": 2,
"templateIdentifier": "template",
"isSync": true,
"categoryPath": "catalog",
"rating": {},
"attributeValues": {
"text": {
"type": "string",
"value": "catalog text",
"isIcon": false,
"position": 0,
"additionalFields": {},
"isProductPreview": false
},
"number": {
"type": "integer",
"value": 10,
"isIcon": false,
"position": 1,
"additionalFields": {},
"isProductPreview": false
},
"real": {
"type": "real",
"value": "5",
"isIcon": false,
"position": 2,
"additionalFields": {},
"isProductPreview": false
},
"float": {
"type": "float",
"value": 15,
"isIcon": false,
"position": 3,
"additionalFields": {},
"isProductPreview": false
}
},
"moduleFormConfigs": [],
"template": {
"id": 4,
"attributeSetIdentifier": null,
"title": "Template",
"generalTypeId": 4,
"identifier": "template",
"version": 0,
"generalTypeName": "catalog_page",
"attributeValues": {},
"position": 1
}
},
{
"id": 50,
"config": {},
"depth": 0,
"parentId": null,
"pageUrl": "test",
"attributeSetIdentifier": null,
"localizeInfos": {
"title": "Test",
"htmlContent": "",
"plainContent": "",
"menuTitle": "Test"
},
"isVisible": true,
"products": 0,
"childrenCount": 0,
"type": "common_page",
"position": 3,
"templateIdentifier": null,
"isSync": false,
"categoryPath": "test",
"rating": {},
"attributeValues": {},
"moduleFormConfigs": []
}
]
Sơ đồ phản hồi
Sơ đồ: IPagesEntity[]
id: number
Định danh của đối tượng.
ví dụ: 8
parentId: number | null
Id của trang cha, nếu chứa null, thì đó là trang cấp cao nhất.
ví dụ: 10
pageUrl: string
Url trang duy nhất.
ví dụ: "blog"
depth: number
Độ sâu lồng ghép của trang so với parentId.
ví dụ: 10
localizeInfos: ILocalizeInfo
Tên của trang, tính đến việc địa phương hóa.
ví dụ:
{
"title": "Blog",
"menuTitle": "Blog",
"htmlContent": "",
"plainContent": ""
}
isVisible: boolean
Dấu hiệu của sự hiển thị trang.
ví dụ: true
type: PageType
Loại trang.
ví dụ: "common_page"
templateIdentifier: string | null
Id người dùng của mẫu liên kết.
ví dụ: "template"
attributeSetIdentifier: string | null
Tập hợp các id thuộc tính.
ví dụ: "page"
attributeValues: IAttributeValues
Bản đồ các giá trị thuộc tính được đánh chỉ mục theo marker; đối tượng rỗng khi không có.
ví dụ:
{
"text": {
"type": "string",
"value": "some text",
"position": 0,
"additionalFields": []
}
}
isSync: boolean
Chỉ thị về việc lập chỉ mục trang.
ví dụ: true
template: object
Đối tượng mẫu.
ví dụ:
{}
position: number
Số thứ tự mục (để sắp xếp).
ví dụ: 2
config: Record<string, number>
Cài đặt đầu ra cho các trang danh mục.
ví dụ:
{
"rowsPerPage": 1,
"productsPerRow": 1
}
products: number
Số lượng sản phẩm liên kết với trang.
ví dụ: 0
childrenCount: number
Số lượng trẻ em.
ví dụ: 1
blocks: IBlockEntity[] | string[]
các khối.
ví dụ:
{
"id": 4,
"attributeSetIdentifier": null,
"title": "Template",
"generalTypeId": 4,
"identifier": "template",
"version": 0,
"generalTypeName": "catalog_page",
"attributeValues": {},
"position": 1
}
blocks.attributeValues: IAttributeValues
Bản đồ các giá trị thuộc tính được đánh chỉ mục theo marker; đối tượng rỗng khi không có.
ví dụ:
{
"block-text": {
"type": "string",
"value": "some text",
"isIcon": false,
"position": 0,
"additionalFields": [],
"isProductPreview": false
}
}
blocks.id: number
Định danh duy nhất của khối.
ví dụ: 1234
blocks.localizeInfos: ILocalizeInfo
Thông tin địa phương hóa cho khối.
ví dụ:
{
"key": "value"
}
blocks.version: number
Phiên bản của thực thể khối.
ví dụ: 1
blocks.identifier: string
Định danh chuỗi duy nhất cho khối.
ví dụ: "block1"
blocks.type: BlockType
Loại của khối.
ví dụ: "product"
blocks.position: number
Vị trí của khối để sắp xếp.
ví dụ: 1
blocks.templateIdentifier: string | null
Định danh cho mẫu được sử dụng bởi khối, hoặc null nếu không áp dụng.
ví dụ: "template1"
blocks.isVisible: boolean
Chỉ ra liệu khối có hiển thị hay không.
ví dụ: true
blocks.countElementsPerRow: number
Số lượng phần tử hiển thị trên mỗi hàng trong khối, nếu có.
ví dụ: 3
blocks.quantity: number
Số lượng mục trong khối, nếu có.
ví dụ: 5
blocks.similarProducts: IProductsResponse
Phản hồi chứa các sản phẩm tương tự liên kết với khối.
ví dụ:
{
"total": 10,
"items": []
}
blocks.products: IProductsEntity[]
Mảng các thực thể sản phẩm liên kết với khối.
ví dụ:
[
{
"id": 1,
"name": "Product 1"
},
{
"id": 2,
"name": "Product 2"
}
]
moduleFormConfigs: Array<IFormConfig>
Cấu hình biểu mẫu module liên kết với trang.
rating: IRating
Dữ liệu đánh giá.
total: string
Tổng số sản phẩm liên kết với trang.
ví dụ: "10"
categoryPath: string | null
Chuỗi đường dẫn danh mục; null cho các trang lồng ghép không có đường dẫn danh mục riêng.
ví dụ: "catalog"
Ví dụ sử dụng
Hướng dẫn từng bước trong tài liệu:
- Lấy các trang gốc — truy xuất tất cả các trang cấp cao nhất không có cha.
Thử nghiệm trực tiếp
Chạy phương thức này một cách tương tác trong JS SDK sandbox — kết nối URL Dự án và Mã thông báo Ứng dụng của bạn khi lần đầu truy cập, sau đó mở:
- Lấy các trang gốc — truy xuất tất cả các trang cấp cao nhất không có cha.