Content APIs の概要

コンテンツ API とは、送信時に動的データをキャンペーンに取り込むために MoEngage が呼び出す外部エンドポイントです。たとえば、ユーザーの都市の現在の天気、カート内のアイテムの最新価格、フライトのステータスなどを取得するために使用できます。 MoEngage Content APIs を使用すると、ワークスペースで設定されているコンテンツ API を一覧表示し、保存済みの設定をアップストリームエンドポイントに対してテストできます。コンテンツ API を作成または編集するには、MoEngage ダッシュボードを使用します。詳細については、Content API の追加を参照してください。

​

エンドポイント

Content APIs は、次のエンドポイントで構成されています。

• List Content APIs: ワークスペース内のすべてのコンテンツ API、または名前や ID で指定した単一のコンテンツ API を返します。
• Test Content API: 保存済みのコンテンツ API のアップストリームエンドポイントを呼び出し、レスポンスを返します。

​

認証

認証は Basic 認証で行います。認証には、username:password の形式で認証情報を Base64 エンコードした文字列が必要です。

• Username: MoEngage の Workspace ID（App ID とも呼ばれます）を使用します。MoEngage ダッシュボードの Settings > Account > API keys で確認できます。
• Password: Settings > Account > API keys の API キーを使用します。

API キーの作成と管理の詳細については、API Key Dashboard を参照してください。

​

パーソナライズトークン

コンテンツ API の設定では、URL、パラメーター、ヘッダー、または本文に Jinja トークンを含めることができます。トークンは名前空間ごとにグループ化されます (例: {{UserAttribute['city']}} や {{EventAttribute['name']}})。 設定をテストする際は、リクエスト本文の dynamic_values オブジェクトで、名前空間をキーとしてこれらのトークンのサンプル値を指定します。{{UserAttribute['city']}} のようなトークンは、dynamic_values.UserAttribute.city から解決されます。MoEngage は、アップストリームエンドポイントを呼び出す前にすべてのトークンを解決します。 設定にトークンが含まれていない場合は、リクエスト本文を省略してください。

​

ページネーション

List Content APIs は、1 ページあたり最大 20 件のアイテムを返します。カーソルは不透明な値として扱い、デコードや変更は行わないでください。 ワークスペース内のすべてのコンテンツ API をページングするには、次の手順に従います。

1. limit のみを指定して最初のページをリクエストします。
   First Page

   curl --request GET \
     --url 'https://api-01.moengage.com/v5/content-apis?limit=20' \
     --header 'Authorization: Basic <base64(workspaceId:apiKey)>'
   
2. レスポンスの pagination.has_more を確認します。true の場合は、limit を変更せずに、pagination.next_cursor を cursor パラメーターとして渡して同じリクエストを再度送信します。
   Next Page

   curl --request GET \
     --url 'https://api-01.moengage.com/v5/content-apis?limit=20&cursor=eyJsYXN0X2lkIjoiNjZiM2QxZTBmMmE0YzU4ZTlkN2IzYzIxIn0=' \
     --header 'Authorization: Basic <base64(workspaceId:apiKey)>'
   
3. pagination.has_more が false になるまで、手順 2 を繰り返します。

​

よくある質問

​

コンテンツ API の管理

​

コンテンツ API のテスト

​

Postman コレクション

事前設定済みの Postman コレクションを使用して、これらのエンドポイントをテストできます: MoEngage Content APIs コレクションを表示。