Skip to content

IntentIq ID: Documentation for sourceMetaData and sourceMetaDataExternal #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DimaIntentIQ merged 2 commits into from
Mar 27, 2025
Merged

IntentIq ID: Documentation for sourceMetaData and sourceMetaDataExternal #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33eb513
Fix table
dmytro-po Mar 27, 2025
212f91e
AGT-453: Documentation for sourceMetaData
dmytro-po Mar 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions dev-docs/analytics/intentiq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ adType: 'banner' // Specifies the type of ad served
}
```

{: .table .table-bordered .table-striped }
| Field | Data Type | Description | Example | Mandatory |
|--------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|-----------|
| 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 |
Expand Down
6 changes: 5 additions & 1 deletion dev-docs/modules/userid-submodules/intentiq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ Please find below list of parameters that could be used in configuring Intent IQ
| 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` |
| 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"` |
| 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` |
| 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"` |
| 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` |

### Configuration example

Expand All @@ -66,7 +68,9 @@ pbjs.setConfig({
domainName: "currentDomain.com",
gamObjectReference: googletag,
gamParameterName: "intent_iq_group",
adUnitConfig: 1 // Extracting placementId strategy (adUnitCode or placementId order of priorities)
adUnitConfig: 1, // Extracting placementId strategy (adUnitCode or placementId order of priorities)
sourceMetaData: "123.123.123.123", // Optional parameter
sourceMetaDataExternal: 123456, // Optional parameter
},
storage: {
type: "html5",
Expand Down
Loading