add docs on consent metadata

prebid · Feb 9, 2022 · 01b17c4 · 01b17c4
1 parent 25232ee
commit 01b17c4
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/dev-docs/publisher-api-reference/getConsentMetadata.md b/dev-docs/publisher-api-reference/getConsentMetadata.md
@@ -0,0 +1,25 @@
+---
+layout: api_prebidjs
+title: pbjs.getConsentMetadata()
+description: 
+---
+
+
+The `getConsentMetadata()` function will return basic information about the status of supported (and configured!) consent content within Prebid.
+
+```
+pbjs.getConsentMetadata() // returns e.g.
+{
+    "coppa": false,
+    "gdpr": {
+        "apiVersion": 2,
+        "consentStringExists": true,
+        "gdprApplies": true,
+        "timestamp": 1644358143306
+    },
+    "usp": {
+        "timestamp": 1644358143306,
+        "usp": "1YYY"
+    }
+}
+```