ストリーミング先の構成

概要

この構成を使用すると、宛先名、カテゴリ、説明など、ストリーミング先に関する重要な情報を指定できます。 また、この構成での設定は、Experience Platform ユーザーが宛先に対して認証する方法、Experience Platform ユーザーインターフェイスに表示される方法、宛先に書き出すことができる ID も決定します。

宛先サーバーが動作するために必須である他の構成（宛先サーバーとオーディエンスメタデータ）も、この構成に接続されます。この 2 つの構成を参照する方法については、下記の節をお読みください。

このドキュメントで説明する機能は、/authoring/destinations API エンドポイントを用いて構成することができます。エンドポイントで実行できる操作の完全なリストには、宛先 API エンドポイントの操作をお読みください。

ストリーミングの構成の例

これは架空のストリーミング先である Moviestar の構成例です。同社には世界の 4 か所にエンドポイントがあります。 宛先は、モバイル宛先カテゴリに属しています。

{
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointRegion",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{

            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      }
   },
   "schemaConfig":{
      "profileRequired":false,
      "segmentRequired":true,
      "identityRequired":true
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "aggregation":{
      "aggregationType":"CONFIGURABLE_AGGREGATION",
      "configurableAggregation":{
         "splitUserById":true,
         "maxBatchAgeInSecs":2400,
         "maxNumEventsInBatch":5000,
         "aggregationKey":{
            "includeSegmentId":true,
            "includeSegmentStatus":true,
            "includeIdentity":true,
            "oneIdentityPerGroup":false,
            "groups":[
               {
                  "namespaces":[
                     "IDFA",
                     "GAID"
                  ]
               },
               {
                  "namespaces":[
                     "EMAIL"
                  ]
               }
            ]
         }
      }
   },
   "backfillHistoricalProfileData":true
}

顧客認証の構成

宛先の構成内のこのセクションは、Experience Platform ユーザーインターフェイスの新しい宛先の構成ページを生成し、顧客が宛先で持っているアカウントに Experience Platform を接続します。authType フィールドで指定した認証オプションに応じて、次のようにユーザー用の Experience Platform ページが生成されます。

ベアラー認証

ベアラー認証タイプを設定する場合、ユーザーは接続先から取得したベアラートークンを入力する必要があります。

OAuth 2 認証

ユーザーが「宛先に接続」を選択すると、以下の Twitter カスタムオーディエンスの宛先の例のように、宛先への OAuth 2 認証フローがトリガーされます。宛先エンドポイントへの OAuth 2 認証の設定について詳しくは、専用の Destination SDK OAuth 2 認証ページをお読みください。

顧客データフィールド

Experience Platform UI で宛先に接続する際に、このセクションを使用して、宛先に固有のカスタムフィールドに入力するようユーザーに求めます。次に示すように、設定は認証フローに反映されます。

UI 属性

この節では、Adobe Experience Platform ユーザーインターフェイスで宛先に対してアドビが使用する、上記の設定の UI 要素について説明します。次を参照してください。

マッピングステップのスキーマ構成

schemaConfig のパラメーターを使用して、宛先のアクティベーションのワークフローのマッピングステップを有効にします。以下に説明するパラメーターを使用することで、Experience Platform ユーザーがプロファイル属性や ID を宛先側の目的のスキーマにマッピングできるかどうかを判断できます。

ID と属性

このセクションのパラメーターは、宛先がどの ID を受け入れるかを決定します。また、この構成は、Experience Platform ユーザーインターフェースのマッピングステップで、ユーザーが XDM スキーマから宛先のスキーマに ID や属性をマッピングする際のターゲット ID や属性にも入力されます。

どの Platform ID の顧客が宛先に書き出すことができるかを示す必要があります。例として、Experience Cloud ID、ハッシュ化されたメール、デバイス ID（IDFA、GAID）などがあります。これらの値は、Platform ID 名前空間であり、宛先から顧客が ID 名前空間にマッピングできます。また、宛先でサポートされている ID に顧客がカスタム名前空間をマッピングできるかどうかを指定することもできます。

ID 名前空間は、Platform と宛先が 1 対 1 で対応している必要はありません。
例えば、顧客は Platform IDFA 名前空間を宛先からの IDFA 名前空間にマッピングすることができ、また顧客は同じ Platform IDFA 名前空間を宛先の Customer ID 名前空間にマッピングすることもできます。

詳しくは、ID 名前空間の概要を参照してください。

宛先配信

セグメントマッピングの構成

宛先設定の当該セクションは、セグメント名や ID などのセグメントメタデータを Experience Platform と宛先間で共有する方法に関する内容です。

また、audienceTemplateId を通じて、このセクションはこの構成とオーディエンスメタデータの構成を結びつけています。

上記の構成で示されたパラメーターは、宛先エンドポイント API リファレンスに記載されています。

集計ポリシー

このセクションでは、Experience Platform がデータを書き出す際に使用する集計ポリシーを設定できます。

集計ポリシーは、書き出されたプロファイルがデータの書き出しでどのように結合されるかを決定します。 利用可能なオプションは次のとおりです。

• ベストエフォート集計
• 構成可能な集計（上記の構成を参照）

テンプレートの使用に関する節と集計の主な例を読んで、選択した集約ポリシーに基づいてメッセージ変換テンプレートに集約ポリシーを含める方法を理解します。

ベストエフォート集計

このオプションでは、リクエストあたりのプロファイル数が少ないほうが好まれ、多くのデータで少ない数のリクエストを受けるよりも、少ないデータで多くのリクエストを受けることを希望する宛先に最適です。

maxUsersPerRequest パラメータを使用して、宛先がリクエストで受け取ることができるプロファイルの最大数を指定します。

構成可能な集計

このオプションは、同じ呼び出しに何千ものプロファイルを含む、大きなバッチを取りたい場合に最適です。また、このオプションを使用すると、複雑な集計ルールに基づいて、書き出されたプロファイルを集計できます。

このオプションを使用すると、次のことが可能です。

• 宛先に対する API 呼び出しが行われるまでの最大時間およびプロファイルの最大数を集計するように設定します。
• 次の条件に基づいて、宛先にマッピングされた書き出し済みのプロファイルを集計します。
  • セグメント ID：
  • セグメントのステータス：
  • ID または ID のグループ。

集計パラメータの詳細な説明は、Destinations API エンドポイントの操作のリファレンスページで各パラメータの説明を参照してください。

プロファイル選定履歴

宛先の設定にある backfillHistoricalProfileData パラメーターを使用すると、履歴プロファイルの選定を宛先に書き出す必要があるかどうかを決定することができます。

この構成が宛先に必要なすべての情報をどのように接続するか

宛先設定の一部は、宛先サーバーまたはオーディエンスメタデータの構成で構成する必要があります。ここで説明する宛先の構成は、以下のように他の 2 つの構成を参照することで、これらの設定をすべて接続するものです。

• destinationServerId を使用して、宛先サーバーと宛先に設定されたテンプレート構成を参照します。
• audienceMetadataId を使用して、宛先に設定されたオーディエンスメタデータの構成を参照します。

Business.Adobe.com リソース