Skip to content
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

Updating x1 API documentation in akamaiDAPIdSystem #3088

Merged
merged 2 commits into from
Jul 8, 2021
Merged

Updating x1 API documentation in akamaiDAPIdSystem #3088

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33b178c
Updating x1 API documentation in akamaiDAPIdSystem
amishra11j Jul 4, 2021
ff0b636
Update userId.md
jeanstemp Jul 8, 2021
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
9 changes: 7 additions & 2 deletions dev-docs/modules/userId.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ In this system, no end-user identifier is supplied to the bid-stream, only cohor
First, make sure to add the DAP submodule to your Prebid.js package with:

```
gulp build --modules=akamaiDAPId,userId
gulp build --modules=akamaiDAPIdSystem,userId
```

The following configuration parameters are available:
Expand All @@ -553,13 +553,18 @@ pbjs.setConfig({
apiHostname: '<see your Akamai account rep>',
domain: 'your-domain.com',
type: 'email' | 'mobile' | ... | 'dap-signature:1.0.0',
identity: ‘[email protected]’ | ‘6175551234' | ...
identity: ‘[email protected]’ | ‘6175551234' | ...,
apiVersion: 'v1' | 'x1',
attributes: '{ "cohorts": [ "3:14400", "5:14400", "7:0" ],"first_name": "...","last_name": "..." }'
},
}],
auctionDelay: 50 // 50ms maximum auction delay, applies to all userId modules
}
});
```
In order to make use of v1 APIs, "apiVersion" needs to explicitly mention 'v1'. The "apiVersion" defaults to x1 if not specified.
"attributes" can be configured in x1 API only and not v1 APIs. Please ensure that the "attributes" value is in same format as shown above.

Contact [email protected](Akamai account rep) for apiHostname.


Expand Down