Ana içeriğe geç

getPageByUrl

URL ile sayfaya bağlı formlar, bloklar, menüler hakkında bilgi içeren tek bir sayfa nesnesi almak.

Açıklama​

Bu yöntem, API'den URL'sine (url) göre tek bir sayfa nesnesi alır. Sayfa nesnesi IPagesEntity olarak döner ve dönen sayfanın türüne bağlı olarak belirli bir nesne içerir.

Sayfalar.getPageByUrl(

url*, langCode

);

Parametreler şeması​

Şema

url(gerekli): string
Sayfa URL'si
örnek: "about"

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

Örnekler​

Minimal örnek​

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

Özelliklerle örnek​

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

Örnek yanıt​

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

Yanıt şeması​

Şema: IPagesEntity

id: number
Nesnenin tanımlayıcısı.
örnek: 8

parentId: number | null
Üst sayfanın id'si, eğer null içeriyorsa, o zaman üst düzey sayfadır.
örnek: 10

pageUrl: string
Benzersiz sayfa URL'si.
örnek: "blog"

depth: number
parentId'ye göre sayfa iç içe geçme derinliği.
örnek: 10

localizeInfos: ILocalizeInfo
Yerelleştirmeyi dikkate alarak sayfanın adı.
örnek:

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

isVisible: boolean
Sayfa görünürlüğü işareti.
örnek: true

type: Types
Sayfa türü.
örnek: "common_page"

templateIdentifier: string | null
Bağlı şablonun kullanıcı id'si.
örnek: "template"

attributeSetIdentifier: string | null
Özellikler setinin id'si.
örnek: "page"

attributeValues: AttributeType
İndeksten gelen özellik değerleri dizisi (kullanıcı özellik id'si: özellik değeri çifti olarak temsil edilir).
örnek:

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

isSync: boolean
Sayfa indeksleme durumu.
örnek: true

template: any
Şablon nesnesi.
örnek:

position: number
Sıralama için öğe numarası.
örnek: 2

config: any
Katalog sayfaları için çıktı ayarları.
örnek:

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

products: number
Sayfaya bağlı ürün sayısı.
örnek: 0

childrenCount: number
Çocuk sayısı.
örnek: 1

blocks: any
bloklar.
örnek:

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