1. Sourcepoint
  2. API
  3. GDPR Standard API

getCustomVendorConsents command (GDPR Standard)

Sourcepoint offers your organization additional commands that can be used for GDPR Standard web implementations. This provides a level of consistency and feature overlap between IAB TCF and Standard integrations.

The getCustomVendorConsents command enables your organization to handle vendors participating in Standard campaigns.

getCustomVendorConsents command

The command returns a JSON object that contains information on IAB and custom vendors an end-user consents to, the legitimate interest, and consent purposes mapped to a vendor. The format of the getCustomVendorConsents command is as follows:

Browser console command

//Input into browser console to receive response
window._sp_.gdpr.getCustomVendorConsents((vendorConsents, success) => console.log(vendorConsents));

getCustomVendorConsents response

The response is a JSON object that contains the consent data and is divided into four parts - consentedPurposes, consentedVendors, grants, legIntPurposes. 

Consented purposes

The consentedPurposes section lists the purposes that apply to the end-user. The consented purposes are listed as follows:

Parameter Description
_id Purpose ID
name Purpose name as defined in each vendor list
length Number of consented purposes 
index: {_id: "purpose id", name: "purpose description"}
consentedPurposes: Array(3)
   0: {_id: "5ff4ca88f485275018dd8b9e", name: "Performance"}
   1: {_id: "5ff4ca88f485275018dd8b99", name: "Social Media"}
   2: {_id: "5ff4ca88f485275018dd8ba3", name: "Personal Ads"}
   length: 3

Consented vendors

The consentedVendors section lists the custom vendors in the vendor list that apply to the end-user. The custom vendors are listed as follows:

Parameter Description
_id Vendor ID
name Vendor name as defined in each vendor list
vendorType The vendor type, if the vendor is custom or affiliated to the IAB 
index: {_id: "vendor id", name: "vendor name", vendorType: "vendor type"}
consentedVendors: Array(5)
   0: {_id: "5f44223409125a7ed754367e", name: "Ceros", vendorType: "CUSTOM"}
   1: {_id: "5fd78083fc186126cb9fabad", name: "media control GmbH", vendorType: "CUSTOM"}
   2: {_id: "5f3a3e66ee0a81887437291c", name: "Trivago", vendorType: "CUSTOM"}
   3: {_id: "5f3a3e66ee0a81887437291c", name: "Trivago", vendorType: "CUSTOM"}
   4: {_id: "5fd78083fc186126cb9fabad", name: "Google Charts", vendorType: "CUSTOM"}

Grants

The grants section lists the consented purposes for each vendor. The consented purposes are listed as follows:

Parameter Description
vendor_id Vendor ID
purpose_id Purpose ID
status Status is true if the purpose applies to an end-user
vendorGrant • Status is true if all purposes for a vendor apply to an end-user

• Status is false if one or more purposes for a vendor do not apply to an end-user.		 
vendor_id: purposeGrants: { "purpose_id 1": status, "purpose_id 2": status, ...}, vendorGrant: status

The vendorGrant status is set to true if the end-user has granted consent to all purposes assigned to a vendor. If the end-user denies consent for one or more purposes then the vendorGrant status is set to false

grants:
   5f3a3e66ee0a81887437291c:    
      purposeGrants: {
         5ff4ca88f485275018dd8b9e: true,
         5ff4ca88f485275018dd8b99: true,
         5ff4ca88f485275018dd8ba3: true
      },
      vendorGrant: true

Legitimate Interest Purposes

The legIntPurposes section lists the purposes that are listed as legitimate interest for all vendors. The legitimate interest purposes are listed as follows:

Parameter Description
_id Purpose ID
name Purpose description as defined in each vendor list 
index: {_id: "purpose id", name: "purpose description"}
legIntPurposes: Array(2)
   0: {_id: "5ff4ca88f485275018dd8b99", name: "Social Media"}
   1: {_id: "5ff4ca88f485275018dd8ba3", name: "Personalised Ads"}
   length: 2

Articles in this section

Was this article helpful?
0 out of 0 found this helpful