ベータ版
Flow Service API を使用して、新しい接続仕様を作成します。
メモ接続仕様は、ソースの構造を表します。ソースの認証要件に関する情報が含まれ、ソースデータの調査および検査方法が定義され、特定のソースの属性に関する情報が提供されます。Flow Service API の /connectionSpecs エンドポイントを使用すると、組織内の接続仕様をプログラムで管理できます。
次のドキュメントでは、Flow Service API を使用して接続仕様を作成し、セルフサービスソース（ストリーミング SDK）を使用して新しいソースを統合する手順を説明します。
はじめに
先に進む前に、はじめる前にを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API を正常に呼び出すために必要なヘッダーに関する重要な情報を確認してください。
アーティファクトを収集
セルフサービスソースを使用して新しいストリーミングソースを作成するには、まずAdobeと調整し、プライベート Git リポジトリーをリクエストし、ソースのラベル、説明、カテゴリ、アイコンに関する詳細Adobeと整合する必要があります。
指定したら、以下のようにプライベート Git リポジトリを構築する必要があります。
-
ソース
-
-
アーティファクト
- {your_source}-category.txt
- {your_source}-description.txt
- {your_source}-icon.svg
- {your_source}-label.txt
- {your_source}-connectionSpec.json
-
-
| アーティファクト（ファイル名） | 説明 | 例 |
|---|---|---|
| ソースの名前。 このフォルダーには、プライベート Git リポジトリー内の、ソースに関連するすべてのアーティファクトを格納する必要があります。 | medallia | |
| {your_source}-category.txt | ソースが属するカテゴリで、テキストファイルとして書式設定されます。 注意：ソースが上記のカテゴリに適合しないと思われる場合は、Adobe担当者に問い合わせて話し合ってください。 | medallia-category.txt ファイル内で、ソースのカテゴリを次のように指定してください：streaming。 |
| {your_source}-description.txt | ソースの簡単な説明。 | Medallia は、マーケティングデータをExperience Platformに取り込むために使用できる Medallia ーケティング自動化ソースです。 |
| {your_source}-icon.svg | Experience Platformソースカタログ内のソースを表すために使用される画像。 このアイコンは、SVGファイルである必要があります。 | |
| {your_source}-label.txt | Experience Platformソースカタログに表示されるソースの名前。 | Medallia |
| {your_source}-connectionSpec.json | ソースの接続仕様を含む JSON ファイル。 このファイルは最初は必要ありません。このガイドの完了時に、接続仕様にデータが入力されるからです。 | medallia-connectionSpec.json |
ヒントtext を使用できます。必要なファイルをプライベート Git リポジトリに追加したら、Adobeがレビューできるようにプルリクエスト（PR）を作成する必要があります。 PR が承認されて統合されると、ソースのラベル、説明、アイコンを参照するために接続仕様に使用できる ID が提供されます。
次に、以下に説明する手順に従って、接続仕様を設定します。 高度なスケジュール、カスタムスキーマ、様々なページネーションタイプなど、ソースに追加できる様々な機能に関する追加のガイダンスについては、 ソース仕様の設定に関するガイドを参照してください。
接続仕様テンプレートをコピー
必要なアーティファクトを収集したら、以下の接続仕様テンプレートを選択したテキストエディターにコピー＆ペーストし、括弧内の属性 {} を特定のソースに関連する情報で更新します。
{
"name": "generic-streaming",
"type": "generic-streaming",
"description": "{DESCRIPTION}",
"providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
"version": "1.0",
"attributes": {
"category": "Streaming",
"isSource": true,
"documentationLink": "https://docs.adobe.com/content/help/ja-JP/platform-learn/tutorials/data-ingestion/understanding-streaming-ingestion.html",
"uiAttributes": {
"apiFeatures": {
"updateSupported": false
}
}
},
"authSpec": [],
"name": "generic-streaming",
"permissionsInfo": {
"view": [
{
"name": "StreamingSource",
"@type": "lowLevel",
"permissions": [
"read"
]
}
],
"manage": [
{
"name": "StreamingSource",
"@type": "lowLevel",
"permissions": [
"write"
]
}
]
},
"providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
"sourceSpec": {
"attributes": {
"authRequired": false,
"uiAttributes": {
"documentationLink": "http://www.adobe.com/go/understanding-data-streaming-ingestion-en",
"isSource": true,
"monitoringSupported": false,
"category": {
"key": "streaming"
},
"icon": {
"key": "generic"
},
"description": {
"text": "Generic Streaming For Authentication Testing 2"
},
"label": {
"text": "Generic Streaming For Authentication Testing 2"
},
"frequency": {
"text": "Generic Streaming"
}
}
}
},
"exploreSpec": {
"type": "StreamingConnection"
}
}