Get Started
Studio API
- Introduction
- Streaming
- CMS
- Events
- Creative Works
- Entities
- Content Types
- Annotations
- OTT
- Monetization
- IAM
- Integration
- Analytics
Content Delivery API
Deep dive
Get event
GetEvent
Returns event information by event ID.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
An event happening at a certain time and location, such as a sports game, concert, lecture, or festival.
System generated unique identifier for the event.
A map of localized descriptions for this event. 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.
Leaving this field empty will default to the description
field.
A map of localized poster asset IDs for this event. 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.
Leaving this field empty will default to the poster_asset_id
field.
A map of localized thumbnail asset IDs for this event. 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.
Leaving this field empty will default to the thumbnail_asset_id
field.
A map of localized titles for this event, for end users to see. 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.
Leaving this field empty will default to the title
field.
Continent code, one of AF, AN, AS, EU, NA, OC, SA
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges.
Country code complaint with ISO 3166-1 alpha-2
Current status of the event
EVENT_STATUS_UNSPECIFIED
, EVENT_STATUS_SCHEDULED
, EVENT_STATUS_RESCHEDULED
, EVENT_STATUS_CANCELLED
, EVENT_STATUS_POSTPONED
, EVENT_STATUS_MOVED_ONLINE
, EVENT_STATUS_DELAYED
, EVENT_STATUS_STARTED
, EVENT_STATUS_PAUSED
, EVENT_STATUS_SUSPENDED
, EVENT_STATUS_FINISHED
, EVENT_STATUS_PRESCHEDULED
The type id of the event. For example football_match
. May be set to default
when no custom fields are present.
VISIBILITY_UNSPECIFIED
, VISIBILITY_PUBLISHED
, VISIBILITY_UNLISTED
, VISIBILITY_HIDDEN