移行APIの決定 decisioning-migration-api

Decisioning Migration Service APIを使用すると、あるサンドボックスから別のサンドボックスに意思決定管理オブジェクトを移行できます。 移行プロセスは、依存関係の分析、実行、オプションのロールバック機能を含む非同期ワークフローとして実行されます。

このAPIを使用すると、データの整合性と関係を維持しながら、環境間で意思決定コンテンツをシームレスに移行できます。

意思決定管理と比較した意思決定の利点と機能については、このページ ​を参照してください。

機能 capabilities

Decisioning Migration Service APIには、次の機能が用意されています。

前提条件 prerequisites

必要な権限 permissions

移行APIを使用するには、ソースサンドボックスとターゲットサンドボックスの両方に適切な権限が必要です。

Source サンドボックス – 意思決定管理オブジェクトへの読み取りアクセス

Target サンドボックス - Decisioning オブジェクトへのアクセス権の作成と編集

一般的な権限には、次のものがあります。

ターゲットサンドボックスの準備 target-sandbox-preparation

移行を実行する前に、ターゲットサンドボックスが適切に設定されていることを確認します。

サンドボックス管理について詳しくは、​ サンドボックスの使用と割り当てを参照してください。

API の基本 api-basics

ベース URL base-url

次のベース URLを使用します。

認証 authentication

すべてのAPI リクエストには、次のヘッダーが必要です。

認証の設定手順について詳しくは、Journey Optimizer認証ガイド ​を参照してください。

ワークフローモデル workflow-model

各API呼び出しは、ワークフローリソースを作成または取得します。 ワークフローは、移行タスクの進行状況と結果を追跡する非同期操作です。

ワークフローには次のプロパティがあります。

移行ワークフロー migration-workflow

移行プロセスは、依存関係の分析と移行の実行という2つの主な手順で構成されます。 移行を成功させるには、次の手順に従います。

手順1：依存関係の分析 analyze-dependencies

移行前に、依存関係ワークフローを使用して、ターゲット サンドボックスの意思決定管理から決定にマッピングする必要がある項目を特定します。 この分析は、オブジェクト間の関係を理解し、必要なマッピングを準備するのに役立ちます。

依存関係ワークフローの作成 create-dependency-workflow

次のAPI呼び出しを使用して、依存関係分析ワークフローを作成します。

API 形式

POST /workflows/generate-dependencies

サンドボックスレベルの依存関係（最初に推奨）

サンドボックスレベルの分析から始めて、あらゆる依存関係を包括的に把握します。

curl --request POST \
  --url "https://decisioning-migration.adobe.io/workflows/generate-dependencies" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "Content-Type: application/json" \
  --data '{
    "imsOrgId": "<IMS_ORG_ID>",
    "sourceSandboxDetails": { "sandboxName": "<SOURCE_SANDBOX_NAME>" },
    "targetSandboxDetails": { "sandboxName": "<TARGET_SANDBOX_NAME>" },
    "requestLevel": "sandbox"
  }'

オファーレベルの依存関係

特定のオファーの依存関係のみを分析するには、requestLevel: "offer"を設定し、分析するオファーIDをoffersList配列に指定します。

決定レベルの依存関係

特定の決定の依存関係のみを分析するには、requestLevel: "decision"を設定し、分析する決定IDをdecisionsList配列に指定します。

依存関係ワークフローの状態を確認する poll-dependency-status

依存関係ワークフローをポーリングして、分析が完了したときに確認します。

API 形式

GET /workflows/generate-dependencies/{id}

リクエスト

curl --request GET \
  --url "https://decisioning-migration.adobe.io/workflows/generate-dependencies/<WORKFLOW_ID>" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>"

status フィールドにCompletedが表示されると、依存関係の分析の準備が整います。 ワークフロー出力を使用して、移行依存関係マッピングを構築します。

手順2：移行の実行 execute-migration

依存関係を分析し、マッピングを準備したら、移行を実行できます。

移行ワークフローの作成 create-migration-workflow

手順1の依存関係マッピングを使用して、移行を設定および実行します。

API 形式

POST /workflows/migration

サンドボックスレベルの移行

すべての決定オブジェクトを1つのサンドボックスから別のサンドボックスに移行するには：

