同意

構文

Consent API は、レコードに参照関係がある場合、取引先責任者オブジェクト、個人オブジェクト、リードオブジェクト、個人取引先オブジェクト、ユーザオブジェクトに保存された同意設定を集計します。

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

リクエストボディ

なし

要求パラメータ

パラメータ	説明
action	必須。有効な値は、次のとおりです。 email fax geotrack phone portability process profile shouldForget solicit storePiiElsewhere track action として email を選択すると、同じメールアドレスを含むレコードの同意のみが集計されます。URI で指定されたレコード ID が異なるメールアドレスを含むレコードに関連付けられている場合、その関連レコードの同意設定は API レスポンスに含まれません。 メモ
aggregatedConsent	省略可能: true または false。aggregatedConsent は、aggregatedConsent=true と同じです。true の場合、各 ID の結果ではなく、進むか否かを示す結果が 1 つ返されます。リスト内のいずれかの ID で false が返されると、集計された結果は false になります。
ids	必須。ID のカンマ区切りのリスト。ID には、レコード ID か、レコードに記載されたメールアドレスを使用できます。
verbose	省略可能: true または false。verbose は verbose=true と同じです。verbose レスポンスは、verbose 以外のレスポンスより時間がかかります。verbose レスポンスの例を参照してください。

エラーコード

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

セキュリティ

Consent API をコールするには、「すべてのデータの参照」または「プライバシーデータへのユーザのアクセスを許可」ユーザ権限を持っている必要があります。権限を必須にすることで、システム管理者は明示的権限を付与できます。これは、この 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 レスポンスの決定方法を示します。