Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Overview

Verity enables customers to define their own custom segments to fine-tune their contextual targeting. For example, if you define 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.

...

  • Is set up per client API authentication key (specified by the x-api-key in the HTTP header  of the analysis request).

  • Applies to all requests from the same client API authentication key.

  • Continues until the client 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 – Client Completes Custom Segment Request Form

To set up a Custom Segment, email verity-support@gumgum.com and ask for the link to the Custom Segment Request form. Complete the form and click Submit, including the following information:

...

Example Custom Segment Request Form


Step 2 – Verity Support activates the Custom Segment

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

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:

...

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 client 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. 

...

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

 Deactivate a Custom Segment

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

...