[Ultimate]{class="badge positive"}

Flow Service API を使用した Amazon Kinesis ソース接続の作成

Last update: Fri Apr 04 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：

作成対象：

開発者

IMPORTANT

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

このチュートリアルでは、 Flow Service API を使用して Amazon Kinesis（以下「Kinesis」）を Experience Platform に接続する手順を詳しく説明します。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。

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

次の節では、Flow Service API を使用してExperience Platformに正しく接続するために必要 Kinesis 追加情報を示します。

必要な資格情報の収集

Flow Service を Amazon Kinesis アカウントに接続するには、次の接続プロパティの値を指定する必要があります。

資格情報

説明

accessKeyId

アクセスキー ID は、Kinesis アカウントをExperience Platformに認証するために使用されるアクセスキーのペアの一方です。

secretKey

秘密アクセスキーは、Kinesis アカウントをExperience Platformに認証するために使用されるアクセスキーのペアの残りの半分です。

region

Kinesis アカウントの地域。地域について詳しくは、許可リストへの IP アドレスの追加に関するガイドを参照してください。

connectionSpec.id

接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。Kinesis 接続仕様 ID は 86043421-563b-46ec-8e6c-e23184711bf6 です。

アクセスキーとその生成方法について詳 Kinesis くは、この AWS IAM ユーザーのアクセスキーの管理に関するガイドを参照してください。

Experience Platform API の使用

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

ベース接続の作成

ソース接続を作成する最初の手順は、Kinesis ソースを認証し、ベース接続 ID を生成することです。ベース接続 ID を使用すると、ソース内を移動してファイルを探索し、データのタイプや形式に関する情報など、取り込みたい特定の項目を識別できます。

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

API 形式

POST /connections

リクエスト

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": "Amazon Kinesis connection",
        "description": "Connector for Amazon Kinesis",
        "providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
        "auth": {
            "specName": "Aws Kinesis authentication credentials",
            "params": {
                "accessKeyId": "{ACCESS_KEY_ID}",
                "secretKey": "{SECRET_KEY}",
                "region": "{REGION}"
            }
        },
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        }
    }'

プロパティ

説明

auth.params.accessKeyId

Kinesis アカウントのアクセスキー ID。

auth.params.secretKey

Kinesis アカウントの秘密アクセスキー。

auth.params.region

Kinesis アカウントの地域。

connectionSpec.id

Kinesis 接続仕様 ID：86043421-563b-46ec-8e6c-e23184711bf6

応答

リクエストが成功した場合は、一意の ID（id）を含め、新しく作成されたベース接続の詳細が返されます。この ID は、次の手順でソース接続を作成する際に必要になります。

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

ソース接続の作成 source

ソース接続は、データの取り込み元となる外部ソースへの接続を作成および管理します。ソース接続は、データソース、データ形式、データフローの作成に必要なソース接続 ID などの情報で構成されます。ソース接続インスタンスは、テナントと組織に固有です。

ソース接続を作成するには、Flow Service API の /sourceConnections エンドポイントに POST リクエストを実行します。

API 形式

POST /sourceConnections

リクエスト

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
    -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 Kinesis source connection",
        "description": "A source connection for AWS Kinesis",
        "baseConnectionId": "4cb0c374-d3bb-4557-b139-5712880adc55",
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        },
        "data": {
            "format": "json"
        },
        "params": {
            "stream": "{STREAM}",
            "dataType": "raw",
            "reset": "latest"
        }
    }'

プロパティ

説明

name

ソース接続の名前。ソース接続の情報を検索する際に使用できるので、ソース接続の名前はわかりやすいものにしてください。

description

指定するとソース接続に関する詳細情報を含めることができるオプションの値。

baseConnectionId

前の手順で生成された Kinesis ソースのベース接続 ID。

connectionSpec.id

Kinesis の固定接続仕様 ID。この ID は 86043421-563b-46ec-8e6c-e23184711bf6 です。

data.format

取り込む Kinesis データの形式。現在、サポートされているデータ形式は json のみです。

params.stream

レコードを取り込むデータストリームの名前。

params.dataType

このパラメーターは、取り込まれるデータのタイプを定義します。raw および xdm を含むデータタイプがサポートされています。

params.reset

このパラメーターは、データの読み取り方法を定義します。 latest を使用すると、最新のデータから読み取りを開始でき、earliest を使用すると、ストリーム内の最初の使用可能なデータから読み取りを開始できます。

応答

リクエストが成功した場合は、新しく作成されたソース接続の一意の ID（id）が返されます。この ID は、次のチュートリアルでデータフローを作成する際に必要です。

{
    "id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
    "etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}

次の手順

このチュートリアルでは、Flow Service API を使用して Kinesis ソース接続を作成しました。次のチュートリアルでは、このソース接続 ID を使用して、 Flow Service API を使用したストリーミングデータフローの作成を行います。

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089