Create banner
CreateBanner
Creates new banner.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
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 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 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.
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.