Salesforce CDP での同意 API の使用

必須権限

同意 API 用の Salesforce CDP のパラメータを使用するには、ModifyAllData または ConsentApiUpdate ユーザ権限を持っている必要があります。権限を必須にすることで、システム管理者は明示的権限を付与できます。これらのパラメータによって、通常はシステム管理者以外のユーザがアクセスできないレコード間のリンクや同意フラグの値などの組織全体の同意データが書き込まれます。

Salesforce CDP の読み取りパラメータ

同意 API を使用することで、Salesforce CDP プロファイルに関する情報を収集できます。以下のように Salesforce CDP の actions パラメータおよび ids パラメータを使用します。この ids 値は [個人 ID] 属性に等しい文字列です。

構文

HTTP のメソッド

GET

適用開始バージョン:

48.0

URI

/services/data/vXX.X/consent/action/action?ids=list_of_ids&mode=CDP

要求のパラメータ

パラメータ	説明
action	どちらかのモード設定で使用できます。各アクションに関連付けられた使用可能な値に「?」を続けたもの (action/track? パラメータなど) を含めます。action に使用可能な値は次のとおりです。 portability process shouldForget
ids	必須。ID のカンマ区切りのリスト。ID には、レコード ID か、レコードに記載されたメールアドレスを使用できます。mode が cdp に設定されている場合、ids 値は [個人 ID] 属性に等しい文字列です。これは同意を同期するために使用されるメールアドレスです。

Salesforce CDP の読み取り例

URI

/services/data/v50.0/consent/action/action?ids=00932I3SU92&mode=CDP

応答

{ "j00932I3SU92" : { "result" : "Success", "proceed" : { "portability" : "true" "portabilityResult" : "Success" } } }

Salesforce CDP の書き込みパラメータ

同意 API を使用することで、Salesforce CDP プロファイルに情報を書き込むこともできます。下記のように actions パラメータ、blobParam パラメータ、ids パラメータ、mode パラメータを使用します。

この ids 値は [個人 ID] 属性に等しい文字列です。blobParam パラメータは可搬性に関する要求の S3 バケットの場所を Salesforce CDP に渡すために使用します。

構文

HTTP のメソッド

PATCH

適用開始バージョン

50.0

URI

/services/data/vxx.0/consent/action/action?ids=list_of_ids&mode=CDP

要求のパラメータ

パラメータ	説明
action	どちらかのモード設定で使用できます。各アクションに関連付けられた使用可能な値に「?」を続けたもの (action/track? パラメータなど) を含めます。action に使用可能な値は次のとおりです。 portability process shouldForget
ids	必須。ID のカンマ区切りのリスト。ID には、レコード ID か、レコードに記載されたメールアドレスを使用できます。mode が cdp の場合、ids 値は [個人 ID] 属性に等しい文字列です。これは同意を同期するために使用されるメールアドレスです。
mode	省略可能。デフォルト値は normal です。有効な値は normal または cdp です。mode が cdp に設定されている場合、使用されるパラメータは ids、action、blobParamids のみです。
status	必須。同意の状況 (OptIn、OptOut)。Write API のみで使用されます。
aws_s3_bucket_id	mode が cdp、action が portability の場合にのみ必須です。このパラメータは、PATCH リクエストボディの一部として渡す必要があります。このパラメータは可搬性に関する要求の S3 バケットの場所を Salesforce CDP に渡すために使用します。
aws_access_key_id	mode が cdp、action が portability の場合にのみ必須です。このパラメータは、PATCH リクエストボディの一部として渡す必要があります。このパラメータは可搬性に関する要求の S3 バケットのアクセスキーを Salesforce CDP に渡すために使用します。
aws_secret_access_key	mode が cdp、action が portability の場合にのみ必須です。このパラメータは、PATCH リクエストボディの一部として渡す必要があります。このパラメータは可搬性に関する要求の S3 バケットの秘密のアクセスキーを Salesforce CDP に渡すために使用します。
aws_s3_folder	mode が cdp、action が portability の場合にのみ必須です。このパラメータは、PATCH リクエストボディの一部として渡す必要があります。このパラメータは可搬性に関する要求の S3 バケットのフォルダを Salesforce CDP に渡すために使用します。
aws_region	mode が cdp、action が portability の場合にのみ必須です。このパラメータは、PATCH リクエストボディの一部として渡す必要があります。このパラメータは可搬性に関する要求の S3 バケットの aws リージョンを Salesforce CDP に渡すために使用します。

Salesforce CDP の書き込み例

URI

/services/data/v53.0/consent/action/portability?ids=00932I3SU92&mode=CDP&status=optin

リクエストボディ

1{
2		"aws_s3_bucket_id": "<the AWS s3 bucket id where your data will be exported>",
3		"aws_access_key_id": "<your AWS access key id>",
4		"aws_secret_access_key": "<your AWS secret access key>",
5		"aws_s3_folder": "<your AWS s3 bucket folder where data will be exported>",
6		"aws_region": "<your AWS region, such as us-west-2>"
7		}