POST Api/V1/Studio/Creative/GenerateBackground

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CampaignId	string	None.
TargetWidth	integer	None.
TargetHeight	integer	None.
Brief	string	None.
Goal	string	None.
ImageProvider	string	None.
Placements	Collection of PlacementBox	None.
Slots	Collection of SlotInfo	None.
ReferenceImages	Collection of string	None.
ProductImages	Collection of string	None.
LogoImages	Collection of string	None.
ProductPlacement	string	None.
LogoPlacement	string	None.
Mode	string	None.
FlatLayout	Collection of FlatElementInfo	None.
Background	FlatBackgroundInfo	None.
SubjectMode	string	None.
FontSpecimens	Collection of FontSpecimenInfo	None.
MasterImage	string	None.
VariationConcept	string	None.
Kosher	boolean	None.
TextDirection	TextDirectionInfo	None.
Title	string	None.
Description	string	None.
AssetType	string	None.
Style	string	None.
BatchId	string	None.
CreativeContext	Collection of Object	None.
Intermediate	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "CampaignId": "sample string 1",
  "TargetWidth": 2,
  "TargetHeight": 3,
  "Brief": "sample string 4",
  "Goal": "sample string 5",
  "ImageProvider": "sample string 6",
  "Placements": [
    {
      "Ref": "sample string 1",
      "Kind": "sample string 2",
      "X": 3,
      "Y": 4,
      "W": 5,
      "H": 6
    },
    {
      "Ref": "sample string 1",
      "Kind": "sample string 2",
      "X": 3,
      "Y": 4,
      "W": 5,
      "H": 6
    }
  ],
  "Slots": [
    {
      "Ref": "sample string 1",
      "Kind": "sample string 2",
      "Text": "sample string 3"
    },
    {
      "Ref": "sample string 1",
      "Kind": "sample string 2",
      "Text": "sample string 3"
    }
  ],
  "ReferenceImages": [
    "sample string 1",
    "sample string 2"
  ],
  "ProductImages": [
    "sample string 1",
    "sample string 2"
  ],
  "LogoImages": [
    "sample string 1",
    "sample string 2"
  ],
  "ProductPlacement": "sample string 7",
  "LogoPlacement": "sample string 8",
  "Mode": "sample string 9",
  "FlatLayout": [
    {
      "Ref": "sample string 1",
      "Kind": "sample string 2",
      "Text": "sample string 3",
      "Image": "sample string 4",
      "AutoPlace": true,
      "X": 6,
      "Y": 7,
      "W": 8,
      "H": 9,
      "Z": 10,
      "FontFamily": "sample string 11",
      "FontSize": 12,
      "FontWeight": 13,
      "Color": "sample string 14",
      "Background": "sample string 15",
      "Radius": 16,
      "Align": "sample string 17"
    },
    {
      "Ref": "sample string 1",
      "Kind": "sample string 2",
      "Text": "sample string 3",
      "Image": "sample string 4",
      "AutoPlace": true,
      "X": 6,
      "Y": 7,
      "W": 8,
      "H": 9,
      "Z": 10,
      "FontFamily": "sample string 11",
      "FontSize": 12,
      "FontWeight": 13,
      "Color": "sample string 14",
      "Background": "sample string 15",
      "Radius": 16,
      "Align": "sample string 17"
    }
  ],
  "Background": {
    "Mode": "sample string 1",
    "Color": "sample string 2",
    "Image": "sample string 3",
    "Prompt": "sample string 4"
  },
  "SubjectMode": "sample string 10",
  "FontSpecimens": [
    {
      "Ref": "sample string 1",
      "Family": "sample string 2",
      "Text": "sample string 3",
      "Image": "sample string 4"
    },
    {
      "Ref": "sample string 1",
      "Family": "sample string 2",
      "Text": "sample string 3",
      "Image": "sample string 4"
    }
  ],
  "MasterImage": "sample string 11",
  "VariationConcept": "sample string 12",
  "Kosher": true,
  "TextDirection": {
    "ReadingFlow": "sample string 1",
    "TextAlign": "sample string 2",
    "CtaPos": "sample string 3",
    "Rules": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Title": "sample string 14",
  "Description": "sample string 15",
  "AssetType": "sample string 16",
  "Style": "sample string 17",
  "BatchId": "sample string 18",
  "CreativeContext": null,
  "Intermediate": true
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreativeBackgroundRequest'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.