getChildPagesByParentUrl

Obtiene las páginas hijas de una página por la URL de la página padre.

Descripción

Obtiene las páginas creadas dentro de la página padre con la url indicada. Se resuelve en un array de objetos IPagesEntity, o en [] si la página no tiene hijas.

.getChildPagesByParentUrl(

,

);

Esquema de parámetros

Esquema

url(required): string
URL de la página padre cuyas páginas hijas se obtienen.
ejemplo: "about/our-team"

langCode: string
Código de idioma. Predeterminado: el langCode pasado a defineOneEntry ("en_US" si no se pasó ninguno).
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

const response = await Pages.getChildPagesByParentUrl('blog');

Ejemplo con langCode

const response = await Pages.getChildPagesByParentUrl('blog', 'en_US');

Ejemplo de respuesta

[
  {
    "id": 9,
    "config": {},
    "depth": 1,
    "parentId": 8,
    "pageUrl": "blog1",
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Blog 1",
      "htmlContent": "",
      "plainContent": "",
      "menuTitle": "Blog 1"
    },
    "isVisible": true,
    "products": 0,
    "childrenCount": 0,
    "type": "common_page",
    "position": 2,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "blog/blog1",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": []
  },
  {
    "id": 49,
    "config": {},
    "depth": 1,
    "parentId": 8,
    "pageUrl": "blog2",
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Blog 2",
      "htmlContent": "",
      "plainContent": "",
      "menuTitle": "Blog 2"
    },
    "isVisible": true,
    "products": 0,
    "childrenCount": 0,
    "type": "common_page",
    "position": 1,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "blog2",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": []
  }
]

Esquema de respuesta

Schema: IPagesEntity[]

id: number
ID del objeto.
ejemplo: 8

parentId: number | null
ID de la página padre; null para una página de nivel superior.
ejemplo: 10

pageUrl: string
URL de la página.
ejemplo: "blog"

depth: number
Nivel de anidamiento de la página: 0 para una página de nivel superior, 1 para sus hijas, y así sucesivamente.
ejemplo: 10

localizeInfos: ILocalizeInfo
Contenido localizado de la página: title, menuTitle, htmlContent y plainContent.
ejemplo:

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

isVisible: boolean
Indica si la página es visible.
ejemplo: true

type: PageType
Tipo de página.
ejemplo: "common_page"

templateIdentifier: string | null
Marcador de la plantilla vinculada.
ejemplo: "template"

attributeSetIdentifier: string | null
Marcador del conjunto de atributos, o null si no hay ninguno asignado.
ejemplo: "page"

attributeValues: IAttributeValues
Valores de atributos indexados por marcador; un objeto vacío si no hay ninguno.
ejemplo:

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

isSync: boolean
Si el índice de atributos de la página está actualizado para el idioma solicitado.
ejemplo: true

template: object
Plantilla vinculada a la página.
ejemplo:

{}

position: number
Posición usada para ordenar.
ejemplo: 2

config: Record<string, number>
Ajustes de salida para las páginas del catálogo.
ejemplo:

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

products: number
Número de productos vinculados a la página.
ejemplo: 0

childrenCount: number
Número de páginas hijas.
ejemplo: 1

blocks: IBlockEntity[] | string[]
Bloques vinculados a la página: objetos de bloque o sus marcadores.
ejemplo:

[
  "product_block"
]

blocks.attributeValues: IAttributeValues
Valores de atributos indexados por marcador; un objeto vacío si no hay ninguno.
ejemplo:

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

blocks.id: number
ID del bloque.
ejemplo: 1234

blocks.localizeInfos: ILocalizeInfo
Datos localizados del bloque.
ejemplo:

{
  "title": "Example title"
}

blocks.version: number
Número de versión del bloque.
ejemplo: 1

blocks.identifier: string
Marcador del bloque.
ejemplo: "block1"

blocks.type: BlockType
Tipo del bloque.
ejemplo: "product"

blocks.position: number
Posición del bloque, usada para ordenar.
ejemplo: 1

blocks.templateIdentifier: string | null
Marcador de la plantilla que usa el bloque, o null.
ejemplo: "template1"

blocks.isVisible: boolean
Indica si el bloque es visible.
ejemplo: true

blocks.countElementsPerRow: number
Número de elementos por fila en el bloque, si está definido.
ejemplo: 3

blocks.quantity: number
Cantidad de elementos del bloque, si procede.
ejemplo: 5

blocks.similarProducts: IProductsResponse
Productos similares del bloque, como total e items.
ejemplo:

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

blocks.products: IProductsEntity[]
Productos vinculados al bloque.
ejemplo:

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

moduleFormConfigs: Array<IFormConfig>
Configuraciones de formulario del módulo vinculado a la página.

rating: IRating
Datos de valoración: valor medio, me gusta y no me gusta, y el método de cálculo.

total: string
La Content API no lo devuelve; usa products para obtener el número de productos vinculados.
ejemplo: "10"

categoryPath: string | null
Ruta de categoría; null para páginas anidadas que no tienen ruta de categoría propia.
ejemplo: "catalog"

distance: number
Distancia coseno a la consulta. El endpoint de búsqueda semántica (vectorial) la devuelve en cada elemento.
ejemplo: 0.12

---