انتقل إلى المحتوى الرئيسي

getPageByUrl

الحصول على كائن صفحة واحدة مع معلومات حول النماذج، الكتل، القوائم المرتبطة بالصفحة من خلال URL.

الوصف​

تسترجع هذه الطريقة كائن صفحة واحدة بناءً على URL الخاص بها (url) من واجهة برمجة التطبيقات (API). تعيد Promise التي تحل إلى كائن الصفحة IPagesEntity، مع الكائن المحدد اعتمادًا على نوع الصفحة التي يتم إرجاعها.

Pages.getPageByUrl(

url*, langCode

);

مخطط المعلمات​

المخطط

url(required): string
URL الصفحة
مثال: "about"

langCode: string
رمز اللغة. الافتراضي: "en_US"
مثال: "en_US"

أمثلة​

مثال بسيط​

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

مثال مع السمات​

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

مثال على الاستجابة​

{
  "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
}

مخطط الاستجابة​

المخطط: IPagesEntity

id: number
معرف الكائن.
مثال: 8

parentId: number | null
معرف الصفحة الأم، إذا كان يحتوي على null، فإنه يمثل الصفحة الرئيسية.
مثال: 10

pageUrl: string
URL الصفحة الفريد.
مثال: "blog"

depth: number
عمق تعشيش الصفحة بالنسبة إلى parentId.
مثال: 10

localizeInfos: ILocalizeInfo
اسم الصفحة، مع الأخذ في الاعتبار التوطين.
مثال:

{
  "title": "Blog",
  "menuTitle": "Blog",
  "htmlContent": "",
  "plainContent": ""
}

isVisible: boolean
علامة رؤية الصفحة.
مثال: true

type: PageType
نوع الصفحة.
مثال: "common_page"

templateIdentifier: string | null
معرف المستخدم للقالب المرتبط.
مثال: "template"

attributeSetIdentifier: string | null
مجموعة معرفات السمات.
مثال: "page"

attributeValues: IAttributeValues
خريطة لقيم السمات مفاتيحها بواسطة العلامة؛ كائن فارغ عند عدم وجودها.
مثال:

{
  "text": {
    "type": "string",
    "value": "some text",
    "position": 0,
    "additionalFields": []
  }
}

isSync: boolean
إشارة إلى فهرسة الصفحة.
مثال: true

template: object
كائن القالب.
مثال:

{}

position: number
رقم العنصر (لترتيب).
مثال: 2

config: Record<string, number>
إعدادات الإخراج لصفحات الكتالوج.
مثال:

{
  "rowsPerPage": 1,
  "productsPerRow": 1
}

products: number
عدد المنتجات المرتبطة بالصفحة.
مثال: 0

childrenCount: number
عدد الأطفال.
مثال: 1

blocks: IBlockEntity[] | string[]
الكتل.
مثال:

{
  "id": 4,
  "attributeSetIdentifier": null,
  "title": "Template",
  "generalTypeId": 4,
  "identifier": "template",
  "version": 0,
  "generalTypeName": "catalog_page",
  "attributeValues": {},
  "position": 1
}

blocks.attributeValues: IAttributeValues
خريطة لقيم السمات مفاتيحها بواسطة العلامة؛ كائن فارغ عند عدم وجودها.
مثال:

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

blocks.id: number
معرف فريد للكتلة.
مثال: 1234

blocks.localizeInfos: ILocalizeInfo
معلومات التوطين للكتلة.
مثال:

{
  "key": "value"
}

blocks.version: number
إصدار كائن الكتلة.
مثال: 1

blocks.identifier: string
معرف سلسلة فريد للكتلة.
مثال: "block1"

blocks.type: BlockType
نوع الكتلة.
مثال: "product"

blocks.position: number
موضع الكتلة للترتيب.
مثال: 1

blocks.templateIdentifier: string | null
معرف القالب المستخدم من قبل الكتلة، أو null إذا لم يكن ذلك مناسبًا.
مثال: "template1"

blocks.isVisible: boolean
تشير إلى ما إذا كانت الكتلة مرئية.
مثال: true

blocks.countElementsPerRow: number
عدد العناصر المعروضة في كل صف في الكتلة، إذا كان ذلك مناسبًا.
مثال: 3

blocks.quantity: number
كمية العناصر في الكتلة، إذا كان ذلك مناسبًا.
مثال: 5

blocks.similarProducts: IProductsResponse
استجابة تحتوي على منتجات مشابهة مرتبطة بالكتلة.
مثال:

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

blocks.products: IProductsEntity[]
مصفوفة من كائنات المنتجات المرتبطة بالكتلة.
مثال:

[
  {
    "id": 1,
    "name": "Product 1"
  },
  {
    "id": 2,
    "name": "Product 2"
  }
]

moduleFormConfigs: Array<IFormConfig>
تكوينات نماذج الوحدة المرتبطة بالصفحة.

rating: IRating
بيانات التقييم.

total: string
إجمالي عدد المنتجات المرتبطة بالصفحة.
مثال: "10"

categoryPath: string | null
سلسلة مسار الفئة؛ null للصفحات المتداخلة التي ليس لها مسار فئة خاص بها.
مثال: "catalog"

أمثلة الاستخدام​

خطوات تفصيلية في الوثائق:

جربها مباشرة​

قم بتشغيل هذه الطريقة بشكل تفاعلي في JS SDK sandbox — قم بتوصيل URL مشروعك ورمز التطبيق عند الزيارة الأولى، ثم افتح: