Set up a Custom Segment

1 Overview
2 Step 1 – Partner Completes Custom Segment Request Form
3 Step 2 – Verity Support activates the Custom Segment
4 Step 3 – Verity applies Custom Segment logic
5 Step 4 – Segments analysis is included in Verity Response
6 Deactivate a Custom Segment

Overview

Verity enables partners to define their own custom segments to fine-tune their contextual targeting. For example, if a partner defines a Custom Segment named Campfire-Equipment and the content for an article named “Campfire Cooking in the Wild” matches the criteria, the JSON analysis response for the page lists Campfire-Equipment in the segments field.

To define a custom segment, the partner submits a Custom Segment Request form to Verity Support, specifying:

A Custom Segment Name.
Categories and Keywords to include or exclude in the segment definition.
Date to start running the analysis.

Verity Support will notify the partner that the custom segment is active. The additional segments field will be included in each Verity JSON response. The segment field will list the names of any custom segments matching the analyzed content. The Custom Segment analysis:

Is set up per partner API authentication key (specified by the x-api-key in the HTTP header of the analysis request).
Applies to all requests from the same partner API authentication key.
Continues until the partner emails Verity Support to deactivate the custom segment.
Ignores any categories where a value is not specified in the Custom Segment Request form.

Step 1 – Partner Completes Custom Segment Request Form

To set up a Custom Segment, we recommend that you email verity-support@gumgum.com to notify them about your upcoming Custom Segment. Complete the Custom Segment Request form and click Submit, including the following information:

Required Field	Description
Company	Enter the name of your company
Name	Enter your own full name
Email address	Enter your email address
Custom Segment Name	Enter a unique name for the custom segment. Maximum of 50 alphanumeric characters. No special characters. Underscores and dashes are accepted.
Publish Segment Date	Enter the date to activate the custom segment in the format mm/dd/yyyy.

Optional Field	Description
IAB v2 Categories	Enter a comma-separated list of the category numbers to include and/or exclude. Refer to the Verity Taxonomy for a complete IAB v2 category list. For example: “Include 196, 498. Exclude 193, 476.”
Keywords	Enter a comma-separated list of the category numbers to include. Maximum 20 keywords.
Threat Categories	To totally block any risk in a particular category, click the category Block button. To tailor the risk levels acceptable for each category, click the appropriate Allow Risk button.
Sentiment	To include a dominant sentiment level, check the box for Positive, Neutral, Negative

Example Custom Segment Request Form

Step 2 – Verity Support activates the Custom Segment

The Verity Support team activates the Custom Segment and notifies the partner.

Step 3 – Verity applies Custom Segment logic

Verity evaluates any values specified in the Custom Segment Request form for IAB v2, Threat, Keywords, and Sentiments against the Verity content analysis results, as follows:

For each Category/Keywords field on the Custom Segments form
IF values are specified AND
At least ONE item is found from the include list AND
NO items are found from the exclude list
THEN the Category/Keyword match is positive
If ALL the specified Category/Keywords fields are a positive match
THEN the content is part of the Custom Segment

For example, if a segment is defined as follows:

Custom Segment Name: Positive BLM Coverage

Custom Segment Name: Positive BLM Coverage
IAB v2 Categories	Include	510, 512
IAB v2 Categories	Exclude	509
Threat Categories	Allow Low	GGT1 Violence/Gore
	Allow Medium	GGT3 Drugs/Alcohol Criminal
	Block	GGT4 Sexually Charged

Content is considered to be positive for the segment when the Verity analysis results match the following:

IAB v2 Classification
Has 512 OR 510 AND
Does NOT have 509

AND

Threat Classification
Has GGT1 Low OR GGT3 Medium AND
Does NOT have GGT4

Note: If no values are specified for a category in the Custom Segment Request form, the category is ignored by segment matching.

Step 4 – Segments analysis is included in Verity Response

When the partner runs Verity requests, the segment field will be included in the Verity responses. If the results for analyzed content match a Custom Segment definition, the segment name will be listed.

For example, if a Custom Segment named Campfire-Equipment is defined and the content for an article named “Campfire Cooking in the Wild” matches the criteria, the Verity JSON response for the article lists Campfire-Equipment in the segments field:

“segments”: [
   {
    “id”: “cec034e2-6fb5-416e-b3b5-6cbb7cbc6e31”,
    “name”: “Campfire-Equipment”
   }
]

Deactivate a Custom Segment

To deactivate a Custom Segment, the partner emails verity-support@gumgum.com specifying:

The partner name.
The Custom Segment name.
The date to deactivate the Custom Segment analysis.

Verity Support emails the partner to confirm that the Custom Segment has been deactivated.