Flow Service APIを使用してSalesforceをExperience Platformに接続します

このガイドでは、Flow Service APIを使用してSalesforce ソースアカウントをAdobe Experience Platformに接続する方法について説明します。

基本を学ぶ

このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。

  • ソース:Experience Platform を使用すると、データを様々なソースから取得しながら、Experience Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
  • サンドボックス:Experience Platform には、単一の Experience Platform インスタンスを別々の仮想環境に分割して、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

Experience Platform APIの使用

Experience Platform APIの呼び出しを正常に行う方法について詳しくは、Experience Platform APIの概要に関するガイドを参照してください。

SalesforceをAzureにExperience Platformに接続します azure

AzureでSalesforce ソースをExperience Platformに接続する方法について詳しくは、以下の手順を参照してください。

必要な資格情報の収集

Salesforce ソースは、OAuth2 クライアント資格情報による認証をサポートしています。

OAuth 2 クライアント資格情報を使用してSalesforce アカウントをFlow Serviceに接続するには、次の資格情報の値を指定します。

資格情報
説明
environmentUrl
Salesforce ソースインスタンスのURL。 environmentUrlの形式はhttps://[domain].my.salesforce.comです
clientId
クライアント IDは、OAuth2認証の一環として、クライアント秘密鍵と並行して使用されます。 クライアント IDとクライアント秘密鍵を組み合わせることで、アプリケーションをSalesforceに対して識別し、アカウントの代理でアプリケーションを操作できるようになります。
clientSecret
クライアント秘密鍵は、OAuth2認証の一環として、クライアント IDと並行して使用されます。 クライアント IDとクライアント秘密鍵を組み合わせることで、アプリケーションをSalesforceに対して識別し、アカウントの代理でアプリケーションを操作できるようになります。
apiVersion
使用しているSalesforce インスタンスのREST API バージョン。 API バージョンの値は、10進数でフォーマットする必要があります。 例えば、API バージョン 52を使用している場合、値を52.0として入力する必要があります。 このフィールドを空白のままにすると、Experience Platformは使用可能な最新バージョンを自動的に使用します。 この値は、OAuth2 Client Credential認証に必須です。
includeDeletedObjects
削除されたレコードをソフトで含めるかどうかを判断するために使用されるブール値。 trueに設定すると、ソフト削除されたレコードをSalesforce クエリに含め、アカウントからExperience Platformに取り込むことができます。 設定を指定しない場合、この値はデフォルトでfalseになります。
connectionSpec.id
接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。 Salesforce の接続仕様 ID は cfc0fee1-7dc0-40ef-b73e-d8b134c436f5 です。

SalesforceでのOAuthの使用について詳しくは、Salesforce OAuth認証フローに関するガイド ​を参照してください。

AzureにExperience PlatformのSalesforceのベース接続を作成します

ベース接続は、ソースの認証情報、接続の現在の状態、一意のベース接続IDなど、ソースとExperience Platform間の情報を保持します。 ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。

ベース接続を作成し、Salesforce アカウントをAzureのExperience Platformに接続するには、/connections エンドポイントにPOST リクエストを行い、リクエスト本文にSalesforce認証情報を入力します。

API 形式

POST /connections
選択してリクエストを表示

次のリクエストは、OAuth 2 クライアント資格情報を使用してSalesforceのベース接続を作成します。

code language-shell
curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "ACME Salesforce account",
      "description": "Salesforce account using OAuth 2",
      "auth": {
          "specName": "OAuth2 Client Credential",
          "params":
            "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com",
            "clientId": "xxxx",
            "clientSecret": "xxxx",
            "apiVersion": "60.0",
            "includeDeletedObjects": true
        }
      },
      "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
プロパティ 説明
auth.params.environmentUrl Salesforce インスタンスのURL。
auth.params.clientId Salesforce アカウントに関連付けられているクライアント ID。
auth.params.clientSecret Salesforce アカウントに関連付けられているクライアントの秘密鍵。
auth.params.apiVersion 使用しているSalesforce インスタンスのREST API バージョン。
auth.params.includeDeletedObjects 削除されたレコードをソフトに含めるかどうかを判断するために使用されるブール値。
connectionSpec.id Salesforce接続仕様ID: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5
選択して応答を表示

応答が成功すると、新しく作成したベース接続とその一意のIDが返されます。

code language-json
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}

SalesforceをAmazon Web Services (AWS)上のExperience Platformに接続 aws

AVAILABILITY
この節は、Amazon Web Services(AWS)で動作するExperience Platformの実装に適用されます。 AWS上で動作するExperience Platformは、現在、一部のお客様にご利用いただけます。 サポートされているExperience Platform インフラストラクチャについて詳しくは、Experience Platform マルチクラウドの概要を参照してください。

AWSでSalesforce ソースをExperience Platformに接続する方法について詳しくは、以下の手順を参照してください。

前提条件