curl --request POST \
  --url "https://decisioning-migration.adobe.io/workflows/migration" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "Content-Type: application/json" \
  --data '{
    "imsOrgId": "<IMS_ORG_ID>",
    "sourceSandboxDetails": { "sandboxName": "<SOURCE_SANDBOX_NAME>" },
    "targetSandboxDetails": { "sandboxName": "<TARGET_SANDBOX_NAME>" },
    "createDataStream": true,
    "dependency": {
      "profileAttributes": {
        "sourceAttr1": "targetAttr1"
      },
      "segments": {
        "sourceSegmentKey1": {
          "namespace": "<TARGET_SEGMENT_NAMESPACE>",
          "id": "<TARGET_SEGMENT_ID>"
        }
      },
      "contextAttributes": {
        "sourceCtx1": "targetCtx1"
      },
      "datasetName": "<TARGET_DATASET_NAME>"
    },
    "requestLevel": "sandbox"
  }'

オファーレベルの移行

特定のオファーのみを移行するには、requestLevel: "offer"を使用してoffersList配列を追加します。

"offersList": ["offer-id-1", "offer-id-2"]

決定レベルの移行

特定の決定のみを移行するには、requestLevel: "decision"を使用してdecisionsList配列を追加します。

"decisionsList": ["decision-id-1", "decision-id-2"]

移行ステータスの監視 poll-migration-status

移行ワークフローをポーリングして、進行状況を追跡します。

API 形式

GET /workflows/migration/{id}

リクエスト

curl --request GET \
  --url "https://decisioning-migration.adobe.io/workflows/migration/<WORKFLOW_ID>" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>"

移行結果

status フィールドにCompletedが表示されている場合、移行は成功しました。 ワークフローresultには次のものが含まれます。

status フィールドにFailedが表示されたら、errors[]配列とresult.error フィールドで、問題の詳細を確認します。

移行の検証 validate-migration

移行が正常に完了したら、すべてのオブジェクトが正しく移行されたことを確認します。

検証チェックリスト validation-checklist

例 test-runtime-delivery

移行でデータストリームを作成した場合は、次の例を使用してオファー配信をテストできます。

curl --request POST \
  --url "https://edge.adobedc.net/ee/or2/v1/interact?configId=<DATASTREAM_ID>" \
  --header "Content-Type: application/json" \
  --header "x-request-id: <uuid>" \
  --data '{ "events": [ ... ] }'

移行のロールバック rollback

検証中に問題が発生した場合は、完了した移行をロールバックして、ターゲットサンドボックスを以前の状態に戻すことができます。

ロールバックワークフローの作成 create-rollback-workflow

元に戻す移行を参照するロールバックワークフローを作成して、ロールバックを開始します。

API 形式

POST /workflows/rollback

リクエスト

curl --request POST \
  --url "https://decisioning-migration.adobe.io/workflows/rollback" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "Content-Type: application/json" \
  --data '{ "rollbackWorkflowId": "<MIGRATION_WORKFLOW_ID>" }'

<MIGRATION_WORKFLOW_ID>を、ロールバックする移行ワークフローのIDに置き換えます。

ロールバックステータスの監視 poll-rollback-status

ロールバックワークフローをポーリングして、進行状況を追跡します。

API 形式

GET /workflows/rollback/{rollbackWorkflowId}

リクエスト

curl --request GET \
  --url "https://decisioning-migration.adobe.io/workflows/rollback/<ROLLBACK_WORKFLOW_ID>" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>"

同時ワークフローへの対応 handle-concurrency

移行APIでは、組織ごとに一度に1つのワークフローのみを実行できます。 別のワークフローが進行中の間に新しいワークフローを作成しようとすると、409 Conflict エラー応答（「ワークフローは既に進行中です…」）が表示されます。

この場合、処理中のワークフローが完了するのを待つか、ワークフローIDを取得してステータスをポーリングします。 現在のワークフローが完了したら、新しいワークフローを作成できます。

エンティティマッピング参照 entity-mapping

意思決定管理から決定に移行する場合、エンティティは次のようにマッピングされます。

ワークフローのクリーンアップ cleanup

ワークフローの削除は公開されていません。 ワークフローリソースを削除する必要がある場合は、システム管理者にお問い合わせください。

関連トピック related-topics