OAuth 2.0 設定の追加
- MoEngage ダッシュボードに移動し、Settings > Advanced settings > Authorization configuration を選択します。Authorization configuration ページが表示されます。
- + Add OAuth config をクリックします。Setup Authorization ページが表示されます。
- OAuth details：キャンペーンのターゲットオーディエンスを定義します。
- Response settings：送信するコネクターキャンペーンまたはカスタム SMS コネクターのコンテンツを定義します。
ステップ 1：OAuth Details
OAuth details タブで、次の詳細を入力します。- OAuth name：OAuth 設定の名前を入力します。これらの設定は、キャンペーン作成時に選択できるようになります。
- Grant type：現在、Client Credential グラントタイプがサポートされています。その他のグラントタイプを使用している場合は、MoEngage のカスタマーサクセスマネージャー（CSM）またはサポートチームにお問い合わせください。
-
Token type：トークンタイプを選択します。サポートされている値は次のとおりです。
- Opaque：トークン発行者が Opaque トークンを使用する場合は、このオプションを選択します。この場合、発行者からのレスポンスには、Opaque アクセストークンとともに有効期限が含まれます。
- JWT：このオプションを選択すると、ステップ 2 の Response settings で、アクセストークンと有効期限がレスポンス内で JSON Web Token（JWT）としてエンコードされます。有効期限を取得するには、レスポンスをデコードする必要があります。
- API details で、アクセストークンの取得に必要な詳細を入力します。実装予定の OAuth サービスの API ドキュメントを確認してください。
- API URL：API URL を入力します。
-
Method：API メソッドを選択します。サポートされているメソッドと、各メソッドで使用できるフィールドは次のとおりです。
- URL parameters：+ KV pair をクリックし、API のパラメーターを入力します。
- Headers：+ KV pair をクリックし、API のヘッダーを入力します。
-
Body type：次のオプションを使用して、リクエストのボディを設定します。
- Form
- JSON
- Raw
Webhook のフォームエンコードされたシリアル化に基づいてボディを作成します。
。 - Send test & continue をクリックして設定をテストし、2 番目のステップ “Response settings” に進みます。
Send test & continue をクリックした後にエラーが発生した場合は、OAuth サービスプロバイダーのドキュメントで API 設定を確認してください。
ステップ 2：Response Settings
Response settings タブで、次の詳細を入力します。- OAuth delivery response：このセクションのフィールドは、ステップ 1 の OAuth details で選択したトークンタイプによって異なります。
- Opaque
- JWT
- ステップ 1 の OAuth details で Token type ドロップダウンリストから “Opaque” を選択した場合、OAuth delivery response フィールドは 1 つだけ表示されます。OAuth delivery response には、エンコードされていない有効期限を持つキーが含まれています。
- レスポンスを受信した日時も確認できます。
- Expiry ドロップダウンリストから有効期限のオプションを選択し、2 番目のドロップダウンリストから値を選択します。
- Expiry ドロップダウンリストの値は、受信したレスポンスの種類によって異なります。
- Preferred prefix：OAuth 設定の優先プレフィックスを選択します。
マーケターは、デフォルトのオプションに加えてカスタムプレフィックスを作成できます。これらのプレフィックスは、カスタムコネクターの作成時やカスタム SMS コネクターの設定時に使用でき、キャンペーンレベルで上書きできます。 - Preferred error codes：OAuth error code フィールドに、トークンの有効期限切れによる認可失敗時の OAuth 設定の優先エラーコードを入力します。このエラーコードは、コネクターキャンペーンまたはカスタム SMS コネクターの再試行に使用できます。
- Save をクリックします。これで、この OAuth 設定がアクティブになります。この OAuth 設定は、カスタムコネクターキャンペーンの作成時やカスタム SMS コネクターの設定時に使用できるようになります。
OAuth 設定の管理
- MoEngage ダッシュボードに移動し、Settings > Advanced settings > Authorization configuration を選択します。Authorization configuration ページが表示されます。設定済みの既存の OAuth 設定を確認できます。
- 特定の OAuth 設定が使用されている場所を確認するには、対象の設定の View list をクリックします。関連する Content APIs、PII 設定、Connector Campaigns の一覧が表示されます。
- “Failed” の OAuth 設定は、OAuth 設定がレスポンスを取得できないことを意味します。OAuth 設定を編集し、再度テストを送信する必要があります。コネクターキャンペーンの作成時やカスタム SMS コネクターの設定時に、失敗した OAuth 設定を使用しないでください。
- コネクターやキャンペーンの設定時にドロップダウンで選択できるのは、ステータスが “Active” の設定のみです。
- アクティブな OAuth 設定の有効期限が切れると、ステータスが “Failed” に変わります。この期限切れの設定を使用しているキャンペーンまたはコネクターを編集するとエラーメッセージが表示されるため、新しいアクティブな OAuth 設定を選択する必要があります。
- OAuth 設定を編集するには、対象の OAuth 設定の省略記号アイコンをクリックし、Edit をクリックします。
- OAuth 設定を削除するには、対象の OAuth 設定の省略記号アイコンをクリックし、Delete をクリックします。OAuth 設定に関連付けられているキャンペーンがある場合は、削除できません。関連するキャンペーンの一覧とともに警告が表示されます。
サポートマトリックス
ここで設定した OAuth 2.0 設定は、次の機能でリクエストを認証するために使用できます。- Connector Campaigns：コネクターキャンペーンを保護します。詳細については、コネクターキャンペーンの作成を参照してください。
- Custom Connectors：カスタム SMS キャンペーンを保護します。詳細については、SMS 用カスタムコネクターの設定を参照してください。
- Content APIs：リアルタイムのパーソナライズに使用される API 呼び出しを認証します。詳細については、Content API の追加を参照してください。
- PII Tokenized Sending：キャンペーン配信時に顧客の PII を取得するために使用される API を保護します。詳細については、PII Tokenized Sendingを参照してください。
- Streams：MoEngage Streams がイベントデータを転送する API エンドポイントを認証します。詳細については、Streamsを参照してください。