GET api/FeedAdGroup?systemName={systemName}&username={username}&password={password}&feedId={feedId}&name={name}&comparison={comparison}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all feed ad groups for feed matching name

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

feedId

integer

Required

name

string

Required

comparison

string

Required

offset

integer

Default value is 0

limit

integer

Default value is 0

includeClosed

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of APIFeedAdGroup
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

FeedId

Unique identifier of feed to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

Name

Textual identifier

string

None.

SelectionMode

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

string

None.

ManuallyHalted

Denotes that this has been manually halted

boolean

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.

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.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "feedId": 2,
    "state": "sample string 3",
    "name": "sample string 4",
    "selectionMode": "sample string 5",
    "manuallyHalted": true,
    "creationTimestamp": "sample string 6",
    "startTimestamp": "sample string 7",
    "endTimestamp": "sample string 8",
    "postImpressionFrequencyDuration": 1,
    "postImpressionFrequencyCap": 1,
    "postImpressionInterval": 1,
    "postClickFrequencyDuration": 1,
    "postClickFrequencyCap": 1,
    "postClickInterval": 1
  },
  {
    "id": 1,
    "feedId": 2,
    "state": "sample string 3",
    "name": "sample string 4",
    "selectionMode": "sample string 5",
    "manuallyHalted": true,
    "creationTimestamp": "sample string 6",
    "startTimestamp": "sample string 7",
    "endTimestamp": "sample string 8",
    "postImpressionFrequencyDuration": 1,
    "postImpressionFrequencyCap": 1,
    "postImpressionInterval": 1,
    "postClickFrequencyDuration": 1,
    "postClickFrequencyCap": 1,
    "postClickInterval": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPIFeedAdGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APIFeedAdGroup>
    <CreationTimestamp>sample string 6</CreationTimestamp>
    <EndTimestamp>sample string 8</EndTimestamp>
    <FeedId>2</FeedId>
    <Id>1</Id>
    <ManuallyHalted>true</ManuallyHalted>
    <Name>sample string 4</Name>
    <PostClickFrequencyCap>1</PostClickFrequencyCap>
    <PostClickFrequencyDuration>1</PostClickFrequencyDuration>
    <PostClickInterval>1</PostClickInterval>
    <PostImpressionFrequencyCap>1</PostImpressionFrequencyCap>
    <PostImpressionFrequencyDuration>1</PostImpressionFrequencyDuration>
    <PostImpressionInterval>1</PostImpressionInterval>
    <SelectionMode>sample string 5</SelectionMode>
    <StartTimestamp>sample string 7</StartTimestamp>
    <State>sample string 3</State>
  </APIFeedAdGroup>
  <APIFeedAdGroup>
    <CreationTimestamp>sample string 6</CreationTimestamp>
    <EndTimestamp>sample string 8</EndTimestamp>
    <FeedId>2</FeedId>
    <Id>1</Id>
    <ManuallyHalted>true</ManuallyHalted>
    <Name>sample string 4</Name>
    <PostClickFrequencyCap>1</PostClickFrequencyCap>
    <PostClickFrequencyDuration>1</PostClickFrequencyDuration>
    <PostClickInterval>1</PostClickInterval>
    <PostImpressionFrequencyCap>1</PostImpressionFrequencyCap>
    <PostImpressionFrequencyDuration>1</PostImpressionFrequencyDuration>
    <PostImpressionInterval>1</PostImpressionInterval>
    <SelectionMode>sample string 5</SelectionMode>
    <StartTimestamp>sample string 7</StartTimestamp>
    <State>sample string 3</State>
  </APIFeedAdGroup>
</ArrayOfAPIFeedAdGroup>