Overview
The Vendor Contextual Segment API V4 enables vendors to create custom contextual segments. Once created, publishers can apply contextual segments to video assets with the Contextual Segments API. This API is stand-alone; publishers can grant access to vendors without having to grant access to other APIs.
With this API, vendors can:
- List custom contextual segments for a vendor or specific network
- Create, update, and delete custom contextual segments for a vendor or specific network
- Assign child segments to parent segments (e.g. assigning the segment Movies as a child segment of the parent segment Entertainment)
Uniform Resource Identifiers (URI)
| Environment | URI |
|---|---|
| Production | https://api.freewheel.tv/services/v4/vendors/{vendor_id}/contextual_segments |
| Staging | https://api.stg.freewheel.tv/services/v4/vendors/{vendor_id}/contextual_segments |
Attributes
The following attributes are used when creating a contextual segment. For an interactive example, see Create contextual segments.
Query Attributes
| Name | Type | Description |
|---|---|---|
| network_id | integer | The ID of the publisher that can use the segment. If this parameter is provided, the segment will only be visible to the specified publisher. If this parameter is not provided, the segment will be a shared segments that is visible to all publishers. |
Body Attributes
| Name | Type | Description |
|---|---|---|
| name | string | Name of the contextual segment |
| description | string | Description of the contextual segment |
| external_id | string | External ID of the contextual segment. The external ID must be unique for the vendor, or segment creation will fail |
| parent_id | integer | The FreeWheel ID of an existing segment to assign as a parent segment. The parent segment must already exist in this vendor |