Skip to content

Commit

Permalink
add documentation for auctionDelay in userSync (#1459)
Browse files Browse the repository at this point in the history
* add documentation for auctionDelay in userSync

* rephrase language

* add details to reference

* remove auction delay from sandbox

* remove spacing changes to sandbox

* remove spacing changes to sandbox

* remove spacing changes to sandbox
  • Loading branch information
mutdmour authored and bretg committed Oct 9, 2019
1 parent c5f2cc0 commit e5f7788
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions dev-docs/publisher-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1717,6 +1717,7 @@ For descriptions of all the properties that control user syncs, see the table be
| `filterSettings` | Object | Configure lists of adapters to include or exclude their user syncing based on the pixel type (image/iframe). |
| `syncsPerBidder` | Integer | Number of registered syncs allowed per adapter. Default: `5`. To allow all, set to `0`. |
| `syncDelay` | Integer | Delay in milliseconds for syncing after the auction ends. Default: `3000`. |
| `auctionDelay` | Integer | Delay in milliseconds of the auction to sync user ids before auction. Continues auction once ids are synced or delay times out. Default: `0`. |
| `enableOverride` | Boolean | Enable/disable publisher to trigger user syncs by calling `pbjs.triggerUserSyncs()`. Default: `false`. |

<a name="setConfig-ConfigureUserSyncing-UserSyncExamples" />
Expand Down Expand Up @@ -1745,6 +1746,16 @@ pbjs.setConfig({
});
{% endhighlight %}

Delay auction to sync user ids first:

{% highlight js %}
pbjs.setConfig({
userSync: {
auctionDelay: 1000
}
});
{% endhighlight %}

Allow iframe-based syncs (the presence of a valid `filterSettings.iframe` object automatically enables iframe type user-syncing):

{% highlight js %}
Expand Down

0 comments on commit e5f7788

Please sign in to comment.