update docs to clarify usage of auctionDelay

[smenzer]

The docs are not clear about what auctionDelay and syncDelay are used for. Based on asking @jaiminpanchal27, auctionDelay is only for userId module providers, while syncDelay is used for both userId module providers and bid adapter user sync pixels.

[bretg]

Question: if auctionDelay > 0, does syncDelay make sense?

i.e. if auctionDelay=500 and syncDelay is 3000, have we just wasted 500ms? Looked at the code and it seems like this might be the case.

If so, we want to make sure that no examples are shown doing this.

[smenzer]

@bretg since syncDelay only applies to bid adapter usersyncs, we should support the case where auctionDelay > 0 and syncDelay is set, right? In that case, userId modules would fire pre-auction, and bid adapters would fire post...?

[bretg]

The documentation says that syncDelay is Delay in milliseconds for user syncing (both bid adapter user sync pixels and userId module ID providers)

So it appears that syncDelay is not just for bid adapter usersyncs?

[smenzer]

right...syncDelay works for both, but auctionDelay ONLY works for userId module. That's not clear in the docs which is what I was attempting to clarify with my change

[idettman]

The documentation says that syncDelay is Delay in milliseconds for user syncing (both bid adapter user sync pixels and userId module ID providers)

So it appears that syncDelay is not just for bid adapter usersyncs?

Yes that appears to be correct

[bretg]

so back to my original question

if auctionDelay > 0, does syncDelay make sense?

i.e. if auctionDelay=500 and syncDelay is 3000, have we just wasted 500ms? This seems like something we need to prevent. i.e. when auctionDelay > 0 syncDelay is ignored for userIds.

[smenzer]

when auctionDelay > 0 syncDelay is ignored for userIds

i agree with this for userId module. obviously bid adapters should still sync post auction like normal using the auctionDelay

[bretg]

@idettman - is this the way it actually works? i.e. is syncDelay ignored when auctionDelay is > 0?

[idettman]

Yes syncDelay is ignored in the User ID module if auctionDelay is > 0

[bretg]

Thanks Scott and Isaac. I added a note. Merging.

[patmmccann]

@bretg I think the doc might be wrong here; @idettman said "Yes syncDelay is ignored in the User ID module if auctionDelay is > 0" but users are reading this as bidder adapters ignore syncDelay too. specifically https://redditadops.slack.com/archives/C0HVALS8P/p1615281622031800

tagging @smenzer also as the question is about your integration

[smenzer]

yea, seems like the "Ignored if auctionDelay > 0" part should clarify that the ignoring only applies to user id modules.