POST api/AdGroup?statistics={statistics}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
statistics

string

Required

offset

integer

Required

limit

integer

Required

includeClosed

boolean

Required

Body Parameters

Connection
NameDescriptionTypeAdditional information
ConnectionString

string

None.

PlatformName

string

None.

SystemName

string

None.

Username

string

None.

Password

string

None.

IpAddress

string

None.

SystemId

integer

None.

ManagerCountry

integer

None.

DisplayName

string

None.

SystemState

string

None.

DefaultLanguageName

string

None.

DefaultTimezoneId

integer

None.

DefaultTimezoneName

string

None.

DefaultTimezoneShortName

string

None.

DefaultTimezoneGeographicalName

string

None.

DefaultTimezoneWindowsRegistryKey

string

None.

DefaultTimezoneDescription

string

None.

DefaultCurrency

string

None.

UserLoginType

LoginType

None.

UserLoginId

integer

None.

TableRowId

integer

None.

Permissions

integer

None.

DailyUnitAllowance

integer

None.

RequestThrottle

integer

None.

RequestCapacity

integer

None.

MaximumRequestsPerMinute

integer

None.

ProfileCloud

Cloud

None.

DownloadCloud

Cloud

None.

RateLimiter

boolean

None.

ByPassWord

boolean

None.

LinkedIdList

Collection of integer

None.

Request Formats

application/json, text/json, application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of APIAdGroup
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

CampaignId

Unique identifier of campaign to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

NewReviewingRequired

Denotes that adgroup is new and requires reviewing

boolean

None.

ModifiedReviewingRequired

Denotes that adgroup has been modified and requires reviewing

boolean

None.

Name

Textual identifier

string

None.

SelectionMode

Selection mode: Keyword, Sector, RunOfNetwork, AdUnit, Retargeting or Beacon

string

None.

ManuallyHalted

Denotes that this has been manually halted

boolean

None.

Ranking

Ranking level for ad group: Inherit, Highest, Higher, High, Normal, Low, Lower or Lowest

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.

EndTimestampNotified

Denotes that advertiser has been notified that the end timestamp has been reached

boolean

None.

PostImpressionFrequencyDuration

Frequency capping duration applied after an impression

integer

None.

PostImpressionFrequencyCap

Frequency capping limit applied after an impression

integer

None.

PostImpressionInterval

Frequency capping interval applied after an impression

integer

None.

PostClickFrequencyDuration

Frequency capping duration applied after a click

integer

None.

PostClickFrequencyCap

Frequency capping limit applied after a click

integer

None.

PostClickInterval

Frequency capping interval applied after a click

integer

None.

ImpressionPrice

Default impression price

decimal number

None.

ClickPrice

Default click price

decimal number

None.

ImpressionCount

Statistics impression count

integer

None.

ClickCount

Statistics click count

integer

None.

Spent

Statistics spent

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "campaignId": 2,
    "state": "sample string 3",
    "newReviewingRequired": true,
    "modifiedReviewingRequired": true,
    "name": "sample string 4",
    "selectionMode": "sample string 5",
    "manuallyHalted": true,
    "ranking": "sample string 6",
    "creationTimestamp": "sample string 7",
    "startTimestamp": "sample string 8",
    "endTimestamp": "sample string 9",
    "endTimestampNotified": true,
    "postImpressionFrequencyDuration": 1,
    "postImpressionFrequencyCap": 1,
    "postImpressionInterval": 1,
    "postClickFrequencyDuration": 1,
    "postClickFrequencyCap": 1,
    "postClickInterval": 1,
    "impressionPrice": 1.1,
    "clickPrice": 1.1,
    "impressionCount": 1,
    "clickCount": 1,
    "spent": 1.1
  },
  {
    "id": 1,
    "campaignId": 2,
    "state": "sample string 3",
    "newReviewingRequired": true,
    "modifiedReviewingRequired": true,
    "name": "sample string 4",
    "selectionMode": "sample string 5",
    "manuallyHalted": true,
    "ranking": "sample string 6",
    "creationTimestamp": "sample string 7",
    "startTimestamp": "sample string 8",
    "endTimestamp": "sample string 9",
    "endTimestampNotified": true,
    "postImpressionFrequencyDuration": 1,
    "postImpressionFrequencyCap": 1,
    "postImpressionInterval": 1,
    "postClickFrequencyDuration": 1,
    "postClickFrequencyCap": 1,
    "postClickInterval": 1,
    "impressionPrice": 1.1,
    "clickPrice": 1.1,
    "impressionCount": 1,
    "clickCount": 1,
    "spent": 1.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPIAdGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APIAdGroup>
    <CampaignId>2</CampaignId>
    <ClickCount>1</ClickCount>
    <ClickPrice>1.1</ClickPrice>
    <CreationTimestamp>sample string 7</CreationTimestamp>
    <EndTimestamp>sample string 9</EndTimestamp>
    <EndTimestampNotified>true</EndTimestampNotified>
    <Id>1</Id>
    <ImpressionCount>1</ImpressionCount>
    <ImpressionPrice>1.1</ImpressionPrice>
    <ManuallyHalted>true</ManuallyHalted>
    <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
    <Name>sample string 4</Name>
    <NewReviewingRequired>true</NewReviewingRequired>
    <PostClickFrequencyCap>1</PostClickFrequencyCap>
    <PostClickFrequencyDuration>1</PostClickFrequencyDuration>
    <PostClickInterval>1</PostClickInterval>
    <PostImpressionFrequencyCap>1</PostImpressionFrequencyCap>
    <PostImpressionFrequencyDuration>1</PostImpressionFrequencyDuration>
    <PostImpressionInterval>1</PostImpressionInterval>
    <Ranking>sample string 6</Ranking>
    <SelectionMode>sample string 5</SelectionMode>
    <Spent>1.1</Spent>
    <StartTimestamp>sample string 8</StartTimestamp>
    <State>sample string 3</State>
  </APIAdGroup>
  <APIAdGroup>
    <CampaignId>2</CampaignId>
    <ClickCount>1</ClickCount>
    <ClickPrice>1.1</ClickPrice>
    <CreationTimestamp>sample string 7</CreationTimestamp>
    <EndTimestamp>sample string 9</EndTimestamp>
    <EndTimestampNotified>true</EndTimestampNotified>
    <Id>1</Id>
    <ImpressionCount>1</ImpressionCount>
    <ImpressionPrice>1.1</ImpressionPrice>
    <ManuallyHalted>true</ManuallyHalted>
    <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
    <Name>sample string 4</Name>
    <NewReviewingRequired>true</NewReviewingRequired>
    <PostClickFrequencyCap>1</PostClickFrequencyCap>
    <PostClickFrequencyDuration>1</PostClickFrequencyDuration>
    <PostClickInterval>1</PostClickInterval>
    <PostImpressionFrequencyCap>1</PostImpressionFrequencyCap>
    <PostImpressionFrequencyDuration>1</PostImpressionFrequencyDuration>
    <PostImpressionInterval>1</PostImpressionInterval>
    <Ranking>sample string 6</Ranking>
    <SelectionMode>sample string 5</SelectionMode>
    <Spent>1.1</Spent>
    <StartTimestamp>sample string 8</StartTimestamp>
    <State>sample string 3</State>
  </APIAdGroup>
</ArrayOfAPIAdGroup>