Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Functionality

This function gets the Global Vendor List (GVL) data for a specific GVL version, the currently consented version, or the latest GVL version. It is part of the IAB Europe Transparency and Consent Framework (TCF) Specifications.

Syntax

function __tcfapi()

argument name

type

optional

value

description

command

string

'getVendorList'

version

integer

✔️

null|2

The TCF API version to use. Can be null instead.

callback

function

function(gvl:GlobalVendorList, success:boolean)

The callback function that is called with the function call result.

parameter

integer or string

✔️

vendorListVersion | null | 'LATEST'

The vendor list version ID, null to fetch the consented version or 'LATEST'

Description

Fetch the vendor list to find more information about vendors and purposes. It can be used to map consent information to human readable information.

Scope

The function can be called at any time.

Examples

For usage, see examples from addEventListener.

  • No labels