POST api/Banners/Preview
Generate a banner image preview independent of any campaign or landingpage. Any data passed with the Preview() call must be permanently saved calling GetPixelScript() before running ActivateCampaign().
Request Information
URI Parameters
None.
Body Parameters
The Frantz banner preview request object
FrantzBannerPreviewRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| apiToken |
API Token provided using the Auth method |
string |
Required |
| Title |
This is the banner headline/title. For Meta ads, the headline text has a limit of 40 characters when not used inside the banner image. If your title is longer, it will get truncated below the image. |
string |
Required |
| BannerImageUrl |
The background image url for your banner |
string |
None. |
| BannerLogoUrl |
The logo image url to your customers logo |
string |
None. |
| PrimaryText |
Banner primary text is the short description of the ad. On the Meta preview template, this text is located at the top below your company logo. It has a limitation of 125 characters. |
string |
Max length: 125 |
| Description |
This is only valid for the Meta campaign preview template. Often used for text like 'Søknadsfrist: dd.MM.yyyy'. It has a limitation of 25 characters. |
string |
Max length: 25 |
| BannerSize |
Banner format |
BannerSizeFormat |
Required |
| BannerImageUrlAnchor |
Background image anchor position when re-scaling image to fit banner |
BannerContentItemImageAnchorPosition |
None. |
| TitleHexColor |
Title font color |
string |
Max length: 8 |
| BannerImageHexColorOverlay |
Background image overlay filter color |
string |
Max length: 8 |
| ReturnDataFormat |
Returning data format |
BannerReturnDataFormat |
None. |
Request Formats
application/json, text/json
{
"apiToken": "bbb196fc-2699-4653-bf2b-811e00f7b443",
"Title": "Statens vegvesen - Rekrutteringsspesialist",
"BannerImageUrl": "https://www.jobbnorge.no/logos/759/5323cf9c-092d-4bf0-b242-90fe6802d785.jpg",
"BannerLogoUrl": "https://www.jobbnorge.no/logos/759/5b9d786b-fa19-43a5-a7a7-2902b5d525b0.png",
"PrimaryText": "Er du en erfaren rekrutterer med evnen til å tiltrekke de beste kandidatene?",
"Description": "Søknadsfrist: 13.06.2023",
"BannerSize": 13,
"BannerImageUrlAnchor": 0,
"TitleHexColor": "",
"BannerImageHexColorOverlay": "",
"ReturnDataFormat": 1
}
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |