Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json
project_id
string
required
name
string
type
string

The type of component that should be rendered. It must correspond to the member of the data oneof that is set. Refer to the documentation to find the available types.

environments
string[]

The environments in which this component should be rendered. The available options are: "web", "ios", "android", "tvos", "lg", "samsung", "androidtv" If left empty, the component will be rendered in all environments (when possible).

visibility
enum<string>
Available options:
VISIBILITY_UNSPECIFIED,
VISIBILITY_PUBLISHED,
VISIBILITY_UNLISTED,
VISIBILITY_HIDDEN
group_id
string

An arbitrary string that can be used to group components together. This is useful to render a group of components in a shared container so that they can be styled/positioned together. Any component that shares a group_id with another component must immediately precede or follow it. If a group_id is not provided, the component's own id will be used as the group_id.

css_classes
string[]

Web only. A list of CSS classes that should be added to the component's container element. This can be used to apply custom styling to the component.

banner_collection
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

banner_collection_v2
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

calendar
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

calendar_v2
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

rail
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

content_grid
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

filter
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

creative_work_player
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

event_player
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

offers
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

player_profile
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

promotional_content
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

sponsorship_collection
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

standings
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

faq
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

text
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

image
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

html
object

Important: at most one of banner_collection, banner_collection_v2, calendar, calendar_v2, rail, content_grid, filter, creative_work_player, event_player, offers, player_profile, promotional_content, sponsorship_collection, standings, faq, footer, text, image, html may be set per request.

Response

OK

page_component
object