Verify that the user matching helper is enabled for a Prebid.js integration

The user matching helper significantly boosts your user matching rates without affecting page layout, performance, or reliability. For more information about user data matching, see Improving revenue with user data matching. If you are integrated with Index Exchange (Index) using Prebid.js version 3.13 or later, user matching is built into the adapter and you can configure it in the Prebid Publisher API. For image-based user syncing, make sure that you are using Prebid.js version 7.5.0 or later.

Note: If you are not integrated with Index using Prebid.js version 3.13 or later, you cannot configure it using the Prebid Publisher API and you must add the user matching helper to your site. For more information about how to add it, see Improving revenue with user data matching.

1. Make sure that the syncEnabled parameter in the userSync object is set to True as shown below.

pbjs.setConfig({
	userSync: {
		syncEnabled: true
	}
});

2. Make sure that Index, or all bidders, are eligible to execute the user syncing function in Prebid using the iframe or image object as shown below. For image based syncing, make sure that you are using Prebid.js version 7.5.0 or later.

   Note: For Media Owners who enable both iframe and image based syncing, we will default to using iframe, because it allows us more flexibility to optimize the frequency, timing, and coverage for syncing.
   

                               pbjs.setConfig({
   	userSync: {
   		filterSettings: {
   			iframe: {
   				bidders: ['
                               ix
                               '], 
   				filter: 'include'
   			},
   			image: {
   				bidders: '*',   // '*' indicates that all bidders can sync, also applies to iframe object
   				filter: 'include'
   			}
   		},
   		syncsPerBidder: 3, // no more than 3 syncs at a time
   		syncDelay: 6000 // 6 seconds after the auction
   	}
   });
                           

3. If you are using an alias for the Index Prebid adapter rather than the standard adapter name, you must set the aliasSyncEnabled property to true or the aliased Index adapter will not be able to use the user matching helper. By default, this property is set to false.