Search

Available Parameters to the Script

Below is a list of available parameters you can include in your GPC code. 

NOTE: These parameters must be set inside the gpcConfig object for the script to function properly. You can view a sample usage of this by clicking the Global Privacy Control button under the Publish page of an Intake Form in the IRM Portal. 

  • geoLocationCodes (Array of strings - Optional)
    TrustArc’s customers may want to recognize the GPC only in certain GeoLocations such as California. They can do this by setting GeoLocation in the script. If this parameter is not set or not passed, then GPC recognition is done for all visiting end users without considering the geolocations they come from. The format of geolocation is: ContinentCode_CountryCode_StateCode. StateCode is optional for most cases. Example for United States, California: NA_US_CA (North America, United States, California). Please see Appendix B for a list of geolocation codes. 

    IRM_geoLocationCodes.png
  • showRecognizedGPCImage (Boolean - Optional)
    Default value is false. This flag decides whether to show a “GPC detected” image if GPC is detected for a consumer in their subsequent ( second time onwards) visits. This “GPC detected” image is shown on the bottom right of the webpage, but the location where this image is shown can be controlled using CSS.

    IRM_showRecognizedGPCImage.png
  • showFormForUnsubmittedDSR (Boolean - Optional)
    Default value is false. This decides whether to show the intake or consent form on a consumer's subsequent visits if the form was shown previously, but Consent was not submitted. Consumers may choose to ignore the “Opt-Out” DSR submission during their first visit when GPC is detected on their browsers. If the above flag is set to true, then even on subsequent visits, the GPC banner is displayed as long as GPC is still set on their browsers and the Opt Out was not submitted during their previous visits.

    IRM_showFormForUnsubmittedDSR.png
  • isFinancialParticipant (Boolean - Optional)
    Default value is false. Set this to true if the consumer visiting your website is participating in a financial incentive program. When this is true, the GPC banner shows specific content for Financial Participants.

    IRM_isFinancialParticipant.png

  • showFormOnDisabledSecondVisit (Boolean - Optional)
    Default value is false. This flag decides if an Opt-in form is to be shown when GPC was ON in the previous visit but is OFF in the subsequent visit. The form shown is the same form as the Opt-Out form. Hence, if this flag is turned ON, the intake form must support both Opt-Out and Opt-in DSRs.

    IRM_showFormOnDisabledSecondVisit.png