Skip to content

キャンバスのリンクエイリアスをリストする

get

/canvas/url_info/details

このエンドポイントを使用して、特定の電子メール・キャンバスのステップで設定されたリンク・エイリアスをリストする。

Request parameters

パラメーター required データ型 説明
canvas_step_id required string キャンバスステップ API 識別子を参照してください。
message_variation_id required string メッセージバリアント API 識別子 (そのステップのメールメッセージバリアント用)。これは、[キャンバス詳細] ページで [バリアントを分析] をクリックすることで確認できます。
includes_link_id オプション string 特定のリンク識別子（Brazeによって割り当てられる）またはnull 。これは、特定のlink_id によって結果をフィルタリングするために使用される。

リクエスト例

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/canvas/url_info/details?campaign_id=4615a404-b2c2-421e-9a04-2233bb3ec4f9&message_variation_id=0ea708fe-36b4-43f7-9f5c-a0650ea2a7a0&includes_link_id=014tk4e0kg97' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

応答

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
{
  "channel": "email",
  "name": "Variant 1",
  "link_data": [
    {
      "link_URL": "https://www.braze.com?lid=014tk4e0kg97",
      "link_id": "014tk4e0kg97",
      "content_block_path_info": [],
      "link_alias": "link5"
    }
  ],
  "message": "success"
}

トラブルシューティング

次のテーブルに、返される可能性のあるエラーと、関連するトラブルシューティングステップを示します。

エラー トラブルシューティング
Missing/Invalid Canvas ID キャンバス API ID はAPI 識別子でなければなりません。これは、キャンバスリストのエクスポートエンドポイントを使うか、ダッシュボードにログインすることで確認できます。
Missing/Invalid Message Variant ID メッセージバリアントAPI IDはAPI識別子でなければならない。これは、キャンバス詳細のエクスポートエンドポイントを使うか、ダッシュボードにログインすることで確認できます。
New Stuff!