@iabgpp/cmpapi

Encode/decode consent information with the IAB GPP Framework

(https://iabtechlab.com/gpp/)

Methods available to CMPs

constructor(cmpId: number, cmpVersion: number, customCommands?: CustomCommands)
fireEvent(eventName: string, value: any)
fireErrorEvent(value: string)
fireSectionChange(value: string)
getEventStatus()
setEventStatus(eventStatus: EventStatus)
getCmpStatus()
setCmpStatus(cmpStatus: CmpStatus)
getCmpDisplayStatus(): CmpDisplayStatus
setCmpDisplayStatus(cmpDisplayStatus: CmpDisplayStatus)
getApplicableSections(): number[]
setApplicableSections(applicableSections: number[]): void
getSignalStatus(): SignalStatus
setSignalStatus(signalStatus: SignalStatus): void
setGppString(encodedGppString: string): void
getGppString(): string
setSectionString(sectionName: string, encodedSectionString: string): void
setSectionStringById(sectionId: number, encodedSectionString: string): void
getSectionString(sectionName: string): string
getSectionStringById(sectionId: number): string
setFieldValue(sectionName: string, fieldName: string, value: any): void
setFieldValueBySectionId(sectionId: number, fieldName: string, value: any)
getFieldValue(sectionName: string, fieldName: string): any
getFieldValueBySectionId(sectionId: number, fieldName: string)
getSection(sectionName: string): any
getSectionById(sectionId: number): any
hasSection(sectionName: string): any
hasSectionId(sectionId: number): any
deleteSection(sectionName: string)
deleteSectionById(sectionId: number)
clear()
getObject()
getGvlFromVendorList(vendorList: VendorList): GVL
async getGvlFromUrl(gvlUrlConfig: GVLUrlConfig): Promise<GVL>

Commands available to consumers

__gpp("addEventListener", callback?, parameter?)
__gpp("getField", callback?, parameter?)
__gpp("getSection", callback?, parameter?)
__gpp("hasSection", callback?, parameter?)
__gpp("ping", callback?, parameter?)
__gpp("removeEventListener", callback?, parameter?)

CMP usage Example

<script>
  import {CmpApi} from '@iabgpp/cmpapi'; const cmpApi = new CmpApi(1, 3); cmpApi.setGppString(gppString);
  cmpApi.setFieldValue("uspv1", "OptOutSale", 0); cmpApi.fireUpdate("uspv1"); console.log(cmpApi.getGppString());
</script>

Consumer usage example

<script src="/js/stub/stub.js"></script>
<script>
  console.log(__gpp("ping"));

  __gpp("addEventListener", function (evt) {
    console.log("Received uspv1 event: " + evt);
    console.log(__gpp("getGPPString"));
  }, "uspv1");

  if(__gpp("hasSection", null, "tcfeuv2")) {
    console.log(__gpp("getSection", null, "tcfeuv2"));
  }

  if(__gpp("hasSection", null, "uspv1")) {
    console.log(__gpp("getField", null, "uspv1.OptOutSale"));
  }
</script>

Fields

| Section Name | Section ID | Field | Data Type/Value | | ------------ | ---------- | ----------------------------------- | -------------------------------------------------------------- | | tcfeuv2 | 2 | Version | 6 bit int. Value is 2. | | tcfeuv2 | 2 | Created | Datetime. Updated when fields are set | | tcfeuv2 | 2 | LastUpdated | Datetime. Updated when fields are set | | tcfeuv2 | 2 | CmpId | 12 bit int | | tcfeuv2 | 2 | CmpVersion | 12 bit int | | tcfeuv2 | 2 | ConsentScreen | 6 bit int | | tcfeuv2 | 2 | ConsentLanguage | 2 character country code | | tcfeuv2 | 2 | VendorListVersion | 12 bit int | | tcfeuv2 | 2 | PolicyVersion | 6 bit int. Value is 2 | | tcfeuv2 | 2 | IsServiceSpecific | Boolean | | tcfeuv2 | 2 | UseNonStandardStacks | Boolean | | tcfeuv2 | 2 | SpecialFeatureOptins | Boolean array of size 12 | | tcfeuv2 | 2 | PurposeConsents | Boolean array of size 24 | | tcfeuv2 | 2 | PurposeLegitimateInterests | Boolean array of size 24 | | tcfeuv2 | 2 | PurposeOneTreatment | Boolean | | tcfeuv2 | 2 | PublisherCountryCode | 2 character country code | | tcfeuv2 | 2 | VendorConsents | Integer array of variable size | | tcfeuv2 | 2 | VendorLegitimateInterests | Integer array of variable size | | tcfeuv2 | 2 | PublisherRestrictions | Integer array of variable size | | tcfeuv2 | 2 | PublisherPurposesSegmentType | 3 bit int. Value is 3 | | tcfeuv2 | 2 | PublisherConsents | Boolean array of size 24 | | tcfeuv2 | 2 | PublisherLegitimateInterests | Boolean array of size 24 | | tcfeuv2 | 2 | NumCustomPurposes | 6 bit int | | tcfeuv2 | 2 | PublisherCustomConsents | Boolean array where size is set by the NumCustomPurposes field | | tcfeuv2 | 2 | PublisherCustomLegitimateInterests | Boolean array where size is set by the NumCustomPurposes field | | tcfeuv2 | 2 | VendorsAllowedSegmentType | 3 bit int. Value is 2 | | tcfeuv2 | 2 | VendorsAllowed | Integer array of variable size | | tcfeuv2 | 2 | VendorsDisclosedSegmentType | 3 bit int. Value is 1 | | tcfeuv2 | 2 | VendorsDisclosed | Integer array of variable size | | tcfcav1 | 5 | Version | 6 bit int. Value is 2. | | tcfcav1 | 5 | Created | Datetime. Updated when any fields are set | | tcfcav1 | 5 | LastUpdated | Datetime. Updated when any fields are set | | tcfcav1 | 5 | CmpId | 12 bit int | | tcfcav1 | 5 | CmpVersion | 12 bit int | | tcfcav1 | 5 | ConsentScreen | 6 bit int | | tcfcav1 | 5 | ConsentLanguage | 2 character country code | | tcfcav1 | 5 | VendorListVersion | 12 bit int | | tcfcav1 | 5 | TcfPolicyVersion | 6 bit int. Value is 2. | | tcfcav1 | 5 | UseNonStandardStacks | Boolean | | tcfcav1 | 5 | SpecialFeatureExpressConsent | Boolean array of size 12 | | tcfcav1 | 5 | PurposesExpressConsent | Boolean array of size 24 | | tcfcav1 | 5 | PurposesImpliedConsent | Boolean array of size 24 | | tcfcav1 | 5 | VendorExpressConsent | Integer array of variable size | | tcfcav1 | 5 | VendorImpliedConsent | Integer array of variable size | | tcfcav1 | 5 | PubPurposesSegmentType | 3 bit int. Value is 3 | | tcfcav1 | 5 | PubPurposesExpressConsent | Boolean array of size 24 | | tcfcav1 | 5 | PubPurposesImpliedConsent | Boolean array of size 24 | | tcfcav1 | 5 | NumCustomPurposes | 6 bit int | | tcfcav1 | 5 | CustomPurposesExpressConsent | Boolean array where size is set by the NumCustomPurposes field | | tcfcav1 | 5 | CustomPurposesImpliedConsent | Boolean array where size is set by the NumCustomPurposes field | | uspv1 | 6 | Version | 6 bit int. Value is 1 | | uspv1 | 6 | Notice | 2 bit int | | uspv1 | 6 | OptOutSale | 2 bit int | | uspv1 | 6 | LspaCovered | 2 bit int | | usnat | 7 | Version | 6 bit int. Value is 1 | | usnat | 7 | SharingNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | SaleOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | SharingOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | TargetedAdvertisingOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | SensitiveDataProcessingOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | SensitiveDataLimitUseNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | SaleOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | SharingOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | TargetedAdvertisingOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | SensitiveDataProcessing | 2 bit int array of size 12. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | KnownChildSensitiveDataConsents | 2 bit int array of size 2. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | PersonalDataConsents | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | MspaCoveredTransaction | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | MspaOptOutOptionMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | MspaServiceProviderMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usnat | 7 | GpcSegmentType | 2 bit int. Value is 1 | | usnat | 7 | GpcSegmentIncluded | Boolean. Default is true | | usnat | 7 | Gpc | Boolean | | usca | 8 | Version | 6 bit int. Value is 1 | | usca | 8 | SaleOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | SharingOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | SensitiveDataLimitUseNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | SaleOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | SharingOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | SensitiveDataProcessing | 2 bit int array of size 9. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | KnownChildSensitiveDataConsents | 2 bit int array of size 2. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | PersonalDataConsents | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | MspaCoveredTransaction | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | MspaOptOutOptionMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | MspaServiceProviderMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usca | 8 | GpcSegmentType | 2 bit int. Value is 1 | | usca | 8 | GpcSegmentIncluded | Boolean. Default is true | | usca | 8 | Gpc | Boolean | | usva | 9 | Version | 6 bit int. Value is 1 | | usva | 9 | SharingNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usva | 9 | SaleOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usva | 9 | TargetedAdvertisingOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usva | 9 | SaleOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usva | 9 | TargetedAdvertisingOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usva | 9 | SensitiveDataProcessing | 2 bit int array of size 8. 0=Not applicable, 1=Yes, 2=No | | usva | 9 | KnownChildSensitiveDataConsents | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usva | 9 | MspaCoveredTransaction | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usva | 9 | MspaOptOutOptionMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usva | 9 | MspaServiceProviderMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | Version | 6 bit int. Value is 1 | | usco | 10 | SharingNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | SaleOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | TargetedAdvertisingOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | SaleOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | TargetedAdvertisingOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | SensitiveDataProcessing | 2 bit int array of size 7. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | KnownChildSensitiveDataConsents | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | MspaCoveredTransaction | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | MspaOptOutOptionMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | MspaServiceProviderMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usco | 10 | GpcSegmentType | 2 bit int. Value is 1 | | usco | 10 | GpcSegmentIncluded | Boolean. Deafult is true | | usco | 10 | Gpc | Boolean | | usut | 11 | Version | 6 bit int. Value is 1 | | usut | 11 | SharingNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usut | 11 | SaleOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usut | 11 | TargetedAdvertisingOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usut | 11 | SensitiveDataProcessingOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usut | 11 | SaleOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usut | 11 | TargetedAdvertisingOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usut | 11 | SensitiveDataProcessing | 2 bit int array of size 8. 0=Not applicable, 1=Yes, 2=No | | usut | 11 | KnownChildSensitiveDataConsents | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usut | 11 | MspaCoveredTransaction | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usut | 11 | MspaOptOutOptionMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usut | 11 | MspaServiceProviderMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | Version | 6 bit int. Value is 1 | | usct | 12 | SharingNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | SaleOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | TargetedAdvertisingOptOutNotice | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | SaleOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | TargetedAdvertisingOptOut | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | SensitiveDataProcessing | 2 bit int array of size 8. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | KnownChildSensitiveDataConsents | 2 bit int array of size 3. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | MspaCoveredTransaction | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | MspaOptOutOptionMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | MspaServiceProviderMode | 2 bit int. 0=Not applicable, 1=Yes, 2=No | | usct | 12 | GpcSegmentType | 2 bit int. Value is 1 | | usct | 12 | GpcSegmentIncluded | Boolean. Default is true | | usct | 12 | Gpc | Boolean |

Example Usage / Encoder / Decoder

https://iabgpp.com