Set page options

This function sets page-level options placements.

setPageOpts ({parameters})

The parameters listed below can be sent as arguments in the function.

Parameters

Objects

App object

Specifies information about the application.

Here's an example:

apntag.setPageOpts({
        app: {
                appid: 'com.mypackage.myapp'
        }
});

DSA object

Specifies information related to the Digital Services Act. For the ideal values to use for each of the fields, refer to the IAB Spec.

Schain object

The feature in AST allows for publishers to perform an optional syntax check on the schain they specify in the config parameter. The syntax criteria is based on the IAB specification for the schain object.

• If the publisher enables the strict option, the config schain object will be checked exactly and if there is an error in the structure, an error message from AST will be thrown in the console and the schain object will not be included in the request to the adserver.
• If the publisher enables the relaxed option, the config schain object will be checked. If is something wrong, a warning message will be displayed in the browser console, but the schain object will still be included in the request to the adserver.
• If the publisher enables the off option, the config schain object will not be checked at all. It will simply be included in the request to the adserver, whether it was correctly formatted or not.

Here's an example:

schain: {
  validation: 'strict',  // strict, relaxed, or off - strict is default
  config: {
    ver: '1.0',
    complete: 0,
    nodes: [{
      asi: 'testasi.com',
      sid: 'test123sid',
      hp: 1
    }]
  }
}

User object

Specifies information about an external user to whom the ads will be shown.

User ID object

Pass universal IDs in Monetize

You can pass a universal ID to Monetize through AST.js using one of two methods: the mapped identifier method (older) or the extendedIDs method (newer).

Mapped identifier method

This method allows you to pass a limited number of Universal IDs. The list of supported IDs is hardcoded in the AST.js code. Use this method when the Universal IDs is among the supported types.

Example JSON

{
  "type": "liveramp",
  "id": "0d7e95c7-4783-4278-acf9-99809d0c5a61"
}

ExtendedIDs method

The extendedIDs method is more flexible and supports all Universal IDs and Publisher Provided Identifiers (PPIDs). Use this method to pass identifiers dynamically.

Example JSON

{
  "type": "extendedIDs",
  "eids": [
    {
      "source": "liveramp.com",
      "id": "2d7e95c7-4783-4278-acf9-99809d0c5a62"
    }
  ]
}

In this example:

• sourceis the domain or provider that manages the Universal ID.
• idis the identifier provided by the source.

The extendedIDs method is recommended for all current and future Universal IDs formats. It offers flexibility for publishers who want to handle various first-party ID solutions.

Choose the right method

• Use the mapped identifier method only if your Universal ID is supported by the legacy AST.js mapping.
• Use the extendedIDs method for broader compatibility and future-proofing.

Device object

Specifies a mobile device on which the ads will be shown.

Content Object

TrackingManagement object

RenderingManagement object

userSync object

Here's an example

apntag.setPageOpts({
    member: 958,
    user: {
        age: 25,
        externalUid: '10',   
                userIds: [{ "type": "criteo", "id": "_fl7bV96WjZsbiUyQnJlQ3g4ckh5a1N", }, // Criteo Identifier
                  { "type": "ttd", "id": "00000111-91b1-49b2-ae37-17a8173dc36f" }, // Trade Desk Identifier
                  { "type": "netid", "id": "999888777" }, // NetID Identifier
                  { "type": "liveramp", "id": "AjfowMv4ZHZQJFM8TpiUnYEyA81Vdgg" }, //Liveramps's Identifier
                  { "type": "uid2", "id": "234123424" }, //UID2's Identifier
                  { "type": "extendedIDs", "eids": [{ "id": "abc123def345", "source": "mySampleDomain.com" }] }, // publisher first party IDs
                ], 
        segments: [1, 2],
        gender: 0,
        dnt: true,
        language: 'EN'
    }
    keywords: {
        genre: ['rock', 'pop']
    },
    disablePsa : true,
    enableSafeFrame : true,
    device : {
        deviceId : {
            idfa : 'String',
            aaid : 'String',
            md5udid : 'String',
            sha1udid : 'String'
        },
        deviceType : 'String',
        useragent : 'String',
        geo : {
            lat : 0.4,
            lng : 0.5,
            country : 'USA',
            region : 'String',
            city : 'String',
            zip : 'String'
        },
        ip : 'String',
        make : 'String',
        model : 'String',
        os : 'String',
        osVersion : 'String',
        carrier : 'String',
        connectionType : 0,
        mcc : 'String',
        mnc : 'String',
        devTime : 12345
    },
    auctionTimeout: 3000,
    pageUrl: 'http://www.samplesite.com/testpage.html',
    trackingManagement: {
     native: {
       loadViewabilityScriptAt: 'impression'
     },
    renderingManagement: {
      insertWrapperDiv: true,
      sandboxAdIframe: true,
      sandboxAttributes: ['allow-same-origin', 'allow-scripts', 'allow-presentation']
      },
     userSync: {
       syncEnabled: true,
       syncDelay: 4000,
       publisherId: 12345,
       sellerId: 123
      }
     }
 });

Geo override object

Use this object to override the auction's geographic information. The supplied country code and zip code will be used to look up all geographic attributes to determine location.

Here's an example

apntag.setPageOpts({      
  ... // other settings
  geoOverride: {
    countryCode: 'US',
    zip: '10000'
  }
})

Consent management object

Use this object to specify whether consent management is enabled for compliance with the transparency, notice and choice/consent requirements under US state privacy laws, GDPR, the ePrivacy Directive and IAB's U.S. Privacy User Signal Mechanism (USP), which currently covers the California Consumers Privacy Act (CCPA). Consent management is enabled by default.

Disabling consent management

Xandr provides the option to disable all consent management or individual ones per the user's needs.

The following describes the functionality of AST in supporting GPP and GDPR compliance when consentManagement is enabled:

• During the Load Tags function call, the AST tag will attempt to fetch the consent data from the IAB-compliant Consent Management Platforms (CMP).
• When it’s time for the AST tag to call ImpBus, the consent information is included in the /ut POST request. Specifically, the consent information is stored under the POST’s data object as:

gdpr_consent : {
    consent_string: 'abc123',
    consent_required: true|false
},
us_privacy: "1YNY"

When the CMP fetch fails or the timeout period expires, the consentManagement code will log a warning message to the browser console, package a consent object in the following manner and include it into the AST request as described.

gdpr_consent : {
    consent_string: undefined,
    consent_required: undefined
},
gpp_sid: [5]

When AST detects TCF 2.0 it will rely on events generated by the CMP. The consent string will be retrieved when any of the following conditions are met:

• The event generated is useractioncomplete or tcloaded.

• The event generated is cmpuishown and purposeOneTreatment flag is set to true in the available TCF string.

• The only event generated is cmpuishown and a time out occurs.

  In TCF v2.0 if the gdprApplies flag is set to true and Purpose One consent is not granted then AST will not include cookies in the /ut POST request.

Global privacy platform

In order to comply with multiple US state privacy laws, Xandr supports the Global Privacy Platform. When AST detects GPP it will rely on events generated by the CMP. The GPP string will be retrieved when any of the following conditions are met:

• The event sectionChange has occurred - This event is called whenever the status or content of a section changes (e.g. consent is obtained).
• The cmpStatus is loaded and the cmpDisplayStatus does not equal visible - This means the CMP code has finished loading (out of the stub phase) and the CMP is not visible to the end-user (which typically means the CMP has prior consent information available).