POST
/
monetization
/
offers
/
v1

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Offer represents a collection of video content that end users can purchase. This can be used e.g. to define Entitlements against.

localized_description
object
required

A map of localized descriptions for this offer. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

localized_title
object
required

A map of localized titles for this offer. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

name
string
required

Name of the offer. This is an internal identifier and is not exposed to end users.

project_id
string
required
cleeng_offer_id
string
concurrency_limit
string

The amount of devices that can concurrently view the content associated with this offer from a single account. If not provided, there is no limit.

content_end_time
string

Any content defined by entity_ids, event_ids and creative_work_ids before content_end_time will be considered as part of the offer (as long as it is after content_start_time). If not provided, there is no upper time bound on the content.

content_start_time
string

Any content defined by entity_ids, event_ids and creative_work_ids after content_start_time will be considered as part of the offer (as long as it is before content_end_time). If not provided, there is no lower time bound on the content.

creative_work_ids
string[]

The creative works with which this offer is associated. If provided, all videos that are associated with these creative works will be included in the offer.

entity_ids
string[]

The entities with which this offer is associated. If provided, all videos that are associated with these entities will be included in the offer.

event_ids
string[]

The events with which this offer is associated. If provided, all videos that are associated with these events will be included in the offer.

localized_image_asset_id
object

A map of localized images for this offer. These should be large, visually attractive images. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc. If not all languages are provided, the default language will be used.

localized_logo_asset_id
object

A map of localized logos for this offer. These should be small images with a transparent background. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc. If not all languages are provided, the default language will be used.

offer_prices
object[]

An array of PriceOffers. When external_id is provided, pricing details are managed through a third-party system and this field should be empty.

priority
string

The priority of the offer. Offers with higher priority will be shown first to the end user.

visibility
enum<string>

The visibility of the offer to end-users.

Available options:
VISIBILITY_UNSPECIFIED,
VISIBILITY_PUBLISHED,
VISIBILITY_UNLISTED,
VISIBILITY_HIDDEN

Response

200 - application/json
offer
object

Offer represents a collection of video content that end users can purchase. This can be used e.g. to define Entitlements against.