Get Started
Studio API
- Introduction
- Streaming
- CMS
- OTT
- Monetization
- Offers (PPV, TVOD & SVOD)
- Transactions
- Entitlements
- IAM
- Integration
- Analytics
Content Delivery API
Deep dive
List offers
ListOffers
Returns list of offers based on specified parameters.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Maximum number of records to return
Filter the result-set by properties using a subset of the Kibana Query Language. Only AND statements are supported.
Currently supports filtering on cleeng_offer_id field.
The pagination token in the List request.
Response
The pagination token that should be used to get next page results. An empty value means no more results
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.
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 of the offer. This is an internal identifier and is not exposed to end users.
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.
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.
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.
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.
The entities with which this offer is associated. If provided, all videos that are associated with these entities will be included in the offer.
The events with which this offer is associated. If provided, all videos that are associated with these events will be included in the offer.
System generated identifier for the offer.
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.
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.
An array of PriceOffers. When external_id is provided, pricing details are managed through a third-party system and this field should be empty.
Access period
ACCESS_PERIOD_UNSPECIFIED, ACCESS_PERIOD_FOREVER, ACCESS_PERIOD_24_HOURS, ACCESS_PERIOD_48_HOURS, ACCESS_PERIOD_7_DAYS, ACCESS_PERIOD_30_DAYS, ACCESS_PERIOD_90_DAYS, ACCESS_PERIOD_365_DAYS Billing period
BILLING_PERIOD_UNSPECIFIED, BILLING_PERIOD_ONE_TIME, BILLING_PERIOD_WEEKLY, BILLING_PERIOD_MONTHLY, BILLING_PERIOD_QUARTERLY, BILLING_PERIOD_YEARLY System generated identifier for the offer.
The MSRP price of the offer
The three-letter currency code defined in ISO 4217.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units is positive, nanos must be positive or zero.
If units is zero, nanos can be positive, zero, or negative.
If units is negative, nanos must be negative or zero.
For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
The price of the offer
The three-letter currency code defined in ISO 4217.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units is positive, nanos must be positive or zero.
If units is zero, nanos can be positive, zero, or negative.
If units is negative, nanos must be negative or zero.
For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
Users are allowed to purchase the video from these countries (and disallowed from all others)
A country code (ISO 3316-1 alpha-2: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
Users are disallowed to purchase the video from these countries (and allowed from all others)
A country code (ISO 3316-1 alpha-2: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
Priority of the offer. This determines the order in which prices are shown to the user (when more than one price is available). A higher number means the price is shown earlier.
The priority of the offer. Offers with higher priority will be shown first to the end user.
The visibility of the offer to end-users.
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN