顧客認証設定
Experience Platformは、パートナーや顧客が利用できるプロトコルで、多くの業界標準の認証方法をサポートしています。 任意の業界標準の認証方法(OAuth2、ベアラートークン認証、パスワード認証、その他多数)をサポートするように宛先を設定できます。
このページでは、好みの認証方法を使用して宛先を設定する方法について説明します。 宛先の作成時に使用する認証設定に基づいて、顧客はExperience Platform UIで宛先に接続する際に、様々な種類の認証ページを表示します。
このコンポーネントがDestination SDKで作成された統合にどこで適合するかを理解するには、設定オプション ドキュメントの図を参照するか、次の宛先設定の概要ページを参照してください。
お客様がExperience Platformから宛先にデータを書き出す前に、宛先接続 チュートリアルで説明されている手順に従って、Experience Platformとお客様の宛先との間に新しい接続を作成する必要があります。
宛先 ~ Destination SDKを作成する場合、customerAuthenticationConfigurations セクションでは、認証画面で顧客に表示される内容を定義します。 宛先認証タイプに応じて、顧客は、様々な認証の詳細を指定する必要があります。以下に例を示します。
- 基本認証を使用する宛先の場合、ユーザーはExperience Platform UI認証ページで直接ユーザー名とパスワードを指定する必要があります。
- ベアラー認証を使用する宛先の場合、ユーザーは、ベアラートークンを指定する必要があります。
- OAuth2認証を使用する宛先の場合、ユーザーは宛先のサインインページにリダイレクトされ、そこで資格情報を使用してログインできます。
- Amazon S3 宛先の場合、ユーザーは、Amazon S3 アクセスキーおよび秘密鍵を指定する必要があります。
- Azure Blob 宛先の場合、ユーザーは、Azure Blob 接続文字列を指定する必要があります。
/authoring/destinations エンドポイントを介して顧客認証の詳細を設定できます。 このページに表示されるコンポーネントを設定できる、詳細な API 呼び出しの例については、以下の API リファレンスページを参照してください。
この記事では、宛先に使用できるサポートされているすべての顧客認証設定について説明し、宛先に設定した認証方法に基づいてExperience Platform UIに表示される顧客の内容を示します。
サポートされる統合タイプ supported-integration-types
このページで説明される機能をサポートする統合のタイプについて詳しくは、以下の表を参照してください。
認証ルール設定 authentication-rule
このページで説明されている任意の顧客認証設定を使用する場合、以下に示すように、常に、宛先配信の authenticationRule パラメーターを "CUSTOMER_AUTHENTICATION" に設定します。
{
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"{{destinationServerId}}"
}
]
}
基本認証 basic
基本的な認証は、Experience Platformのリアルタイム (ストリーミング)統合でサポートされています。
基本認証タイプを設定する場合、ユーザーはユーザー名とパスワードを入力して宛先に接続する必要があります。
宛先用に基本認証を設定するには、以下に示すように、/destinations エンドポイントを介して customerAuthenticationConfigurations セクションを設定します。
"customerAuthenticationConfigurations":[
{
"authType":"BASIC"
}
]
基本認証ヘッダーのカスタマイズ basic-override
デフォルトでは、Experience PlatformはBase64でエンコードされたusername:password文字列を作成し、Authorization ヘッダー値として送信します。 Oracle Eloquaなどの一部の宛先では、デフォルトのビヘイビアーに依存するのではなく、Authorization ヘッダーを明示的に構築する必要があります。
デフォルトの基本認証ヘッダーを上書きするには、宛先サーバー設定とオーディエンスメタデータテンプレートの両方にカスタム Authorization ヘッダーを追加します。 Pebble テンプレート言語を使用して、ユーザーが提供する資格情報からBase64 エンコードされた値を構築します。
宛先サーバー(httpTemplate.headers)
宛先サーバー設定で、httpTemplate セクションの下にheaders配列を、既存のhttpMethodおよびその他のテンプレート値と一緒に追加します。
{
"httpTemplate": {
"httpMethod": "POST",
"headers": [
{
"header": "Authorization",
"value": {
"templatingStrategy": "PEBBLE_V1",
"value": "Basic {{ (authData.username + ':' + authData.password) | base64encode }}"
}
}
]
}
}
urlおよびその他の必須フィールドを含む、完全な宛先サーバーペイロード構造については、宛先サーバーの作成を参照してください。
オーディエンスメタデータテンプレート (metadataTemplate.create.headers, metadataTemplate.update.headers)
オーディエンスメタデータテンプレート で、同じヘッダーを各操作ブロック(create、update、およびAPIを呼び出し、認証を必要とするその他の操作)に、その操作の既存のurlおよびhttpMethod フィールドと一緒に追加します。
{
"metadataTemplate": {
"create": {
"url": "https://example.com/audiences",
"httpMethod": "POST",
"headers": [
{
"header": "Authorization",
"value": "Basic {{ (authData.username + ':' + authData.password) | base64encode }}"
}
]
}
}
}
オーディエンスメタデータテンプレートヘッダーでは、宛先サーバーヘッダーではvalue オブジェクトをtemplatingStrategyおよびvalue フィールドで使用しますが、フラット文字列valueが使用されることに注意してください。 完全なオーディエンステンプレートペイロード構造については、 オーディエンステンプレートの作成を参照してください。
customerAuthenticationConfigurations セクションで"authType": "BASIC"を設定します。 オーバーライドは、Authorization ヘッダー値の構築方法のみを変更します。 認証タイプは変更されません。ベアラー認証 bearer
ベアラー認証タイプを設定する場合、ユーザーは宛先から取得したベアラートークンを入力する必要があります。
宛先用にベアラー認証を設定するには、以下に示すように、/destinations エンドポイントを介して customerAuthenticationConfigurations セクションを設定します。
"customerAuthenticationConfigurations":[
{
"authType":"BEARER"
}
]
OAuth 2 認証 oauth2
ユーザーは、宛先に接続を選択して、OAuth 2認証フローを宛先にトリガーします(以下のTwitter カスタムオーディエンスの宛先の例を参照)。 宛先エンドポイントへの OAuth 2 認証の設定について詳しくは、専用の Destination SDK OAuth 2 認証ページをお読みください。
宛先用に OAuth2 認証を設定するには、以下に示すように、/destinations エンドポイントを介して customerAuthenticationConfigurations セクションを設定します。
"customerAuthenticationConfigurations":[
{
"authType":"OAUTH2"
}
]
Amazon S3 認証 s3
Amazon S3認証は、Experience Platformのファイルベースの宛先でサポートされています。
Amazon S3認証タイプを設定する場合、ユーザーはAmazon S3資格情報を入力する必要があります。
宛先用に Amazon S3 認証を設定するには、以下に示すように、/destinations エンドポイントを介して customerAuthenticationConfigurations セクションを設定します。
"customerAuthenticationConfigurations":[
{
"authType":"S3"
}
]
Azure Blob 認証 blob
Azure Blob Storage認証は、Experience Platformのファイルベースの宛先でサポートされています。
Azure Blob認証タイプを設定する場合、ユーザーは接続文字列を入力する必要があります。
宛先用に Azure Blob 認証を設定するには、以下に示すように、/destinations エンドポイントで customerAuthenticationConfigurations パラメーターを設定します。
"customerAuthenticationConfigurations":[
{
"authType":"AZURE_CONNECTION_STRING"
}
]
Azure Data Lake Storage 認証 adls
Azure Data Lake Storage認証は、Experience Platformのファイルベースの宛先でサポートされています。
Azure Data Lake Storage認証タイプを設定する場合、ユーザーはAzure サービス プリンシパルの資格情報とテナント情報を入力する必要があります。
宛先用に Azure Data Lake Storage(ADLS)認証を設定するには、以下に示すように、/destinations エンドポイントの customerAuthenticationConfigurations パラメーターを設定します。
"customerAuthenticationConfigurations":[
{
"authType":"AZURE_SERVICE_PRINCIPAL"
}
]
パスワード認証付きSFTP sftp-password-auth
パスワードによるSFTP認証は、Experience Platformのファイルベースの宛先でサポートされています。
パスワード認証タイプでSFTPを設定する場合、ユーザーはSFTPのユーザー名とパスワード、およびSFTP ドメインとポートを入力する必要があります(デフォルトのポートは22)。
パスワードを使用した SFTP 認証を宛先に設定するには、/destinations エンドポイントの customerAuthenticationConfigurations パラメーターを以下のように設定します。
"customerAuthenticationConfigurations":[
{
"authType":"SFTP_WITH_PASSWORD"
}
]
SFTP (キー認証SSH) sftp-ssh-key-auth
SSH キーを使用したSFTP認証は、Experience Platformのファイルベースの宛先でサポートされています。
SFTPをSSH キー認証タイプで設定する場合、ユーザーはSFTP ユーザー名とSSH キー、およびSFTP ドメインとポート (既定のポートは22)を入力する必要があります。
SSH キーを使用した SFTP 認証を宛先に設定するには、/destinations エンドポイントの customerAuthenticationConfigurations パラメーターを以下のように設定します。
"customerAuthenticationConfigurations":[
{
"authType":"SFTP_WITH_SSH_KEY"
}
]
Google Cloud Storage 認証 gcs
Google Cloud Storage認証は、Experience Platformのファイルベースの宛先でサポートされています。
Google Cloud Storage認証タイプを設定する場合、ユーザーはGoogle Cloud Storage アクセスキーIDと シークレットアクセスキーを入力する必要があります。
宛先用に Google Cloud Storage 認証を設定するには、以下に示すように、/destinations エンドポイントで customerAuthenticationConfigurations パラメーターを設定します。
"customerAuthenticationConfigurations":[
{
"authType":"GOOGLE_CLOUD_STORAGE"
}
]
次の手順 next-steps
次に、その他の宛先コンポーネントを設定します。 詳しくは、次の記事を参照してください。