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.

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"
}

application/xml, text/xml

Sample:

<CreativeBackgroundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HDPro.Core.Manager.Studio.Creative">
  <Brief>sample string 4</Brief>
  <CampaignId>sample string 1</CampaignId>
  <Goal>sample string 5</Goal>
  <ImageProvider>sample string 6</ImageProvider>
  <LogoImages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </LogoImages>
  <LogoPlacement>sample string 8</LogoPlacement>
  <Placements>
    <CreativeBackgroundRequest.PlacementBox>
      <H>6</H>
      <Kind>sample string 2</Kind>
      <Ref>sample string 1</Ref>
      <W>5</W>
      <X>3</X>
      <Y>4</Y>
    </CreativeBackgroundRequest.PlacementBox>
    <CreativeBackgroundRequest.PlacementBox>
      <H>6</H>
      <Kind>sample string 2</Kind>
      <Ref>sample string 1</Ref>
      <W>5</W>
      <X>3</X>
      <Y>4</Y>
    </CreativeBackgroundRequest.PlacementBox>
  </Placements>
  <ProductImages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ProductImages>
  <ProductPlacement>sample string 7</ProductPlacement>
  <ReferenceImages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReferenceImages>
  <Slots>
    <CreativeBackgroundRequest.SlotInfo>
      <Kind>sample string 2</Kind>
      <Ref>sample string 1</Ref>
      <Text>sample string 3</Text>
    </CreativeBackgroundRequest.SlotInfo>
    <CreativeBackgroundRequest.SlotInfo>
      <Kind>sample string 2</Kind>
      <Ref>sample string 1</Ref>
      <Text>sample string 3</Text>
    </CreativeBackgroundRequest.SlotInfo>
  </Slots>
  <TargetHeight>3</TargetHeight>
  <TargetWidth>2</TargetWidth>
</CreativeBackgroundRequest>

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.