Skip to content

Commit d34525f

Browse files
authored
Merge pull request #98 from InteractiveAdvertisingBureau/develop
Consent string clarifications
2 parents c334e3c + 4cfb1eb commit d34525f

File tree

2 files changed

+259
-35
lines changed

2 files changed

+259
-35
lines changed

Diff for: Core/CMP API Specification.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,18 @@ Requirements for the interface:
113113

114114
All CMPs must support all generic commands. Generic commands are commands that can be used independent of [section specifications](https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Sections/SectionInformation.md). All generic commands must always be executed immediately without any asynchronous logic and call the supplied callback function immediately. The generic commands are: [‘ping’](#ping), [‘addEventListener’](#addeventlistener), [‘removeEventListener’](#removeeventlistener), [‘hasSection’](#hassection), [‘getSection’](#getsection), and [‘getField’](#getfield).
115115

116+
117+
### What is CMP ID?
118+
119+
120+
Regional section policy writers may require CMPs to register to operate within the policies for that section. In these cases, CMP IDs must be used if the CMP has an ID. For CMPs that are not registered, a value of 1 must be used by string creators who do not have a CMP ID and are not using a commercially available CMP.
121+
122+
**Examples:**
123+
124+
Publisher A looking to create a GPP string that will contain the section for the US National approach must use 1 as value for CMP ID since the MSPA does not have CMP registration requirements.
125+
126+
Publisher B looking to create a GPP string that will contain sections for the US National approach or the TCF EU must register themselves or work with a registered CMP and use the assigned CMP ID in accordance with the TCF Policies.
127+
116128
________
117129
#### `ping` <a name="ping"></a>
118130

@@ -166,7 +178,7 @@ signalStatus : String, // possible values: not ready, ready
166178

167179
supportedAPIs : Array of string, // list of supported APIs (section ids and prefix strings), e.g. used while loading. Example: ["2:tcfeuv2","6:uspv1"]
168180

169-
cmpId : Number, // IAB assigned CMP ID, may be 0 during stub/loading
181+
cmpId : Number, // IAB assigned CMP ID, may be 0 during stub/loading. Reference the above CMP ID section for additional information.
170182

171183
sectionList : Array of Number, // may be empty during loading of the CMP
172184

0 commit comments

Comments
 (0)