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

Jump to bottom

GrowthCode User ID Module: Updated documentation to reflect changes to the user id module #5113

Merged
merged 2 commits into from
Feb 4, 2024
Merged

GrowthCode User ID Module: Updated documentation to reflect changes to the user id module #5113

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d9e59f
GC-179 Update prebid docs to reflect growthCodeIdSystem updates
southern-growthcode Jan 29, 2024
e1f3601
Fixed Lint Issues
southern-growthcode Feb 4, 2024
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
47 changes: 36 additions & 11 deletions dev-docs/modules/userid-submodules/growthcode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@
userIds: [{
name: 'growthCodeId',
params: {
pid: 'TEST01', // Set your Partner ID here for production (obtained from Growthcode)
publisher_id: '_sharedID',
publisher_id_storage: 'html5'
customerEids: 'customerEids',
}
}]
}
Expand All @@ -38,11 +36,38 @@
The following configuration parameters are available:

{: .table .table-bordered .table-striped }
| Param under userSync.userIds[] | Scope | Type | Description | Example |
|--------------------------------|----------|--------| --- |-----------------|
| name | Required | String | The name of this module. | `"growthCodeId"` |
| params | Required | Object | Details of module params. | |
| params.pid | Required | String | This is the Partner ID value obtained from GrowthCode | `"TEST01"` |
| params.url | Optional | String | Custom URL for server | |
| params.publisher_id | Optional | String | Name if the variable that holds your publisher ID | `"_sharedID"` |
| params.publisher_id_storage | Optional | String | Publisher ID storage (cookie, html5) | `"html5"` |
| Param under userSync.userIds[] | Scope | Type | Description | Example |
|--------------------------------|----------|--------|------------------------------------------------------------------------|-----------------|
| name | Required | String | The name of this module. | `"growthCodeId"` |
| params | Required | Object | Details of module params. | |
| params.customerEids | Optional | String | Name of the variable name where the customer EID information is stored | |

### Sample Eids
Below is an example of the EIDs stored in Local Store (customerEids)
```json

Check failure on line 47 in dev-docs/modules/userid-submodules/growthcode.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Fenced code blocks should be surrounded by blank lines 

dev-docs/modules/userid-submodules/growthcode.md:47 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```json"] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md031.md
[
{
"source":"domain.com",
"uids":[
{
"id":"8212212191539393121",
"ext":{
"stype":"ppuid"
}
}
]
},
{
"source":"example.com",
"uids":[
{
"id":"e06e9e5a-273c-46f8-aace-6f62cf13ea71",
"ext":{
"stype":"ppuid"
}
}
]
}
]
```

Loading