コンテンツ・ブロックを作成する
post
/content_blocks/create
このエンドポイントを使用して、コンテンツブロックを作成します。
前提条件
このエンドポイントを使用するには、API キーとcontent_blocks.create
の権限が必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
要求本文:
1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
1
2
3
4
5
6
7
{
"name": (required, string) Must be less than 100 characters,
"description": (optional, string) The description of the Content Block. Must be less than 250 character,
"content": (required, string) HTML or text content within Content Block,
"state": (optional, string) Choose `active` or `draft`. Defaults to `active` if not specified,
"tags": (optional, array of strings) Tags must already exist
}
リクエストパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
name |
必須 | 文字列 | コンテンツブロックの名前。100 文字未満でなければなりません。 |
description |
オプション | 文字列 | コンテンツブロックの説明。250 文字未満でなければなりません。 |
content |
必須 | 文字列 | コンテンツブロック内のHTMLまたはテキストコンテンツ。 |
state |
オプション | 文字列 | active またはdraft を選択する。指定がない場合のデフォルトはactive である。 |
tags |
オプション | 文字列の配列 | タグはすでに存している必要があります。 |
例のリクエスト
1
2
3
4
5
6
7
8
9
10
curl --location --request POST 'https://rest.iad-01.braze.com/content_blocks/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"name": "content_block",
"description": "This is my Content Block",
"content": "HTML content within block",
"state": "draft",
"tags": ["marketing"]
}'
応答
1
2
3
4
5
6
7
8
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"content_block_id": (string) Your newly generated block id,
"liquid_tag": (string) The generated block tag from the Content Block name,
"created_at": (string) The time the Content Block was created in ISO 8601,
"message": "success"
}
トラブルシューティング
以下の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものである。
エラー | トラブルシューティング | |
---|---|---|
Content cannot be blank |
||
Content must be a string |
コンテンツが引用符 ("" ) で囲まれていることを確認する。 |
|
Content must be smaller than 50kb |
コンテンツブロック内のコンテンツは、合計 50kb 未満でなければなりません。 | |
Content contains malformed liquid |
指定されたリキッドは有効でも解析可能でもない。有効な Liquid を使用してもう一度やり直すか、サポートにお問い合わせください。 | |
Content Block cannot be referenced within itself |
||
Content Block description cannot be blank |
||
Content Block description must be a string |
コンテンツ・ブロックの説明が引用符 ("" ) で囲まれていることを確認する。 |
|
Content Block description must be shorter than 250 characters |
||
Content Block name cannot be blank |
||
Content Block name must be shorter than 100 characters |
||
Content Block name can only contain alphanumeric characters |
コンテンツブロック名には、文字 (大文字または小文字) A ~ Z 、数字 0 ~ 9 、ダッシュ - 、アンダースコア _ のいずれかを含められます。絵文字、! 、@ 、~ 、& 、その他の「特殊」文字など、英数字以外の文字を含むことはできない。 |
|
Content Block with this name already exists |
別の名前を試してみよう。 | |
Content Block state must be either active or draft |
||
Tags must be an array |
タグは文字列の配列としてフォーマットされなければならない。例えば、["marketing", "promotional", "transactional"] 。 |
|
All tags must be strings |
タグが引用符 ("" ) で囲まれていることを確認すること。 |
|
Some tags could not be found |
コンテンツブロックの作成時にタグを追加するには、そのタグがすでにBrazeに存在している必要がある。 |
New Stuff!