From 6d9e59f156244e860d05d115cf82b1a4f07dd5f9 Mon Sep 17 00:00:00 2001 From: southern-growthcode Date: Mon, 29 Jan 2024 16:44:32 -0500 Subject: [PATCH 1/2] GC-179 Update prebid docs to reflect growthCodeIdSystem updates --- .../modules/userid-submodules/growthcode.md | 47 ++++++++++++++----- 1 file changed, 36 insertions(+), 11 deletions(-) diff --git a/dev-docs/modules/userid-submodules/growthcode.md b/dev-docs/modules/userid-submodules/growthcode.md index 3aec075d33..01d1b22c0e 100644 --- a/dev-docs/modules/userid-submodules/growthcode.md +++ b/dev-docs/modules/userid-submodules/growthcode.md @@ -26,9 +26,7 @@ pbjs.setConfig({ 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', } }] } @@ -38,11 +36,38 @@ pbjs.setConfig({ 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 +[ + { + "source":"domain.com", + "uids":[ + { + "id":"8212212191539393121", + "ext":{ + "stype":"ppuid" + } + } + ] + }, + { + "source":"example.com", + "uids":[ + { + "id":"e06e9e5a-273c-46f8-aace-6f62cf13ea71", + "ext":{ + "stype":"ppuid" + } + } + ] + } +] +``` + From e1f3601316c11d9c076d4a3df03f2bfb4876b5a6 Mon Sep 17 00:00:00 2001 From: southern-growthcode Date: Sun, 4 Feb 2024 10:06:55 -0500 Subject: [PATCH 2/2] Fixed Lint Issues --- dev-docs/modules/userid-submodules/growthcode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/modules/userid-submodules/growthcode.md b/dev-docs/modules/userid-submodules/growthcode.md index 01d1b22c0e..8add06f7cf 100644 --- a/dev-docs/modules/userid-submodules/growthcode.md +++ b/dev-docs/modules/userid-submodules/growthcode.md @@ -44,6 +44,7 @@ The following configuration parameters are available: ### Sample Eids Below is an example of the EIDs stored in Local Store (customerEids) + ```json [ { @@ -70,4 +71,3 @@ Below is an example of the EIDs stored in Local Store (customerEids) } ] ``` -