Skip to content

Commit

Permalink
add provider as an option in id5 config params to identity prebid ide…
Browse files Browse the repository at this point in the history
…ntity wrappers (#5983)
  • Loading branch information
smenzer authored Nov 18, 2020
1 parent da87e57 commit c308898
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions modules/id5IdSystem.js
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ export const id5IdSubmodule = {
'nbPage': incrementNb(config.params.partner),
'o': 'pbjs',
'pd': config.params.pd || '',
'provider': config.params.provider || '',
'rf': referer.referer,
's': signature,
'top': referer.reachedTop ? 1 : 0,
Expand Down
3 changes: 2 additions & 1 deletion modules/id5IdSystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,11 @@ pbjs.setConfig({
| params | Required | Object | Details for the ID5 Universal ID. | |
| params.partner | Required | Number | This is the ID5 Partner Number obtained from registering with ID5. | `173` |
| params.pd | Optional | String | Publisher-supplied data used for linking ID5 IDs across domains. See [our documentation](https://wiki.id5.io/x/BIAZ) for details on generating the string. Omit the parameter or leave as an empty string if no data to supply | `"MT1iNTBjY..."` |
| params.provider | Optional | String | An identifier provided by ID5 to technology partners who manage Prebid setups on behalf of publishers. Reach out to [ID5](mailto:prebid@id5.io) if you have questions about this parameter | `pubmatic-identity-hub` |
| storage | Required | Object | Storage settings for how the User ID module will cache the ID5 ID locally | |
| storage.type | Required | String | This is where the results of the user ID will be stored. ID5 **requires** `"html5"`. | `"html5"` |
| storage.name | Required | String | The name of the local storage where the user ID will be stored. ID5 **requires** `"id5id"`. | `"id5id"` |
| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. ID5 recommends `90`. | `90` |
| storage.refreshInSeconds | Optional | Integer | How many seconds until the ID5 ID will be refreshed. ID5 strongly recommends 8 hours between refreshes | `8*3600` |

**ATTENTION:** As of Prebid.js v4.14.0, ID5 requires `storage.type` to be `"html5"` and `storage.name` to be `"id5id"`. Using other values will display a warning today, but in an upcoming release, it will prevent the ID5 module from loading. This change is to ensure the ID5 module in Prebid.js interoperates properly with the [ID5 API](https://github.com/id5io/id5-api.js) and to reduce the size of publishers' first-party cookies that are sent to their web servers. If you have any questions, please reach out to us at [prebid@id5.io](mailto:prebid@id5.io).
**ATTENTION:** As of Prebid.js v4.14.0, ID5 requires `storage.type` to be `"html5"` and `storage.name` to be `"id5id"`. Using other values will display a warning today, but in an upcoming release, it will prevent the ID5 module from loading. This change is to ensure the ID5 module in Prebid.js interoperates properly with the [ID5 API](https://github.com/id5io/id5-api.js) and to reduce the size of publishers' first-party cookies that are sent to their web servers. If you have any questions, please reach out to us at [prebid@id5.io](mailto:prebid@id5.io).
1 change: 1 addition & 0 deletions test/spec/modules/id5IdSystem_spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ describe('ID5 ID System', function() {
expect(requestBody.o).to.eq('pbjs');
expect(requestBody.pd).to.eq('');
expect(requestBody.s).to.eq('');
expect(requestBody.provider).to.eq('');
expect(requestBody.v).to.eq('$prebid.version$');

request.respond(200, responseHeader, JSON.stringify(ID5_JSON_RESPONSE));
Expand Down

0 comments on commit c308898

Please sign in to comment.