getPageById

Lấy một đối tượng trang duy nhất với thông tin về các biểu mẫu, khối, menu gắn liền với trang.

Mô tả

Phương thức này lấy một đối tượng trang duy nhất dựa trên định danh (id) của nó từ API. Nó trả về một Promise mà khi hoàn thành sẽ trả về đối tượng trang IPagesEntity, với đối tượng cụ thể phụ thuộc vào loại trang được trả về.

Pages.getPageById(

id*, langCode

);

Sơ đồ tham số

Sơ đồ

id(bắt buộc): số
Định danh duy nhất của trang cần lấy
ví dụ: 1

langCode: chuỗi
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.getPageById(1);

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

const response = await Pages.getPageById(1, 'en_US');

Ví dụ phản hồi

{
  "id": 8,
  "parentId": null,
  "pageUrl": "blog",
  "depth": 0,
  "localizeInfos": {
    "title": "Blog",
    "menuTitle": "Blog",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "blocks": [
    "slider"
  ],
  "type": "common_page",
  "templateIdentifier": "template",
  "attributeSetIdentifier": "page",
  "attributeValues": {
    "text": {
      "type": "string",
      "value": "some text",
      "position": 0,
      "additionalFields": {}
    },
    "number": {
      "type": "integer",
      "value": 0,
      "position": 1,
      "additionalFields": {}
    },
    "real": {
      "type": "real",
      "value": "",
      "position": 2,
      "additionalFields": {}
    },
    "float": {
      "type": "float",
      "value": 0,
      "position": 3,
      "additionalFields": {}
    }
  },
  "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": []
    }
  ],
  "isSync": true,
  "template": {
    "id": 4,
    "attributeSetIdentifier": null,
    "title": "Template",
    "generalTypeId": 4,
    "identifier": "template",
    "version": 0,
    "generalTypeName": "catalog_page",
    "attributeValues": {},
    "position": 1
  }
}

Sơ đồ phản hồi

Sơ đồ: IPagesEntity

id: số
Định danh của đối tượng.
ví dụ: 8

parentId: số | null
Id của trang cha, nếu chứa null, thì đó là trang cấp cao nhất.
ví dụ: 10

pageUrl: chuỗi
Url trang duy nhất.
ví dụ: "blog"

depth: số
Độ 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: chuỗi | null
Id người dùng của mẫu liên kết.
ví dụ: "template"

attributeSetIdentifier: chuỗi | 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 dấu hiệu; đố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: đối tượng
Đối tượng mẫu.
ví dụ:

{}

position: số
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: số
Số lượng sản phẩm liên kết với trang.
ví dụ: 0

childrenCount: số
Số lượng con.
ví dụ: 1

blocks: IBlockEntity[] | chuỗi[]
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 dấu hiệu; đố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: số
Đị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: số
Phiên bản của thực thể khối.
ví dụ: 1

blocks.identifier: chuỗi
Đị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: số
Vị trí của khối để sắp xếp.
ví dụ: 1

blocks.templateIdentifier: chuỗi | 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: số
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: số
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: chuỗi
Tổng số sản phẩm liên kết với trang.
ví dụ: "10"

categoryPath: chuỗi | 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 trang theo ID — lấy một trang CMS duy nhất theo ID số của nó.

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 trang theo ID — lấy một trang CMS duy nhất theo ID số của nó.