GET api/NetworkAdUnit?sessionId={sessionId}&networkId={networkId}&name={name}&comparison={comparison}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all network ad units for network matching name

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

string

Required

networkId

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 APINetworkAdUnit
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

NetworkId

Unique identifier of network to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

Name

Textual identifier

string

None.

Width

Width of ad unit in pixels

integer

None.

Height

Height of ad unit in pixels

integer

None.

Biddable

Denotes that advertisers may directly bid to appear

boolean

None.

MultiPart

Denotes a multi-part ad unit

boolean

None.

MinimumImpressionPrice

Minimum CPM price for an advert to appear

decimal number

None.

MinimumClickPrice

Minimum CPC price for an advert to appear

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "networkId": 2,
    "state": "sample string 3",
    "name": "sample string 4",
    "width": 1,
    "height": 1,
    "biddable": true,
    "multiPart": true,
    "minimumImpressionPrice": 1.1,
    "minimumClickPrice": 1.1
  },
  {
    "id": 1,
    "networkId": 2,
    "state": "sample string 3",
    "name": "sample string 4",
    "width": 1,
    "height": 1,
    "biddable": true,
    "multiPart": true,
    "minimumImpressionPrice": 1.1,
    "minimumClickPrice": 1.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPINetworkAdUnit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APINetworkAdUnit>
    <Biddable>true</Biddable>
    <Height>1</Height>
    <Id>1</Id>
    <MinimumClickPrice>1.1</MinimumClickPrice>
    <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
    <MultiPart>true</MultiPart>
    <Name>sample string 4</Name>
    <NetworkId>2</NetworkId>
    <State>sample string 3</State>
    <Width>1</Width>
  </APINetworkAdUnit>
  <APINetworkAdUnit>
    <Biddable>true</Biddable>
    <Height>1</Height>
    <Id>1</Id>
    <MinimumClickPrice>1.1</MinimumClickPrice>
    <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
    <MultiPart>true</MultiPart>
    <Name>sample string 4</Name>
    <NetworkId>2</NetworkId>
    <State>sample string 3</State>
    <Width>1</Width>
  </APINetworkAdUnit>
</ArrayOfAPINetworkAdUnit>