Skip to content

Commit ef1c3c2

Browse files
authored
IntentIq ID: Documentation for sourceMetaData and sourceMetaDataExternal (#5)
* Fix table * AGT-453: Documentation for sourceMetaData
1 parent a1b6342 commit ef1c3c2

2 files changed

Lines changed: 6 additions & 1 deletion

File tree

dev-docs/analytics/intentiq.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ adType: 'banner' // Specifies the type of ad served
8484
}
8585
```
8686

87+
{: .table .table-bordered .table-striped }
8788
| Field | Data Type | Description | Example | Mandatory |
8889
|--------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|-----------|
8990
| biddingPlatformId | Integer | Specify the platform in which this ad impression was rendered – 1 – Prebid, 2 – Amazon, 3 – Google, 4 – Open RTB (including your local Prebid server) | 1 | Yes |

dev-docs/modules/userid-submodules/intentiq.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ Please find below list of parameters that could be used in configuring Intent IQ
4949
| params.gamObjectReference | Optional | Object | This is a reference to the Google Ad Manager (GAM) object, which will be used to set targeting. If this parameter is not provided, the group reporting will not be configured. | `googletag` |
5050
| params.gamParameterName | Optional | String | The name of the targeting parameter that will be used to pass the group. If not specified, the default value is `intent_iq_group`. | `"intent_iq_group"` |
5151
| params.adUnitConfig | Optional | Number | Determines how the `placementId` parameter is extracted in the report (default is 1). Possible values: 1 – adUnitCode first, 2 – placementId first, 3 – only adUnitCode, 4 – only placementId | `1` |
52+
| params.sourceMetaData | Optional | String | This metadata can be provided by the partner and will be included in the requests URL as a query parameter | `"123.123.123.123"` |
53+
| params.sourceMetaDataExternal | Optional | Number | This metadata can be provided by the partner and will be included in the requests URL as a query parameter | `123456` |
5254

5355
### Configuration example
5456

@@ -66,7 +68,9 @@ pbjs.setConfig({
6668
domainName: "currentDomain.com",
6769
gamObjectReference: googletag,
6870
gamParameterName: "intent_iq_group",
69-
adUnitConfig: 1 // Extracting placementId strategy (adUnitCode or placementId order of priorities)
71+
adUnitConfig: 1, // Extracting placementId strategy (adUnitCode or placementId order of priorities)
72+
sourceMetaData: "123.123.123.123", // Optional parameter
73+
sourceMetaDataExternal: 123456, // Optional parameter
7074
},
7175
storage: {
7276
type: "html5",

0 commit comments

Comments
 (0)