Skip to content

Commit 9e6f1d6

Browse files
authored
New event statuses
Resolves issue InteractiveAdvertisingBureau#37
1 parent 87935c4 commit 9e6f1d6

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

Core/CMP API Specification.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,8 @@ cmpStatus : String, // possible values: stub, loading, loaded, error
162162

163163
cmpDisplayStatus: String, // possible values: hidden, visible, disabled
164164

165+
signalStatus : String, // possible values: not ready, ready
166+
165167
supportedAPIs : Array of string, // list of supported APIs (prefix strings), e.g. used while loading. Example: ["tcfeuv2","uspv1"]
166168

167169
cmpId : Number, // IAB assigned CMP ID, may be 0 during stub/loading
@@ -211,6 +213,21 @@ cmpId : Number, // IAB assigned CMP ID, may be 0 during stub/loading
211213
</td>
212214
</td>
213215
</tr>
216+
<tr>
217+
<td><code>'ready'</code></td>
218+
<td>signalStatus</td>
219+
<td>Is NULL when there is no display layer. Vendors should rely solely on signalStatus.</td>
220+
</tr>
221+
<tr>
222+
<td><code>'not ready'</code></td>
223+
<td>signalStatus</td>
224+
<td>The CMP is not ready to respond to any calling scripts with the corresponding GPP string and applicable section ids.</td>
225+
</tr>
226+
<tr>
227+
<td><code>Null / not set</code></td>
228+
<td>signalStatus</td>
229+
<td>The CMP is ready to respond to any calling scripts with the corresponding GPP string and applicable section ids.</td>
230+
</tr>
214231
</table>
215232

216233

@@ -304,7 +321,13 @@ A call to the `addEventListener` command must always respond with a return objec
304321
<tr>
305322
<td><code>cmpDisplayStatus</code></td>
306323
<td>string</td>
307-
<td>Event is called whenever the display status of the CMP changes (e.g. the CMP shows the consent layer). The data property will contain the new display status (e.g. “visible”).</td>
324+
<td>Event is called whenever the display status of the CMP changes (e.g. the CMP shows the consent layer). The data property will contain the new display status (e.g. “visible”). Note that this is only applicable when a consent layer is displayed.</td>
325+
</tr>
326+
<tr>
327+
<td><code>signalStatus</code></td>
328+
<td>string</td>
329+
<td>Event is called whenever the signalStatus changes.
330+
</td>
308331
</tr>
309332
<tr>
310333
<td><code>error</code></td>

0 commit comments

Comments
 (0)