PUT api/Copy?sessionId={sessionId}

Updates an existing copy

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

string

Required

Body Parameters

APICopy
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

AdGroupId

Unique identifier of ad group to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

NewReviewingRequired

Denotes that copy is new and requires reviewing

boolean

None.

ModifiedReviewingRequired

Denotes that copy has been modified and requires reviewing

boolean

None.

Description

Textual description of copy

string

None.

CreationTimestamp

Timestamp when this was created

string

None.

StartTimestamp

Timestamp from whence this becomes active

string

None.

EndTimestamp

Timestamp until which this remains active

string

None.

ManuallyHalted

Denotes that this has been manually paused

boolean

None.

Type

Type of advert: Banner, Text, Video, Bullet, Vast, Html5 or Flash

string

None.

Width

Width of copy in pixels (banner, video, vast, html flash)

integer

None.

Height

Height of copy in pixels (banner, video, vast, html flash)

integer

None.

VastFormat

Vast format: 1 = Video (using video mime types), 2 = Companion (using banner or flash mime types) or 3 = Overlay (using banner or flash mime types)

integer

None.

VastSkipOffset

Vast skip offset - Number of seconds to play video before skip control becomes visible

integer

None.

VastDuration

Vast duration - Number of seconds for which video plays

integer

None.

ThirdPartyURL

Third party URL from whence the browser should fetch the advert - HTML5 adverts typically use third party URL rather than third party tag

string

None.

ThirdPartyTag

Third party advert tag

string

None.

NewString1

Non third party text and bullet adverts: New Title

string

None.

String1

Non third party text and bullet adverts: Title

string

None.

NewString2

Non third party text and bullet adverts: New Summary

string

None.

String2

Non third party text and bullet adverts: Summary

string

None.

NewString3

New click-through URL for all types

string

None.

String3

Click-through URL for all types

string

None.

NewDisplay3

Non third party text and bullet adverts: New Displayed URL

string

None.

Display3

Non third party text and bullet adverts: Displayed URL

string

None.

Tracking3

Tracking URL for all types

string

None.

ImpressionCount

Statistics impression count

integer

None.

ClickCount

Statistics click count

integer

None.

Spent

Statistics spent

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "adGroupId": 2,
  "state": "sample string 3",
  "newReviewingRequired": true,
  "modifiedReviewingRequired": true,
  "description": "sample string 4",
  "creationTimestamp": "sample string 5",
  "startTimestamp": "sample string 6",
  "endTimestamp": "sample string 7",
  "manuallyHalted": true,
  "type": "sample string 8",
  "width": 1,
  "height": 1,
  "vastFormat": 1,
  "vastSkipOffset": 1,
  "vastDuration": 1,
  "thirdPartyURL": "sample string 9",
  "thirdPartyTag": "sample string 10",
  "newString1": "sample string 11",
  "string1": "sample string 12",
  "newString2": "sample string 13",
  "string2": "sample string 14",
  "newString3": "sample string 15",
  "string3": "sample string 16",
  "newDisplay3": "sample string 17",
  "display3": "sample string 18",
  "tracking3": "sample string 19",
  "impressionCount": 1,
  "clickCount": 1,
  "spent": 1.1
}

application/xml, text/xml

Sample:
<APICopy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <AdGroupId>2</AdGroupId>
  <ClickCount>1</ClickCount>
  <CreationTimestamp>sample string 5</CreationTimestamp>
  <Description>sample string 4</Description>
  <Display3>sample string 18</Display3>
  <EndTimestamp>sample string 7</EndTimestamp>
  <Height>1</Height>
  <Id>1</Id>
  <ImpressionCount>1</ImpressionCount>
  <ManuallyHalted>true</ManuallyHalted>
  <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
  <NewDisplay3>sample string 17</NewDisplay3>
  <NewReviewingRequired>true</NewReviewingRequired>
  <NewString1>sample string 11</NewString1>
  <NewString2>sample string 13</NewString2>
  <NewString3>sample string 15</NewString3>
  <Spent>1.1</Spent>
  <StartTimestamp>sample string 6</StartTimestamp>
  <State>sample string 3</State>
  <String1>sample string 12</String1>
  <String2>sample string 14</String2>
  <String3>sample string 16</String3>
  <ThirdPartyTag>sample string 10</ThirdPartyTag>
  <ThirdPartyURL>sample string 9</ThirdPartyURL>
  <Tracking3>sample string 19</Tracking3>
  <Type>sample string 8</Type>
  <VastDuration>1</VastDuration>
  <VastFormat>1</VastFormat>
  <VastSkipOffset>1</VastSkipOffset>
  <Width>1</Width>
</APICopy>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.