この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Customer 360 利用者での同意 API の使用

同意 API では Customer 360 利用者をサポートしています。このサポートには、Customer 360 利用者で使用する同意 API のパラメータおよびアクションが含まれます。同意 API を使用して、Customer 360 利用者プロファイルでの読み取りと書き込みを行います。Customer 360 利用者内での消費者の権利のガイダンスについては、Salesforce の担当者にお問い合わせください。

必須権限

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

Customer 360 利用者の読み取りパラメータ

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

構文

HTTP のメソッド
GET
適用開始バージョン:
48.0
URI
/services/data/vxx.0/consent/action/portability?ids=list_of_ids&mode=CDP
応答
{ "j00932I3SU92" : { "result" : "Success", "proceed" : { "portability" : "true" "portabilityResult" : "Success" } } }
要求のパラメータ
パラメータ 説明
action どちらかのモード設定で使用できます。各アクションに関連付けられた使用可能な値に「?」を続けたもの (action/track? パラメータなど) を含めます。action に使用可能な値は次のとおりです。
  • portability
  • process
  • shouldForget
ids 必須。ID のカンマ区切りのリスト。ID には、レコード ID か、レコードに記載されたメールアドレスを使用できます。mode が cdp に設定されている場合、ids 値は [個人 ID] 属性に等しい文字列です。これは同意を同期するために使用されるメールアドレスです。

action が使用されている場合、actions は使用できません。

Customer 360 利用者の読み取り例

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

Customer 360 利用者の書き込みパラメータ

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

この ids 値は [個人 ID] 属性に等しい文字列です。blobParam は可搬性に関する要求の S3 バケットの場所などの情報を Customer 360 利用者に渡すために使用されます。

構文

HTTP のメソッド
PATCH
適用開始バージョン
50.0
URI
/services/data/vxx.0/consent/action/portability?ids=list_of_ids&mode=CDP
応答
{ "j00932I3SU92" : { "result" : "Success", "proceed" : { "portability" : "true" "portabilityResult" : "Success" } } }
要求のパラメータ
パラメータ 説明
action どちらかのモード設定で使用できます。各アクションに関連付けられた使用可能な値に「?」を続けたもの (action/track? パラメータなど) を含めます。action に使用可能な値は次のとおりです。
  • portability
  • process
  • shouldForget
blobParam 省略可能。mode が cdp の場合のみ使用されます。このパラメータは、PATCH リクエストボディの一部として渡す必要があります。このパラメータは可搬性の書き込み位置などの情報を Customer 360 利用者に渡すために使用されます。mode=cdp の場合に含めることができます。
ids 必須。ID のカンマ区切りのリスト。ID には、レコード ID か、レコードに記載されたメールアドレスを使用できます。mode が cdp の場合、ids 値は [個人 ID] 属性に等しい文字列です。これは同意を同期するために使用されるメールアドレスです。
mode 省略可能。デフォルト値は normal です。有効な値は normal または cdp です。mode が cdp に設定されている場合、使用されるパラメータは ids、action、blobParamids のみです。

Customer 360 利用者の書き込み例

URI
/services/data/v50.0/consent/action/portability?ids=00932I3SU92&mode=CDP&status=optin
リクエストボディ
{ "blobParam": "{ "aws_s3_bucket_id" : "cdptest", "aws_access_key_id": "XXXXXXX", "aws_secret_access_key": "YYYYYYYYYY", "aws_s3_folder": "xxxx", "aws_region": "us-west-2” }" }