Salesforce CDP での同意 API の使用

必須権限

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

Salesforce CDP の使用により同意 API でサポートされるアクション

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

同意 API を使用することで、Salesforce CDP プロファイルに関する情報を収集できます。Salesforce CDP の 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 には、レコード ID か、レコードに記載されたメールアドレスを使用できます。mode が cdp に設定されている場合、ids 値は [個人 ID] 属性に等しい文字列です。これは同意を同期するために使用されるメールアドレスです。
mode	省略可能。デフォルト値は normal です。CDP プロファイルを取得する場合の有効な値は cdp です。

Salesforce CDP の読み取り例

URI

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

応答

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

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

構文

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 には、レコード ID か、レコードに記載されたメールアドレスを使用できます。mode が cdp の場合、ids 値は [個人 ID] 属性に等しい文字列です。これは同意を同期するために使用されるメールアドレスです。
mode	省略可能。デフォルト値は normal です。CDP プロファイルの更新に使用できる有効な値は cdp です。
status	必須。同意の状況。有効な値は、optin または optout です。ただし、アクション処理時は、状況に optout を使用してください。

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

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

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

パラメータ	説明
ids	必須。ID のカンマ区切りのリスト。ID には、レコード ID か、レコードに記載されたメールアドレスを使用できます。mode が cdp の場合、ids 値は [個人 ID] 属性に等しい文字列です。これは同意を同期するために使用されるメールアドレスです。
mode	省略可能。デフォルト値は normal です。CDP プロファイルの更新に使用できる有効な値は cdp です。
status	必須。同意の状況。有効な値は、optin または optout です。ただし、アクションが portability の場合は、状況に optout を使用してください。

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

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

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

パラメータ	説明
ids	必須。ID のカンマ区切りのリスト。ID には、レコード ID か、レコードに記載されたメールアドレスを使用できます。mode が cdp の場合、ids 値は [個人 ID] 属性に等しい文字列です。これは同意を同期するために使用されるメールアドレスです。
mode	省略可能。デフォルト値は normal です。CDP プロファイルの更新に使用できる有効な値は cdp です。
status	必須。同意の状況。有効な値は、optin または optout です。ただし、アクションが portability の場合は、状況に optin を使用してください。
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 の書き込み例

アクションが processing の場合

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

アクションが portability の場合

1/services/data/v55.0/consent/action/portability?ids=100000695&mode=cdp&status=optin
2   body:{
3          "aws_s3_bucket_id" : "cdpgdprtest",
4          "aws_access_key_id": "AKIAS4AK7TBJBHUPOBEI",
5          "aws_secret_access_key": "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",
6          "aws_s3_folder": "yyun/Person",
7          "aws_region": "us-west-1"
8        }

アクションが shouldforget の場合

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