Pular para o conteúdo principal

getBlocksByPageUrl

Recebendo objetos para um bloco relacionado pela URL da página.

Descrição​

Obtém objetos PositionBlock para um formulário relacionado pela URL. Retorna uma Promise que resolve para um array de objetos IPositionBlock.

Páginas.getBlocksByPageUrl(

url, langCode

);

Esquema de parâmetros​

Esquema

url(obrigatório): string
URL da página
exemplo: "about"

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos​

Exemplo mínimo​

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

Exemplo com atributos​

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

Exemplo de resposta​

[
  {
    "id": 1,
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Bloco de Produto"
    },
    "version": 0,
    "position": 1,
    "identifier": "product_block",
    "type": "product_block",
    "templateIdentifier": null,
    "isVisible": true,
    "isSync": false,
    "attributeValues": {},
    "countElementsPerRow": 1,
    "quantity": 1
  },
  {
    "id": 4,
    "attributeSetIdentifier": "block",
    "localizeInfos": {
      "title": "teste"
    },
    "version": 8,
    "position": 2,
    "identifier": "test",
    "type": "common_block",
    "templateIdentifier": null,
    "isVisible": true,
    "isSync": true,
    "attributeValues": {
      "block-text": {
        "type": "string",
        "value": "algum texto",
        "position": 0,
        "additionalFields": []
      },
      "interval": {
        "type": "timeInterval",
        "value": [
          {
            "values": [
              {
                "id": "bbc82c9f-1bc4-4c86-b83c-c062016eb7cb",
                "dates": [
                  "2025-04-14T00:00:00.000Z",
                  "2025-04-14T00:00:00.000Z"
                ],
                "times": [
                  [
                    {
                      "hours": 9,
                      "minutes": 0
                    },
                    {
                      "hours": 10,
                      "minutes": 0
                    }
                  ],
                  [
                    {
                      "hours": 10,
                      "minutes": 0
                    },
                    {
                      "hours": 11,
                      "minutes": 0
                    }
                  ],
                  [
                    {
                      "hours": 11,
                      "minutes": 0
                    },
                    {
                      "hours": 12,
                      "minutes": 0
                    }
                  ],
                  "..."
                ],
                "intervals": [],
                "exceptions": [],
                "intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12",
                "inEveryWeek": true,
                "inEveryMonth": true,
                "timeIntervals": [
                  [
                    "2025-04-07T09:00:00.000Z",
                    "2025-04-07T10:00:00.000Z"
                  ],
                  [
                    "2025-04-07T10:00:00.000Z",
                    "2025-04-07T11:00:00.000Z"
                  ],
                  [
                    "2025-04-07T11:00:00.000Z",
                    "2025-04-07T12:00:00.000Z"
                  ],
                  "..."
                ]
              }
            ],
            "intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12"
          }
        ],
        "position": 1,
        "additionalFields": []
      }
    }
  }
]

Esquema de resposta​

Esquema: IPositionBlock[]

id: number
O identificador do objeto.
exemplo: 1

attributeSetIdentifier: string | null
ID do conjunto de atributos.
exemplo: "block"

localizeInfos: ILocalizeInfo
O nome da página, levando em consideração a localização.

version: number
O número da versão do objeto.
exemplo: 0

position: number
A posição do objeto.
exemplo: 1

identifier: string
O identificador textual para o campo do registro.
exemplo: "product_block"

type: Types
Tipo de página.
exemplo:

"product"

templateIdentifier: string | null
ID do usuário do template vinculado.
exemplo: null

isVisible: boolean
Um sinal de visibilidade da página.
exemplo: true

isSync: boolean
Indicação de indexação da página.
exemplo: false

attributeValues: AttributeType
Array de valores de atributos do índice (representado como um par de ID de atributo do usuário: valor do atributo).
exemplo:

{
  "block-text": {
    "type": "string",
    "value": "algum texto",
    "position": 0,
    "additionalFields": []
  }
}

countElementsPerRow: number
Número de elementos exibidos por linha no bloco, se aplicável.
exemplo: 3

quantity: number
Quantidade de páginas no bloco.
exemplo: NaN