Get Started
Studio API
Content Delivery API
Deep dive
curl --request GET \
--url https://api.mottostreaming.com/cms/banners/v2/batch \
--header 'Authorization: Bearer <token>'{
"banners": [
{
"project_id": "<string>",
"name": "<string>",
"banner_type": "BANNER_TYPE_UNSPECIFIED",
"template_type": "<string>",
"id": "<string>",
"content_id": "<string>",
"dynamic_target": {
"filter": "<string>",
"order_by": "<string>"
},
"background_assets": [
{
"options": [
{
"asset_id": {
"asset_id": {}
},
"keypath": "<string>"
}
],
"breakpoint_width": 123
}
],
"data": {},
"environments": [
"<string>"
],
"css_classes": [
"<string>"
],
"visibility": "VISIBILITY_UNSPECIFIED",
"overrides": {},
"geo_applicability_exempt": {
"country_codes": [
"<string>"
]
},
"geo_applicability_apply": {
"country_codes": [
"<string>"
]
},
"destination_url": {}
}
]
}Batch get banners
BatchGetBanners
Returns banner information by banner IDs.
curl --request GET \
--url https://api.mottostreaming.com/cms/banners/v2/batch \
--header 'Authorization: Bearer <token>'{
"banners": [
{
"project_id": "<string>",
"name": "<string>",
"banner_type": "BANNER_TYPE_UNSPECIFIED",
"template_type": "<string>",
"id": "<string>",
"content_id": "<string>",
"dynamic_target": {
"filter": "<string>",
"order_by": "<string>"
},
"background_assets": [
{
"options": [
{
"asset_id": {
"asset_id": {}
},
"keypath": "<string>"
}
],
"breakpoint_width": 123
}
],
"data": {},
"environments": [
"<string>"
],
"css_classes": [
"<string>"
],
"visibility": "VISIBILITY_UNSPECIFIED",
"overrides": {},
"geo_applicability_exempt": {
"country_codes": [
"<string>"
]
},
"geo_applicability_apply": {
"country_codes": [
"<string>"
]
},
"destination_url": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Response
OK
Show child attributes
Show child attributes
A name for visual identification within the management UI. Does not appear towards end users.
The type of banner that determines how content is sourced.
BANNER_TYPE_UNSPECIFIED, BANNER_TYPE_DEFAULT, BANNER_TYPE_EVENT, BANNER_TYPE_CREATIVE_WORK, BANNER_TYPE_ENTITY The type of template that should be rendered. Refer to the documentation to find the available types. Examples: "team-vs-team-hero", "simple", "video-bg", "highlighted-event", etc.
System generated unique identifier for the banner.
Single banner - it is connected to a single content item (either an event, entity, or creative work).
Dynamic banner - it is not connected to a single content item, but derives its content from a set of filters.
Show child attributes
Show child attributes
Filter the result-set by properties using a subset of the Kibana Query Language. This will make a List API call to retrieve the relevant resource for this banner. For BANNER_TYPE_EVENT, this would be a ListEvents call. For BANNER_TYPE_CREATIVE_WORK, this would be a ListCreativeWorks call. For BANNER_TYPE_ENTITY, this would be a ListEntities call,
For example, let's say a BANNER_TYPE_EVENT banner is shown on a competition page, and the goal is to show the
first upcoming event from that competition in the banner.
The filter could be: status:EVENT_STATUS_SCHEDULED and fields.competition.id:{id}
in combination with the order_by value of start_time asc to get the next upcoming event.
To be used in combination with filter. See documentation there for more details.
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.
Show child attributes
Show child attributes
Multiple options to choose from for this asset. The first option that resolves to a valid asset URL will be used.
This is typically useful when there are several keypaths that may contain a usable asset, in which case the first
one that resolves to a valid URL will be selected. Typically it is recommended to put the asset_id option last, so that
it acts as a fallback if none of the keypaths resolve to a valid asset.
However, for static banners it may make sense to only provide a single asset_id option.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
A keypath on the associated content resource. This should resolve to a Motto-hosted asset URL.
Unlike the asset_id field, this will already be localized based on the end user's language preference.
E.g.: event.fields.competition.item.banner
The min-width at which this image/video should be shown (unless another asset is closer to the min-width).
Data needed by individual templates. Each template can have its own data structure.
Refer to the documentation for the specific template to see what data is needed.
To reference properties of the connected content item, use variable keypaths like {event.title}, {entity.name},
{event.fields.competition.item.banner} etc.
The environments in which this banner should be rendered. The available options are: "web", "ios", "android", "tvos", "lg", "samsung", "androidtv"
Important: this should always be a subset of the environments configured at the page-component level for the associated banner collection. For example, if a page component is configured to be "ios" only, but a banner inside that component has "web" only, that banner will never be shown.
Web only. A list of CSS classes that should be added to the banner's container element. This can be used to apply custom styling to the banner.
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN A map of overrides for the banner. This is useful for scenarios where some subset of Banner instantiations should have different properties.
The key is a content_id (either event ID, entity ID, or creative work ID), the value is the override to apply when that content is in context.
Note that a hit on a banner override will entirely replace the banner template and data; it will not merge with the base banner.
Show child attributes
Show child attributes
BannerOverride is a subset of the Banner message. It can be used to modify default behavior of a banner.
Show child attributes
Show child attributes
The type of template that should be rendered. Refer to the documentation to find the available types. Examples: "team-vs-team-hero", "simple", "video-bg", "highlighted-event", etc.
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.
Show child attributes
Show child attributes
Multiple options to choose from for this asset. The first option that resolves to a valid asset URL will be used.
This is typically useful when there are several keypaths that may contain a usable asset, in which case the first
one that resolves to a valid URL will be selected. Typically it is recommended to put the asset_id option last, so that
it acts as a fallback if none of the keypaths resolve to a valid asset.
However, for static banners it may make sense to only provide a single asset_id option.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
A keypath on the associated content resource. This should resolve to a Motto-hosted asset URL.
Unlike the asset_id field, this will already be localized based on the end user's language preference.
E.g.: event.fields.competition.item.banner
The min-width at which this image/video should be shown (unless another asset is closer to the min-width).
Data needed by individual templates. Each template can have its own data structure.
Refer to the documentation for the specific template to see what data is needed.
For static banners, this would contain the fixed content (texts, assets, destination_url).
For dynamic banners, this can contain template references like {event.title}, {entity.name}, etc.
The environments in which this banner should be rendered. The available options are: "web", "ios", "android", "tvos", "lg", "samsung", "androidtv" If left empty, the banner will be rendered in all environments (when possible).
Web only. A list of CSS classes that should be added to the banner's container element. This can be used to apply custom styling to the banner.
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN Viewers from these countries will not have this video ad shown.
Show child attributes
Show child attributes
A country code (ISO 3316-1 alpha-2: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
Viewers from these countries will have this video ad shown.
Show child attributes
Show child attributes
A country code (ISO 3316-1 alpha-2: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
Optional. 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. Note that this is not necessary for banners of type BANNER_TYPE_EVENT, BANNER_TYPE_CREATIVE_WORK, or BANNER_TYPE_ENTITY, as the destination URL will be derived from the connected content item in those cases.
Show child attributes
Show child attributes
Viewers from these countries will not have this video ad shown.
Show child attributes
Show child attributes
A country code (ISO 3316-1 alpha-2: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
Viewers from these countries will have this video ad shown.
Show child attributes
Show child attributes
A country code (ISO 3316-1 alpha-2: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
Optional. 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. Note that this is not necessary for banners of type BANNER_TYPE_EVENT, BANNER_TYPE_CREATIVE_WORK, or BANNER_TYPE_ENTITY, as the destination URL will be derived from the connected content item in those cases.
Show child attributes
Show child attributes