コンテンツ・ブロックの情報を見る
get
/content_blocks/info
このエンドポイントを使用して、既存のコンテンツブロックの情報を呼び出します。
前提条件
このエンドポイントを使用するには、API キーとcontent_blocks.info
の権限が必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
リクエストパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
content_block_id |
必須 | 文字列 | コンテンツブロックの識別子。 これは、API コールでコンテンツブロックの情報をリストアップするか、API キーのページに行き、一番下までスクロールしてコンテンツブロックの API 識別子を検索することで見つけることができます。 |
include_inclusion_data |
オプション | ブール値 | true に設定された場合、API はこのコンテンツブロックが含まれるキャンペーンとキャンバスのメッセージバリエーション API 識別子を返し、以降の呼び出しで使用できるようにします。 結果は、アーカイブまたは削除されたキャンペーンやキャンバスを除外する。 |
例のリクエスト
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'
応答
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"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",
}
トラブルシューティング
以下の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものである。
エラー | トラブルシューティング |
---|---|
Content Block ID cannot be blank |
コンテンツブロックがリクエストにリストされ、引用符 ("" ) で囲まれていることを確認します。 |
Content Block ID is invalid for this workspace |
このコンテンツブロックが存在しないか、別の会社アカウントまたはワークスペースにある。 |
Content Block has been deleted—content not available |
このコンテンツブロックは、以前は存在していたかもしれませんが、削除されました。 |
Include Inclusion Data—error |
このパラメータはブーリアン値(trueまたはfalse)のみを受け付ける。include_inclusion_data の値が引用符("" )で囲まれていないことを確認すること。この場合、値は文字列として送信される。詳細については、リクエストパラメーターを参照してください。 |
New Stuff!