同意

構文

ユーザは同意についての要求を複数の場所に保存し、一貫性がない可能性もあるため、顧客に関連するレコードで要求を簡単に見つけられるようになっています。これにより、システム管理者とユーザは、顧客のレコードで最も制限の厳しい好みを考慮できます。

API は、次の action に基づいて同意の詳細を返します。

• email
• geotrack
• phone
• fax
• solicit
• process
• プロファイル
• track
• portability
• storePiiElsewhere
• shouldForget

URI

/services/data/v44.0/consent/action/action?ids=list_of_Ids&verbose=true_or_false&aggregatedConsent=true_or_false

適用開始バージョン

44.0

形式

JSON

HTTP メソッド

GET

認証

Authorization: Bearer token

リクエストボディ

None

要求パラメータ

パラメータ	説明
ids	必須。ID のカンマ区切りのリスト。ID は、個人、取引先責任者、リード、取引先、PersonAccount、またはユーザのエンティティに属するレコード ID またはメールアドレスです。 別のメールアドレスがない限り、リンク先オブジェクトが含まれます。その場合は、必須の ID をすべてリストする必要があります。 メモ
verbose	省略可能: true または false。verbose のみの場合は、verbose=true と同じです。verbose レスポンスの例を参照してください。
aggregatedConsent	省略可能: true または false。aggregatedConsent のみの場合は、aggregatedConsent=true と同じです。true の場合、各 ID の結果ではなく、全体の結果が 1 つ返されます (つまり、進むか否か)。リスト内のいずれかの ID で false が返されると、集計された結果は false になります。

エラーコード

コード	説明
URI_TOO_LONG	URL の合計長は 16,000 文字までに制限されます。そのため、1 件の要求の ID の上限は約 800 件となります。
INVALID_ID	レコード ID が同意関連オブジェクト (ユーザ、個人、リード、取引先責任者、PersonAccount) のレコードの形式ではありません。
INFO_NOT_FOUND	レコード ID またはメールアドレスは有効でしたが、同意情報が見つかりませんでした。
CONVERTED_LEAD_IS_INVALID	変換されたリードは使用できません。

セキュリティ

Consent REST API をコールするユーザはシステム管理者であるか、PrivacyDataAccess ユーザ権限が有効になっている必要があります。この権限を必須にすることで、システム管理者は明示的権限を付与できます。これは、この API が、ユーザが通常アクセスするレコードだけでなく、レコード間のリンクや同意フラグの値など、組織全体の同意データにアクセスするためです。

例

単純な URI 構造

1/services/data/v44.0/consent/action/track?ids=003xx000004TxyY,00Qxx00000syyO,003zz000004zzZ

ID としてのメールアドレス、および verbose レスポンス

1/services/data/v44.0/consent/action/email?ids=j0t5t5b2@tkbxp5ia.com,4quxlswo@23wj7pwh.com&verbose=true

応答

1{
2  "j0t5t5b2@tkbxp5ia.com" : {
3    "result" : "Success",
4    "proceed" : {
5      "email" : "false"
6    },
7    "explanation" : [ {
8      "objectConsulted" : "Contact",
9      "field" : "HasOptedOutOfEmail",
10      "recordId" : "003xx000004TxyY",
11      "value" : "true"
12    } ]
13  },
14  "4quxlswo@23wj7pwh.com" : {
15    "result" : "Success",
16    "proceed" : {
17      "email" : "true"
18    },
19    "explanation" : [ {
20      "objectConsulted" : "Contact",
21      "field" : "HasOptedOutOfEmail",
22      "recordId" : "003xx000004TxyZ",
23      "value" : "false"
24    } ]
25  }
26}

使用方法

次の表に、API レスポンスの決定方法を示します。