Data Cloud での同意 API の使用

必須権限

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

同意 API でサポートされる Data Cloud でのアクション

Data Cloud の読み取りパラメーター

同意 API を使用することで、Data Cloud プロファイルに関する情報を収集できます。Data Cloud の mode および ids パラメーターの使用方法は次のとおりです。

構文

HTTP のメソッド

GET

適用開始バージョン:

48.0

URI

同意 API は、アクションに基づき 3 種類の URI を使用してアクセスできます。サポートされているアクションは processing、portability、および shouldforget です。

メモ

1/services/data/vXX.X/consent/action/processing?ids=<list_of_ids>&mode=<cdp>
2/services/data/vXX.X/consent/action/portability?ids=<list_of_ids>&mode=<cdp>
3/services/data/vXX.X/consent/action/shouldforget?ids=<list_of_ids>&mode=<cdp>

要求のパラメーター

パラメーター	説明
ids	必須。ID のカンマ区切りのリスト。指定された ID は、Individual.Individual ID に対応付けられた項目に存在する必要があります。
mode	省略可能。デフォルト値は normal です。Data Cloud プロファイルを取得する場合の有効な値は cdp です。

読み取り例

URI

/services/data/v60.0/consent/action/portability?ids=00932I3SU92&mode=cdp

応答

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

書き込みパラメーター

構文

HTTP のメソッド

PATCH

適用開始バージョン

50.0

アクション処理時の URI

/services/data/vXX.X/consent/action/processing?ids=list_of_ids&mode=cdp&status=optin or optout

アクション処理時の要求パラメーター

パラメーター	説明
ids	必須。ID のカンマ区切りのリスト。指定された ID は、Individual.Individual ID に対応付けられた項目に存在する必要があります。
mode	省略可能。デフォルト値は normal です。Data Cloud プロファイルの更新に使用できる有効な値は cdp です。
status	必須。同意の状況。有効な値は、optin または optout です。ただし、アクション処理時は、状況に optout を使用してください。

アクションが shouldforget の場合の URI

/services/data/vXX.X/consent/action/shouldforget?ids=list_of_ids&mode=cdp&status=optin or optout

アクションが shouldforget の場合の要求パラメーター

パラメーター	説明
ids	必須。ID のカンマ区切りのリスト。指定された ID は、Individual.Individual ID に対応付けられた項目に存在する必要があります。
mode	省略可能。デフォルト値は normal です。Data Cloud プロファイルの更新に使用できる有効な値は cdp です。
status	必須。同意の状況。有効な値は、optin または optout です。ただし、アクションが shouldforget の場合は、状況に optin を使用してください。

アクションが portability の場合の URI

/services/data/vXX.X/consent/action/portability?ids=list_of_ids&mode=cdp&status=optin or optout

アクションが portability の場合の要求パラメーター

パラメーター	説明
ids	必須。ID のカンマ区切りのリスト。指定された ID は、Individual.Individual ID に対応付けられた項目に存在する必要があります。
mode	省略可能。デフォルト値は normal です。Data Cloud プロファイルの更新に使用できる有効な値は cdp です。
status	必須。同意の状況。有効な値は、optin または optout です。ただし、アクションが portability の場合は、状況に optin を使用してください。
aws_s3_bucket_id	mode が cdp、action が portability の場合にのみ必須です。このパラメーターは、PATCH リクエストボディの一部として渡す必要があります。このパラメーターは可搬性に関する要求の S3 バケットの場所を Data Cloud に渡すために使用します。
aws_access_key_id	mode が cdp、action が portability の場合にのみ必須です。このパラメーターは、PATCH リクエストボディの一部として渡す必要があります。このパラメーターは可搬性に関する要求の S3 バケットのアクセスキーを Data Cloud に渡すために使用します。
aws_secret_access_key	mode が cdp、action が portability の場合にのみ必須です。このパラメーターは、PATCH リクエストボディの一部として渡す必要があります。このパラメーターは可搬性に関する要求の S3 バケットの秘密のアクセスキーを Data Cloud に渡すために使用します。
aws_s3_folder	mode が cdp、action が portability の場合にのみ必須です。このパラメーターは、PATCH リクエストボディの一部として渡す必要があります。このパラメーターは可搬性に関する要求の S3 バケットのフォルダーを Data Cloud に渡すために使用します。
aws_region	mode が cdp、action が portability の場合にのみ必須です。このパラメーターは、PATCH リクエストボディの一部として渡す必要があります。このパラメーターは可搬性に関する要求の S3 バケットの aws リージョンを Data Cloud に渡すために使用します。

書き込みの例

アクションが processing の場合

1/services/data/v60.0/consent/action/processing?ids=100000695&mode=cdp&status=optout
2body: {}

アクションが portability の場合

1/services/data/v60.0/consent/action/portability?ids=100000695&mode=cdp&status=optin
2   body:{
3          "aws_s3_bucket_id" : "cdpgdprtest",
4          "aws_access_key_id": "ABCD1234WEXAMPLE",
5          "aws_secret_access_key": "WXYZ1234EXAMPLE",
6          "aws_s3_folder": "yyun/Person",
7          "aws_region": "us-west-1"
8        }

アクションが shouldforget の場合

1/services/data/v60.0/consent/action/shouldforget?ids=100000695 &mode=cdp&status=optin
2body: {}