New module: optable-targeting

extra/bundle/pom.xml

@@ -55,6 +55,11 @@
             <artifactId>pb-request-correction</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.prebid.server.hooks.modules</groupId>
+            <artifactId>optable-targeting</artifactId>
+            <version>${project.version}</version>
+        </dependency>
     </dependencies>
 
     <build>

extra/modules/optable-targeting/README.md

@@ -0,0 +1,284 @@
+## Overview
+Optable module operates using a DCN backend API. Please contact your account manager to get started.
+
+The optable-targeting module enriches an incoming OpenRTB request by adding to the `user.eids` and `user.data`
+objects. Under the hood the module extracts PPIDs (publisher provided IDs) from the incoming request's `user.ext.eids`,
+and also if present sha256-hashed email, sha256-hashed phone, zip or Optable Visitor ID provided correspondingly in the
+`user.ext.optable.email`, `.phone`, `.zip`, `.vid` fields (a full list of IDs is given in a table below). These IDs are
+sent as input to the Targeting API. The received response data is used to enrich the OpenRTB request and response.
+Targeting API endpoint is configurable per publisher.
+
+## Setup
+
+### Execution Plan
+
+This module runs at two stages:
+
+* Processed Auction Request: to enrich `user.eids` and `user.data`.
+* Auction Response: to inject ad server targeting.
+
+We recommend defining the execution plan in the account config so the module is only invoked for specific accounts. See
+below for an example.
+
+### Global Config
+
+There is no host-company level config for this module.
+
+### Account-Level Config
+
+To start using current module in PBS-Java you have to enable module and add
+`optable-targeting-processed-auction-request-hook` and `optable-targeting-auction-response-hook` into hooks execution
+plan inside your config file:
+Here's a general template for the account config used in PBS-Java:
+
+```yaml
+hooks:
+  optable-targeting:
+    enabled: true
+  host-execution-plan: >
+    {
+      "endpoints": {
+        "/openrtb2/auction": {
+          "stages": {
+            "processed-auction-request": {
+              "groups": [
+                {
+                  "timeout": 100,
+                  "hook-sequence": [
+                    {
+                      "module-code": "optable-targeting",
+                      "hook-impl-code": "optable-targeting-processed-auction-request-hook"
+                    }
+                  ]
+                }
+              ]
+            },
+            "auction-response": {
+              "groups": [
+                {
+                  "timeout": 10,
+                  "hook-sequence": [
+                    {
+                      "module-code": "optable-targeting",
+                      "hook-impl-code": "optable-targeting-auction-response-hook"
+                    }
+                  ]
+                }
+              ]
+            }
+          }
+        }
+      }
+    }
+```
+
+Sample module enablement configuration in JSON and YAML formats:
+
+```json
+{
+  "modules":
+  {
+    "optable-targeting":
+    {
+      "api-endpoint": "endpoint",
+      "api-key": "key",
+      "timeout": 50,
+      "ppid-mapping": {
+        "pubcid.org": "c"
+      },
+      "adserver-targeting": false
+    }
+  }
+}
+```
+
+```yaml
+  modules:
+    optable-targeting:
+      api-endpoint: endpoint
+      api-key: key
+      timeout: 50
+      ppid-mapping: {
+        "pubcid.org": "c"
+      }
+      adserver-targeting: false
+```
+
+### Timeout considerations
+
+The timeout value specified in the execution plan for the `processed-auction-request` hook is very important to be
+picked such that the hook has enough time to make a roundtrip to Optable Targeting Edge API over HTTP.
+
+**Note:** Do not confuse hook timeout value with the module timeout parameter which is optional. The hook timeout value
+would depend on the cloud/region where the PBS instance is hosted and the latency to reach the Optable's servers. This
+will need to be verified experimentally upon deployment.
+
+The timeout value for the `auction-response` can be set to 10 ms - usually it will be sub-millisecond time as there are
+no HTTP calls made in this hook - Optable-specific keywords are cached on the `processed-auction-request` stage and
+retrieved from the module invocation context later.
+
+## Module Configuration Parameters for PBS-Java
+
+The parameter names are specified with full path using dot-notation. F.e. `section-name` .`sub-section` .`param-name`
+would result in this nesting in the JSON configuration:
+
+```json
+{
+  "section-name": {
+    "sub-section": {
+      "param-name": "param-value"
+    }
+  }
+}
+```
+
+
+| Param Name         | Required | Type    | Default  value | Description                                                                                                                                                                                                                                                                                                                                                                                                                |
+|:-------------------|:---------|:--------|:---------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| api-endpoint       | yes      | string  | none           | Optable Targeting Edge API endpoint URL, required                                                                                                                                                                                                                                                                                                                                                                          |
+| api-key            | no       | string  | none           | If the API is protected with a key - this param needs to be specified to be sent in the auth header                                                                                                                                                                                                                                                                                                                        |
+| ppid-mapping       | no       | map     | none           | This specifies PPID source (`user.ext.eids[].source`) to a custom identifier prefix mapping, f.e. `{"example.com" : "c"}`. See the section on ID Mapping below for more detail.                                                                                                                                                                                                                                            |
+| adserver-targeting | no       | boolean | false          | If set to true - will add the Optable-specific adserver targeting keywords into the PBS response for every `seatbid[].bid[].ext.prebid.targeting`                                                                                                                                                                                                                                                                          |
+| timeout            | no       | integer | false          | A soft timeout (in ms) sent as a hint to the Targeting API endpoint to  limit the request times to Optable's external tokenizer services                                                                                                                                                                                                                                                                                   |
+| id-prefix-order    | no       | string  | none           | An optional string of comma separated id prefixes that prioritizes and specifies the order in which ids are provided to Targeting API in a query string. F.e. "c,c1,id5" will guarantee that Targeting API will see id=c:...,c1:...,id5:... if these ids are provided.  id-prefixes not mentioned in this list will be added in arbitrary order after the priority prefix ids. This affects Targeting API processing logic |
+
+## ID Mapping
+
+Internally the module sends requests to Optable Targeting API. The output of Targeting API is used to enrich the request
+and response. The below table describes the parameters that the module automatically fetches from OpenRTB request and
+then sends to the Targeting API. The module will use a prefix as specified in the table to prepend the corresponding ID
+value when sending it to the Targeting API in the form `id=prefix:value`.
+
+See [Optable documentation](https://docs.optable.co/optable-documentation/dmp/reference/identifier-types#type-prefixes)
+on identifier types. Targeting API accepts multiple id parameters - and their order may affect the results, thus
+`id-prefix-order` specifies the order of the ids.
+
+
+| Identifier Type                                                                | OpenRTB field                                                         | ID Type Prefix                           |
+|--------------------------------------------------------------------------------|-----------------------------------------------------------------------|------------------------------------------|
+| Email Address                                                                  | `user.ext.optable.email`                                              | `e:`                                     |
+| Phone Number                                                                   | `user.ext.optable.phone`                                              | `p:`                                     |
+| Postal Code                                                                    | `user.ext.optable.zip`                                                | `z:`                                     |
+| IPv4 Address                                                                   | `device.ip`                                                           | ~~i4:~~ Sent as `X-Forwarded-For` header |
+| IPv6 Address                                                                   | `device.ipv6`                                                         | ~~i6:~~ Sent as `X-Forwarded-For` header |
+| Apple IDFA                                                                     | `device.ifa if lcase(device.os) contains 'ios' and device.lmt!=1`     | `a:`                                     |
+| Google GAID                                                                    | `device.ifa if lcase(device.os) contains 'android' and device.lmt!=1` | `g:`                                     |
+| Roku RIDA                                                                      | `device.ifa if lcase(device.os) contains 'roku' and device.lmt!=1`    | `r:`                                     |
+| Samsung TV TIFA                                                                | `device.ifa if lcase(device.os) contains 'tizen' and device.lmt!=1`   | `s:`                                     |
+| Amazon Fire AFAI                                                               | `device.ifa if lcase(device.os) contains 'fire' and device.lmt!=1`    | `f:`                                     |
+| [NetID](https://docs.prebid.org/dev-docs/modules/userid-submodules/netid.html) | `user.ext.eids[].uids[0] when user.ext.eids[].source="netid.de"`      | `n:`                                     |
+| [ID5](https://docs.prebid.org/dev-docs/modules/userid-submodules/id5.html)     | `user.ext.eids[].uids[0] when user.ext.eids[].source="id5-sync.com"`  | `id5:`                                   |
+| [Utiq](https://docs.prebid.org/dev-docs/modules/userid-submodules/utiq.html)   | `user.ext.eids[].uids[0] when user.ext.eids[].source="utiq.com"`      | `utiq:`                                  |
+| Optable VID                                                                    | `user.ext.optable.vid`                                                | `v:`                                     |
+
+### Optable input erasure
+
+**Note**: `user.ext.optable.email`, `.phone`, `.zip`, `.vid` fields will be removed by the module from the original
+OpenRTB request before being sent to bidders.
+
+### Publisher Provided IDs (PPID) Mapping
+
+Custom user IDs are sent in the OpenRTB request in the
+[`user.ext.eids[]`](https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#3227---object-eid-).
+The `ppid-mapping` allows to specify the mapping of a source to one of the custom identifier type prefixes `c`-`c19` -
+see [documentation](https://docs.optable.co/optable-documentation/dmp/reference/identifier-types#type-prefixes), f.e.:
+
+```yaml
+ppid-mapping: {"example.com": "c2", "test.com": "c3"}
+```
+
+It is also possible to override any of the automatically retrieved `user.ext.eids[]` mentioned in the table above (s.a.
+id5, utiq) so they are mapped to a different prefix. f.e. `id5-sync.com` can be mapped to a prefix other than `id5:`,
+like:
+
+```yaml
+ppid-mapping: {"id5-sync.com": "c1"}
+```
+
+This will lead to id5 ID supplied as `id=c1:...` to the Targeting API.
+
+## Analytics Tags
+
+The following 2 analytics tags are written by the module:
+
+* `optable-enrich-request`
+* `optable-enrich-response`
+
+The `status` is either `success` or `failure`.  Where it is `failure` a `results[0].value.reason` is provided.  
+For the `optable-enrich-request` activity the `execution-time` value is logged.
+Example:
+
+```json
+{
+  "analytics": {
+    "tags": [
+      {
+        "stage": "auction-response",
+        "module": "optable-targeting",
+        "analyticstags": {
+          "activities": [
+            {
+              "name": "optable-enrich-request",
+              "status": "success",
+              "results": [
+                {
+                  "values": {
+                    "execution-time": 33
+                  }
+                }
+              ]
+            },
+            {
+              "name": "optable-enrich-response",
+              "status": "success",
+              "results": [
+                {
+                  "values": {
+                    "reason": "none"
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      }
+    ]
+  }
+}
+```
+
+If `adserver-targeting` was set to `false` in the config `optable-enrich-response` analytics tag is not written.
+
+## Running the demo (PBS-Java)
+
+1. Build the server bundle JAR as described in [Build Project](https://github.com/prebid/prebid-server-java/blob/master/docs/build.md#build-project), e.g.
+
+```bash
+mvn clean package --file extra/pom.xml
+```
+
+2. In the `sample/configs/prebid-config-optable.yaml` file specify the `api-endpoint` URL of your DCN, f.e.:
+
+```yaml
+api-endpoint: https://example.com/v2/targeting
+```
+
+3. Start server bundle JAR as described in [Running project](https://github.com/prebid/prebid-server-java/blob/master/docs/run.md#running-project), e.g.
+
+```bash
+java -jar target/prebid-server-bundle.jar --spring.config.additional-location=sample/configs/prebid-config-with-optable.yaml
+```
+
+4. Run sample request against the server as described in [the sample directory](https://github.com/prebid/prebid-server-java/tree/master/sample), e.g.
+
+```bash
+curl http://localhost:8080/openrtb2/auction --data @extra/modules/optable-targeting/sample-requests/data.json
+```
+
+5. Observe the `user.eids` and `user.data` objects enriched.
+
+## Maintainer contacts
+
+Any suggestions or questions can be directed to [prebid@optable.co](mailto:prebid@optable.co).
+
+Alternatively please open a new [issue](https://github.com/prebid/prebid-server-java/issues/new) or [pull request](https://github.com/prebid/prebid-server-java/pulls) in this repository.

extra/modules/optable-targeting/lombok.config

@@ -0,0 +1 @@
+lombok.anyConstructor.addConstructorProperties = true

extra/modules/optable-targeting/pom.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.prebid.server.hooks.modules</groupId>
+        <artifactId>all-modules</artifactId>
+        <version>3.28.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>optable-targeting</artifactId>
+
+    <name>optable-targeting</name>
+    <description>Optable targeting module</description>
+</project>