Retrieve Video Classification by content_id

1 Video Classification Endpoint for content_id
2 Example Video Request
3 More Information

GumGum Contextual™ provides brand safety and contextual classification data for partner video platforms such as IRIS.TV and JW Player.

For the purposes of pre-bid targeting or creating video PMPs, DSPs/SSPs can get classification data for video assets directly from GumGum Contextual™. DSPs/SSPs can use the unique identifier assigned by the publisher (content_id) to identify a video asset, without access to the video URL.

GumGum Contextual™ refers to the unique content identifier for a video as the content_id.

The integration works as follows:

DSP/SSP partners:
- Initiates a classification request to GumGum Contextual™, specifying a content_id (in this case the IRIS ID).
- GumGum Contextual™ checks for the content_id.
- If data is available, GumGum Contextual™ returns the correct video classification to the DSP/SSP.

Important: Contact verity-support@gumgum.com to find out more about enabling the usage of content_id for video classification.

Video Classification Endpoint for content_id

The GumGum Contextual™ video analysis retrieval endpoint is:

GET /video/classification/{content_id}

GumGum Contextual API processes HTTP GET requests for video classification data. The video is identified by a content_id, a unique persistent identifier assigned by a publisher.

Example Video Request

This example walks through retrieving classification data for a video available in the IRIS.TV Contextual Marketplace. The video’s content_id is iris_12345.

Example GET Request

Submit a GET request to /video/classification/{content_id}, for example:

curl -X GET "https://verity-api.gumgum.com/video/classification/iris_12345" -H 'Accept: application/json' -H "x-api-key: <YOUR_API_KEY_HERE>"

Note: The API Key you specify must include support for content_id usage.

Example JSON Response

If video classification data is available, the GumGum Contextual API returns a JSON response with Content-Type: application/json; charset=UTF-8.

The data payload includes the JSON classification results detailing the complete brand safety, keyword, and categorization analysis data for the video. For example:


{
  "uuid": "668e9d0e-a909-5ea0-9017-80c983a8db2c",
  "url": "https://vod-progressive.net/...filename=pexels-karolina-grabowska-5644289.mp4",
  "data": {
    "processedAt": "2021-05-21T16:47:35.352Z",
    "expiresAt": "2022-05-16T16:47:35.352Z",
    "languageCode": "en",
    "iab": {
      "v2": [
        {
          "id": "52",
          "category": "Business and Finance",
          "score": 0.95
        }
      ]
    },
    "keywords": [
      "black friday sale"
    ],
    "safe": true,
    "threats": [],
    "sentiments": [
      {
        "sentiment": "neutral",
        "score": 1
      },
      {
        "sentiment": "negative",
        "score": 0
      },
      {
        "sentiment": "positive",
        "score": 0
      }
    ],
    "segments": [
      {
        "id": "a708990d-c2d2-483d-9a48-3c8f9ec4aa01",
        "name": "test-segment"
      }
    ]
  }
}

See JSON Response for details about the classification data included in the response.

More Information

GET /video/classification/{client_id}

GumGum Contextual Documentation Center

Retrieve Video Classification by content_id

Analytics

Video Classification Endpoint for content_id

Example Video Request

More Information

Related content