Consulte as informações do bloco de conteúdo
get
/content_blocks/info
Use esse ponto de extremidade para chamar informações de seus blocos de conteúdo existentes.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão content_blocks.info.
Limite de taxa
Aplicamos o limite de frequência padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de frequência da API.
Parâmetros de solicitação
| Parâmetro | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
content_block_id |
Obrigatória | String | O identificador do bloco de conteúdo. Você pode encontrar isso listando as informações do bloco de conteúdo por meio de uma chamada de API ou acessando a página Chaves de API, rolando até a parte inferior e pesquisando o identificador de API do bloco de conteúdo. |
include_inclusion_data |
Opcional | Booleano | Quando definido como true, a API retorna o identificador da API de variação de mensagens de campanhas e Canvas em que esse bloco de conteúdo está incluído, para ser usado em chamadas subsequentes. Os resultados excluem campanhas ou telas arquivadas ou excluídas. |
Exemplo de solicitação
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/content_blocks/info?content_block_id={{content_block_id}}&include_inclusion_data=false' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Resposta
1
2
3
4
5
6
7
8
9
10
11
12
13
{
"content_block_id": (string) the Content Block identifier,
"name": (string) the name of the Content Block,
"content": (string) the content in the Content Block,
"description": (string) the Content Block description,
"content_type": (string) the content type, html or text,
"tags": (array) An array of tags formatted as strings,
"created_at": (string) The time the Content Block was created in ISO 8601,
"last_edited": (string) The time the Content Block was last edited in ISO 8601,
"inclusion_count" : (integer) the inclusion count,
"inclusion_data": (array) the inclusion data,
"message": "success",
}
Solução de problemas
A tabela a seguir lista os possíveis erros retornados e as etapas de solução de problemas associadas.
| Erro | Solução de problemas |
|---|---|
Content Block ID cannot be blank |
Confira se um bloco de conteúdo está listado em sua solicitação e entre aspas (""). |
Content Block ID is invalid for this workspace |
Esse bloco de conteúdo não existe ou está em uma conta ou espaço de trabalho diferente da empresa. |
Content Block has been deleted—content not available |
Esse bloco de conteúdo, embora possa ter existido anteriormente, foi excluído. |
Include Inclusion Data—error |
Esse parâmetro aceita apenas valores booleanos (verdadeiro ou falso). Certifique-se de que o valor de include_inclusion_data não esteja encapsulado entre aspas (""), o que faz com que o valor seja enviado como uma string. Consulte os parâmetros da solicitação para obter detalhes. |
New Stuff!
Editar esta página no GitHub