getChildPagesByParentUrl

Obtenha as páginas filhas de uma página pela URL da página pai.

Descrição

Busca as páginas criadas sob a página pai com a url informada. Resolve para um array de objetos IPagesEntity, ou [] quando a página não tem filhas.

.getChildPagesByParentUrl(

,

);

Esquema de parâmetros

Esquema

url(obrigatório): string
URL da página pai cujas páginas filhas devem ser buscadas.
exemplo: "sobre/nossa-equipe"

langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
exemplo: "en_US"

Exemplos

Exemplo mínimo

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

Exemplo com langCode

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

Exemplo de resposta

[
  {
    "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 resposta

Schema: IPagesEntity[]

id: number
ID do objeto.
exemplo: 8

parentId: number | null
ID da página pai; null para uma página de nível superior.
exemplo: 10

pageUrl: string
URL da página.
exemplo: "blog"

depth: number
Nível de aninhamento da página: 0 para uma página de nível superior, 1 para suas filhas, e assim por diante.
exemplo: 10

localizeInfos: ILocalizeInfo
Conteúdo localizado da página: title, menuTitle, htmlContent e plainContent.
exemplo:

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

isVisible: boolean
Se a página está visível.
exemplo: true

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

templateIdentifier: string | null
Marcador do template vinculado.
exemplo: "template"

attributeSetIdentifier: string | null
Marcador do conjunto de atributos, ou null se nenhum estiver atribuído.
exemplo: "page"

attributeValues: IAttributeValues
Valores de atributos indexados por marcador; um objeto vazio quando não há nenhum.
exemplo:

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

isSync: boolean
Se o índice de atributos da página está atualizado para o idioma solicitado.
exemplo: true

template: object
Template vinculado à página.
exemplo:

{}

position: number
Posição usada para ordenação.
exemplo: 2

config: Record<string, number>
Configurações de saída para páginas de catálogo.
exemplo:

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

products: number
Número de produtos vinculados à página.
exemplo: 0

childrenCount: number
Número de páginas filhas.
exemplo: 1

blocks: IBlockEntity[] | string[]
Blocos vinculados à página: objetos de bloco ou seus marcadores.
exemplo:

[
  "product_block"
]

blocks.attributeValues: IAttributeValues
Valores de atributos indexados por marcador; um objeto vazio quando não há nenhum.
exemplo:

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

blocks.id: number
ID do bloco.
exemplo: 1234

blocks.localizeInfos: ILocalizeInfo
Dados localizados do bloco.
exemplo:

{
  "title": "Example title"
}

blocks.version: number
Número da versão do bloco.
exemplo: 1

blocks.identifier: string
Marcador do bloco.
exemplo: "block1"

blocks.type: BlockType
Tipo do bloco.
exemplo: "product"

blocks.position: number
Posição do bloco, usada para ordenação.
exemplo: 1

blocks.templateIdentifier: string | null
Marcador do template usado pelo bloco, ou null.
exemplo: "template1"

blocks.isVisible: boolean
Se o bloco está visível.
exemplo: true

blocks.countElementsPerRow: number
Número de itens por linha no bloco, se definido.
exemplo: 3

blocks.quantity: number
Quantidade de itens no bloco, se aplicável.
exemplo: 5

blocks.similarProducts: IProductsResponse
Produtos semelhantes do bloco, como total e items.
exemplo:

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

blocks.products: IProductsEntity[]
Produtos vinculados ao bloco.
exemplo:

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

moduleFormConfigs: Array<IFormConfig>
Configurações de formulário do módulo vinculadas à página.

rating: IRating
Dados de avaliação: valor médio, curtidas e descurtidas, e o método de cálculo.

total: string
Não retornado pela Content API; use products para obter o número de produtos vinculados.
exemplo: "10"

categoryPath: string | null
Caminho da categoria; null para páginas aninhadas sem caminho de categoria próprio.
exemplo: "catalog"

distance: number
Distância do cosseno até a consulta. Retornada em todos os itens pelo endpoint de busca semântica (vetorial).
exemplo: 0.12

---