Set Endpoint

This function sets the Impression Bus endpoint to which ad requests are made.

setEndpoint('endpoint', true|false)

Important

If you plan to use the setEndpoint function to ensure the use of the simple domain, it's advisable to concurrently deactivate the AST userSync feature within the setPageOpts. This action will ensure that the userSync script remains disabled throughout the auction process, aligning with your preference to maintain cookie integrity regardless of the user's consent choices.

The parameter listed below can be sent as an argument in the function.

Parameter	Type	Description
endpoint	string	Specifies a URL endpoint.
freezeIbUrl	Boolean	An optional setting. Default is false. When set to true, AST will not attempt to switch the Impression Bus domain to normal or simple domain as per consent information present in the auction. When set to false, AST will switch to normal or simple domain as appropriate. Note: See Set Up Placements with AST for more details about the simple domain and when it should be used.

Example

apntag.setEndpoint('ib.adnxs-simple.com', true);

Note

Users who want to test the AST tag against non-production data can use the example above to point to our testing environment.