GET api/RunOfNetworkBid?sessionId={sessionId}&adGroupId={adGroupId}&statistics={statistics}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all run of network bids for ad group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

string

Required

adGroupId

integer

Required

statistics

string

Default value is none

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 APIRunOfNetworkBid
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 bid is new and requires reviewing

boolean

None.

ModifiedReviewingRequired

Denotes that bid has been modified and requires reviewing

boolean

None.

Ranking

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

string

None.

CreationTimestamp

Timestamp when this was created

string

None.

ManuallyHalted

Denotes that this has been manually paused

boolean

None.

ImpressionPrice

Override impression price

decimal number

None.

ClickPrice

Override click price

decimal number

None.

URLSuffix

Suffix appended to click through URL

string

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,
    "adGroupId": 2,
    "state": "sample string 3",
    "newReviewingRequired": true,
    "modifiedReviewingRequired": true,
    "ranking": "sample string 4",
    "creationTimestamp": "sample string 5",
    "manuallyHalted": true,
    "impressionPrice": 1.1,
    "clickPrice": 1.1,
    "urlSuffix": "sample string 6",
    "impressionCount": 1,
    "clickCount": 1,
    "spent": 1.1
  },
  {
    "id": 1,
    "adGroupId": 2,
    "state": "sample string 3",
    "newReviewingRequired": true,
    "modifiedReviewingRequired": true,
    "ranking": "sample string 4",
    "creationTimestamp": "sample string 5",
    "manuallyHalted": true,
    "impressionPrice": 1.1,
    "clickPrice": 1.1,
    "urlSuffix": "sample string 6",
    "impressionCount": 1,
    "clickCount": 1,
    "spent": 1.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPIRunOfNetworkBid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APIRunOfNetworkBid>
    <AdGroupId>2</AdGroupId>
    <ClickCount>1</ClickCount>
    <ClickPrice>1.1</ClickPrice>
    <CreationTimestamp>sample string 5</CreationTimestamp>
    <Id>1</Id>
    <ImpressionCount>1</ImpressionCount>
    <ImpressionPrice>1.1</ImpressionPrice>
    <ManuallyHalted>true</ManuallyHalted>
    <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
    <NewReviewingRequired>true</NewReviewingRequired>
    <Ranking>sample string 4</Ranking>
    <Spent>1.1</Spent>
    <State>sample string 3</State>
    <URLSuffix>sample string 6</URLSuffix>
  </APIRunOfNetworkBid>
  <APIRunOfNetworkBid>
    <AdGroupId>2</AdGroupId>
    <ClickCount>1</ClickCount>
    <ClickPrice>1.1</ClickPrice>
    <CreationTimestamp>sample string 5</CreationTimestamp>
    <Id>1</Id>
    <ImpressionCount>1</ImpressionCount>
    <ImpressionPrice>1.1</ImpressionPrice>
    <ManuallyHalted>true</ManuallyHalted>
    <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
    <NewReviewingRequired>true</NewReviewingRequired>
    <Ranking>sample string 4</Ranking>
    <Spent>1.1</Spent>
    <State>sample string 3</State>
    <URLSuffix>sample string 6</URLSuffix>
  </APIRunOfNetworkBid>
</ArrayOfAPIRunOfNetworkBid>