[Ultimate]{class="badge positive"}

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

IMPORTANT
AWS Redshift ソースは、Real-Time Customer Data Platform Ultimateを購入したユーザーがソースカタログで利用できます。

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

はじめに

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

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

Experience Platform APIの使用

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

AWS RedshiftをAzure上のExperience Platformに接続 azure

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

必要な資格情報の収集

Flow ServiceとAWS Redshiftを接続するために必要な接続プロパティを指定します。 オプションのtable プロパティを指定して、1つのテーブルへの接続をスコープに指定することもできます。

資格情報
説明
server
AWS Redshift インスタンスのサーバー名。
port
AWS Redshift サーバーがクライアント接続をリッスンするために使用するTCP ポート。
username
AWS Redshift アカウントに関連付けられているユーザー名。
password
ユーザーアカウントに対応するパスワード。
database
データの取得元となるAWS Redshift データベース。
table
オプション。 この接続のスコープを設定するテーブル。 {SCHEMA}.{TABLE}を使用(例:test_schema.my_table)。 1つのスキーマと1つのテーブルを1つのピリオドで区切って指定します。
connectionSpec.id
接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。 AWS Redshiftの接続仕様IDは3416976c-a9ca-4bba-901a-1f08f66978ffです。

開始の詳細については、このAWS Redshift ドキュメント ​を参照してください。

Azure [#azure-base]上のExperience PlatformでAWS Redshiftのベース接続を作成します

NOTE
Redshiftのデフォルトのエンコーディング標準はUnicodeです。 これは変更できません。

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

ベース接続 ID を作成するには、/connections エンドポイントに POST リクエストを実行し、AWS Redshift 認証資格情報をリクエストパラメーターの一部として使用します。

1つのテーブルへの接続を範囲するには、リクエストにauth.params.tableを含めます。 指定すると、ルート探索(GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root)は、指定されたテーブルのみを返します。 ルート探索中にデータベース内のテーブルの完全なリストを返すには、auth.params.tableを省略します。

API 形式

POST /connections

リクエスト

選択してサンプルを表示

次のリクエストは、単一のテーブルにスコープが設定されたAWS Redshiftのベース接続を作成します。

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": "AWS-redshift base connection",
      "description": "base connection for AWS-redshift",
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "server": "{SERVER}",
              "port": "{PORT}",
              "username": "{USERNAME}",
              "password": "{PASSWORD}",
              "database": "{DATABASE}",
              "table": "{SCHEMA}.{TABLE}"
          }
      },
      "connectionSpec": {
          "id": "3416976c-a9ca-4bba-901a-1f08f66978ff",
          "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 7-row-2
プロパティ 説明
auth.params.server AWS Redshift インスタンスのサーバー名。
auth.params.port AWS Redshift サーバーがクライアント接続をリッスンするために使用するTCP ポート。
auth.params.username AWS Redshift アカウントに関連付けられているユーザー名。
auth.params.password ユーザーアカウントに対応するパスワード。
auth.params.database データの取得元となるAWS Redshift データベース。
auth.params.table オプション。 この接続のスコープを設定するテーブル。 <schema>.<table>を使用(例:test_schema.my_table)。 1つのスキーマと1つのテーブルを1つのピリオドで区切って指定します。 指定した場合、ルート探索は指定されたテーブルのみを返します。 省略すると、ルート探索はデータベース内のすべてのテーブルを返します。
connectionSpec.id AWS Redshift 接続仕様 ID:3416976c-a9ca-4bba-901a-1f08f66978ff

応答

選択してサンプルを表示

リクエストが成功した場合は、一意の ID(id)を含む、新しく作成された接続が応答として返されます。 このIDは、次のチュートリアルでデータを検索するために必要です。

code language-json
{
    "id": "373e88fc-43da-4e3c-be88-fc43da3e3c0f",
    "etag": "\"1700ce7b-0000-0200-0000-5e3b405e0000\""
}

AWS RedshiftをAWS Web サービス(AWS)上のExperience Platformに接続 aws

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

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

AWS上のExperience PlatformでAWS Redshiftのベース接続を作成する aws-base

API 形式

POST /connections

リクエスト

次のリクエストは、AWS Redshift のベース接続を作成します。

選択してサンプルを表示
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": "AWS Redshift base connection for Experience Platform on AWS",
      "description": "AWS Redshift base connection for Experience Platform on AWS",
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "server": "{SERVER}",
              "port": "5439",
              "username": "{USERNAME}",
              "password": "{PASSWORD}",
              "database": "{DATABASE}",
              "schema": "{SCHEMA}"
          }
      },
      "connectionSpec": {
          "id": "3416976c-a9ca-4bba-901a-1f08f66978ff",
          "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 7-row-2
プロパティ 説明
auth.params.server AWS Redshift インスタンスのサーバー名。
auth.params.port AWS Redshift サーバーがクライアント接続をリッスンするために使用するTCP ポート。
auth.params.username AWS Redshift アカウントに関連付けられているユーザー名。
auth.params.password ユーザーアカウントに対応するパスワード。
auth.params.database データの取得元となるAWS Redshift データベース。
auth.params.schema AWS Redshift データベースに関連付けられているスキーマの名前。 データベースにアクセス権を付与するユーザーがこのスキーマにもアクセス権を持っていることを確認する必要があります。
connectionSpec.id AWS Redshift 接続仕様 ID:3416976c-a9ca-4bba-901a-1f08f66978ff

応答

リクエストが成功した場合は、一意の ID(id)を含む、新しく作成した接続の詳細が返されます。 このIDは、次のチュートリアルでストレージを探索するために必要です。

選択してサンプルを表示
code language-json
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}

次の手順

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

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