diff --git a/dev-docs/publisher-api-reference/getAdserverTargetingForAdUnitCodeStr.md b/dev-docs/publisher-api-reference/getAdserverTargetingForAdUnitCodeStr.md new file mode 100644 index 0000000000..bd4fe3627a --- /dev/null +++ b/dev-docs/publisher-api-reference/getAdserverTargetingForAdUnitCodeStr.md @@ -0,0 +1,27 @@ +--- +layout: api_prebidjs +title: pbjs.getAdserverTargetingForAdUnitCodeStr(adunitCode) +description: getAdserverTargetingForAdUnitCodeStr API +sidebarType: 1 +--- + +Returns the query string targeting parameters available at the moment for the specified ad unit. + +**Kind**: static method of `pbjs`. + +**Returns**: `Array` - list of targeting key-value strings. + +**Request Params:** + +{: .table .table-bordered .table-striped } + +| Param | Type | Description | +| --- | --- | --- | +| `adunitCode` | `string` | adUnitCode to get the bid responses for | + +**Example** + +```javascript +const targetingStrings = pbjs.getAdserverTargetingForAdUnitCodeStr('div-1'); +// ["hb_bidder=appnexus", "hb_adid=233bcbee889d46d", ...] +``` diff --git a/dev-docs/publisher-api-reference/processQueue.md b/dev-docs/publisher-api-reference/processQueue.md new file mode 100644 index 0000000000..28c3968357 --- /dev/null +++ b/dev-docs/publisher-api-reference/processQueue.md @@ -0,0 +1,18 @@ +--- +layout: api_prebidjs +title: pbjs.processQueue() +description: processQueue API +sidebarType: 1 +--- + +Processes commands that were pushed onto `pbjs.cmd` or `pbjs.que` before Prebid.js finished loading. + +**Kind**: static method of `pbjs`. + +Calling this method manually is rarely necessary because Prebid.js runs it automatically when the library loads. + +**Example** + +```javascript +pbjs.processQueue(); +``` diff --git a/dev-docs/publisher-api-reference/registerAnalyticsAdapter.md b/dev-docs/publisher-api-reference/registerAnalyticsAdapter.md new file mode 100644 index 0000000000..884453e986 --- /dev/null +++ b/dev-docs/publisher-api-reference/registerAnalyticsAdapter.md @@ -0,0 +1,28 @@ +--- +layout: api_prebidjs +title: pbjs.registerAnalyticsAdapter(options) +description: registerAnalyticsAdapter API +sidebarType: 1 +--- + +Registers an analytics adapter so it can listen to auction events. + +**Kind**: static method of `pbjs`. + +**Request Params:** + +{: .table .table-bordered .table-striped } + +| Param | Type | Description | +| --- | --- | --- | +| `options` | `object` | Object containing the adapter instance and code | + +**Example** + +```javascript +pbjs.registerAnalyticsAdapter({ + adapter: myAnalyticsAdapter, + code: 'myAnalytics', + gvlid: 1 +}); +``` diff --git a/dev-docs/publisher-api-reference/registerBidAdapter.md b/dev-docs/publisher-api-reference/registerBidAdapter.md new file mode 100644 index 0000000000..0b7e53c1d3 --- /dev/null +++ b/dev-docs/publisher-api-reference/registerBidAdapter.md @@ -0,0 +1,28 @@ +--- +layout: api_prebidjs +title: pbjs.registerBidAdapter(bidderAdapter, bidderCode) +description: registerBidAdapter API +sidebarType: 1 +--- + +Registers a custom bid adapter for use within Prebid.js. + +**Kind**: static method of `pbjs`. + +**Request Params:** + +{: .table .table-bordered .table-striped } + +| Param | Type | Description | +| --- | --- | --- | +| `bidderAdapter` | `function` | Adapter instance that returns a `callBids` function | +| `bidderCode` | `string` | Code that identifies the adapter | + +**Example** + +```javascript +function myAdapter() { + return { callBids: function() { /* ... */ } }; +} +pbjs.registerBidAdapter(myAdapter, 'my'); +``` diff --git a/dev-docs/publisher-api-reference/triggerUserSyncs.md b/dev-docs/publisher-api-reference/triggerUserSyncs.md new file mode 100644 index 0000000000..f70d0f6a29 --- /dev/null +++ b/dev-docs/publisher-api-reference/triggerUserSyncs.md @@ -0,0 +1,16 @@ +--- +layout: api_prebidjs +title: pbjs.triggerUserSyncs() +description: triggerUserSyncs API +sidebarType: 1 +--- + +Manually initiates user syncs when the `userSync.enableOverride` setting is enabled. + +**Kind**: static method of `pbjs`. + +**Example** + +```javascript +pbjs.triggerUserSyncs(); +```