AWSでExperience Platformに接続できるようにSalesforce アカウントを設定する方法について詳しくは、Salesforce 概要を参照してください。

AWS上のExperience PlatformでSalesforceのベース接続を作成する

ベース接続を作成し、AWS上のExperience PlatformにSalesforce アカウントを接続するには、/connections エンドポイントにPOST リクエストを行い、資格情報に適切な値を指定します。

API 形式

POST /connections

リクエスト

選択してリクエストを表示

次のリクエストは、AWS上のExperience PlatformでSalesforce ソースのベース接続を作成します。

code language-shell
curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "ACME Salesforce account on AWS",
      "description": "ACME Salesforce account on AWS",
      "auth": {
          "specName": "OAuth2 JWT Token Credential",
          "params":
            "jwtToken": "{JWT_TOKEN},
            "clientId": "xxxx",
            "clientSecret": "xxxx",
            "instanceUrl": "https://acme-enterprise-3126.my.salesforce.com"
        }
      },
      "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
      }
  }'

Salesforce jwtTokenを取得する方法について詳しくは、AWSでExperience Platformに接続するための Salesforce ソースの設定方法に関するガイドを参照してください。

応答

選択して応答を表示

応答が成功すると、新しく作成したベース接続とその一意のIDが返されます。

code language-json
{
    "id": "3e908d3f-c390-482b-9f44-43d3d4f2eb82",
    "etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}

接続ステータスの確認

接続ステータスを確認するには、/connections エンドポイントに対してGET リクエストを行い、作成手順で生成されたベース接続IDを指定します。

API 形式

GET /connections

リクエスト

選択してリクエストを表示

次のリクエストは、ベース接続ID 3e908d3f-c390-482b-9f44-43d3d4f2eb82の情報を取得します。

code language-shell
curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/3e908d3f-c390-482b-9f44-43d3d4f2eb82' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json' \

応答

初期化中
accordion
選択して応答の例を表示

次の応答は、initializing状態の間にベース接続ID 3e908d3f-c390-482b-9f44-43d3d4f2eb82に関する情報を表示します。

code language-json
{
  "items": [
    {
      "id": "3e908d3f-c390-482b-9f44-43d3d4f2eb82",
      "createdAt": 1736506325115,
      "updatedAt": 1736506325717,
      "createdBy": "acme@techacct.adobe.com",
      "updatedBy": "acme@techacct.adobe.com",
      "createdClient": "{CREATED_CLIENT}",
      "updatedClient": "{UPDATED_CLIENT}",
      "sandboxId": "{SANDBOX_ID}",
      "sandboxName": "{SANDBOX_NAME}",
      "imsOrgId": "{ORG_ID}",
      "name": "JWT Token Auth Authentication E2E-1736506322",
      "description": "Base Connection for salesforce E2E",
      "connectionSpec": {
        "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
        "version": "1.0"
      },
      "state": "initializing",
      "auth": {
        "specName": "OAuth2 JWT Token Credential",
        "params": {
          "jwtToken": "{JWT_TOKEN}",
          "clientId": "{CLIENT_ID}",
          "clientSecret": "{CLIENT_SECRET}",
          "instanceUrl": "https://acme-enterprise-3126.my.salesforce.com"
        }
      }
    }
  }
]
有効
accordion
選択して応答の例を表示

次の応答は、enabled状態の間にベース接続ID 3e908d3f-c390-482b-9f44-43d3d4f2eb82に関する情報を表示します。

code language-json
{
  "items": [
      {
        "id": "3e908d3f-c390-482b-9f44-43d3d4f2eb82",
        "createdAt": 1736506325115,
        "updatedAt": 1736506413299,
        "createdBy": "acme@techacct.adobe.com",
        "updatedBy": "acme@AdobeID",
        "createdClient": "{CREATED_CLIENT}",
        "updatedClient": "acme",
        "sandboxId": "{SANDBOX_ID}",
        "sandboxName": "{SANDBOX_NAME}",
        "imsOrgId": "{ORG_ID}",
        "name": "JWT Token Auth Authentication E2E-1736506322",
        "description": "Base Connection for salesforce E2E",
        "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
        },
        "state": "enabled",
        "auth": {
          "specName": "OAuth2 JWT Token Credential",
          "params": {
            "jwtToken": "{JWT_TOKEN}",
            "clientId": "{CLIENT_ID}",
            "clientSecret": "{CLIENT_SECRET}",
            "instanceUrl": "https://adb8-dev-ed.develop.my.salesforce.com",
            "orgId": "00DdL000001iPRxUAM"
          }
        },
        "version": "\"6d27f305-40be-41c3-97d4-a701827c34df\"",
        "etag": "\"6d27f305-40be-41c3-97d4-a701827c34df\""
    }
  ]
}

次の手順

このチュートリアルでは、Flow Service API を使用して Salesforce ベース接続を作成しました。 このベース接続 ID は、次のチュートリアルで使用できます。

recommendation-more-help
experience-platform-help-sources