Chuyển đến nội dung chính

getPageByUrl

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

Mô tả​

Phương thức này lấy một đối tượng trang đơn dựa trên URL (url) 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.getPageByUrl(

url*, langCode

);

Sơ đồ tham số​

Sơ đồ

url(bắt buộc): string
URL của trang
ví dụ: "about"

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.getPageByUrl('shop');

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

const response = await Pages.getPageByUrl('shop', 'en_US');

Ví dụ phản hồi​

{
  "id": 9,
  "parentId": 8,
  "pageUrl": "blog1",
  "depth": 1,
  "localizeInfos": {
    "title": "Blog 1",
    "menuTitle": "Blog 1",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "blocks": [],
  "type": "common_page",
  "templateIdentifier": null,
  "attributeSetIdentifier": null,
  "attributeValues": {},
  "moduleFormConfigs": [],
  "isSync": false
}

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 nó 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 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ỉ báo 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[]
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: 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 mô-đun 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:

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ã Token Ứng dụng của bạn khi lần đầu truy cập, sau đó mở: