Get Started
Studio API
- Introduction
- Streaming
- CMS
- OTT
- Monetization
- IAM
- Integration
- Analytics
Content Delivery API
Deep dive
Update banner
UpdateBanner
Updates an existing banner.
curl --request PATCH \
--url https://api.mottostreaming.com/cms/banners/v1/{banner_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"banner_id": "<string>",
"banner_update": {
"project_id": "<string>",
"name": "<string>",
"destination_url": {},
"texts": [
{
"text": {},
"color": "<string>",
"background_color": "<string>",
"font_family": "<string>",
"is_button": true
}
],
"background_assets": [
{
"asset_id": {},
"loop": true,
"breakpoint_width": 123
}
],
"visibility": "VISIBILITY_UNSPECIFIED"
},
"update_mask": "<string>"
}'{
"banner": {
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"destination_url": {},
"texts": [
{
"text": {},
"color": "<string>",
"background_color": "<string>",
"font_family": "<string>",
"is_button": true
}
],
"background_assets": [
{
"asset_id": {},
"loop": true,
"breakpoint_width": 123
}
],
"visibility": "VISIBILITY_UNSPECIFIED"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Banner represents a single banner that can be displayed on an end-user facing web/app page.
A name for visual identification within the management UI. Does not appear towards end users.
A map of localized destination URLs. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the URL 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 list of textual elements that should show on top of the banner, ordered vertically from top to bottom. The first element will be considered the "primary" and will appear more prominently.
A map of localized text. 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.
Will be used to populate the CSS color property. Leave empty if the default should be used.
Will be used to populate the CSS background-color property. Leave empty if the default should be used.
Will be used to populate the CSS font-family property. Leave empty if the default should be used.
Indicates whether this is a button or not. If true, this button will be clickable/tappable, and the banner's
destination_url will be used. The banner will then no longer be clickable/tappable.
A list of assets to be shown in the background (as the main banner image).
Each asset is meant for a different screen size, determined by its breakpoint_width property.
E.g. if you only want a single asset for this banner, you can set breakpoint_width to 0.
E.g. if you want to show a different asset for mobile vs desktop, you can set breakpoint_width to 0 for the
mobile asset and 1024 for the desktop asset.
A map of either an image or video assets. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the assets 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 this is a video asset, indicate whether to loop the video endlessly.
The min-width at which this image/video should be shown (unless another asset is closer to the min-width).
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN Response
Banner represents a single banner that can be displayed on an end-user facing web/app page.
A name for visual identification within the management UI. Does not appear towards end users.
System generated unique identifier for the banner.
A map of localized destination URLs. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the URL 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 list of textual elements that should show on top of the banner, ordered vertically from top to bottom. The first element will be considered the "primary" and will appear more prominently.
A map of localized text. 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.
Will be used to populate the CSS color property. Leave empty if the default should be used.
Will be used to populate the CSS background-color property. Leave empty if the default should be used.
Will be used to populate the CSS font-family property. Leave empty if the default should be used.
Indicates whether this is a button or not. If true, this button will be clickable/tappable, and the banner's
destination_url will be used. The banner will then no longer be clickable/tappable.
A list of assets to be shown in the background (as the main banner image).
Each asset is meant for a different screen size, determined by its breakpoint_width property.
E.g. if you only want a single asset for this banner, you can set breakpoint_width to 0.
E.g. if you want to show a different asset for mobile vs desktop, you can set breakpoint_width to 0 for the
mobile asset and 1024 for the desktop asset.
A map of either an image or video assets. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the assets 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 this is a video asset, indicate whether to loop the video endlessly.
The min-width at which this image/video should be shown (unless another asset is closer to the min-width).
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN curl --request PATCH \
--url https://api.mottostreaming.com/cms/banners/v1/{banner_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"banner_id": "<string>",
"banner_update": {
"project_id": "<string>",
"name": "<string>",
"destination_url": {},
"texts": [
{
"text": {},
"color": "<string>",
"background_color": "<string>",
"font_family": "<string>",
"is_button": true
}
],
"background_assets": [
{
"asset_id": {},
"loop": true,
"breakpoint_width": 123
}
],
"visibility": "VISIBILITY_UNSPECIFIED"
},
"update_mask": "<string>"
}'{
"banner": {
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"destination_url": {},
"texts": [
{
"text": {},
"color": "<string>",
"background_color": "<string>",
"font_family": "<string>",
"is_button": true
}
],
"background_assets": [
{
"asset_id": {},
"loop": true,
"breakpoint_width": 123
}
],
"visibility": "VISIBILITY_UNSPECIFIED"
}
}