GET api/CampaignTarget?systemName={systemName}&username={username}&password={password}&advertiserId={advertiserId}&offset={offset}&limit={limit}

Gets all campaign targets for advertiser

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

advertiserId

integer

Required

offset

integer

Default value is 0

limit

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of APICampaignTarget
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

CampaignId

Unique identifier of campaign to which this belongs

integer

None.

Gender

Gender: Male, Female or Any

string

None.

MinimumAge

Minimum age or 0 if no minimum age

integer

None.

MaximumAge

Maximum age or 0 if no maximum age

integer

None.

MinimumIncome

Minimum income or 0 if no minimum income

integer

None.

MaximumIncome

Maximum income or 0 if no maximum income

integer

None.

IgnoreUnknownGender

Ignore gender criteria where information is not known

boolean

None.

IgnoreUnknownAge

Ignore age criteria where information is not known

boolean

None.

IgnoreUnknownIncome

Ignore income criteria where information is not known

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "campaignId": 2,
    "gender": "sample string 3",
    "minimumAge": 1,
    "maximumAge": 1,
    "minimumIncome": 1,
    "maximumIncome": 1,
    "ignoreUnknownGender": true,
    "ignoreUnknownAge": true,
    "ignoreUnknownIncome": true
  },
  {
    "id": 1,
    "campaignId": 2,
    "gender": "sample string 3",
    "minimumAge": 1,
    "maximumAge": 1,
    "minimumIncome": 1,
    "maximumIncome": 1,
    "ignoreUnknownGender": true,
    "ignoreUnknownAge": true,
    "ignoreUnknownIncome": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPICampaignTarget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APICampaignTarget>
    <CampaignId>2</CampaignId>
    <Gender>sample string 3</Gender>
    <Id>1</Id>
    <IgnoreUnknownAge>true</IgnoreUnknownAge>
    <IgnoreUnknownGender>true</IgnoreUnknownGender>
    <IgnoreUnknownIncome>true</IgnoreUnknownIncome>
    <MaximumAge>1</MaximumAge>
    <MaximumIncome>1</MaximumIncome>
    <MinimumAge>1</MinimumAge>
    <MinimumIncome>1</MinimumIncome>
  </APICampaignTarget>
  <APICampaignTarget>
    <CampaignId>2</CampaignId>
    <Gender>sample string 3</Gender>
    <Id>1</Id>
    <IgnoreUnknownAge>true</IgnoreUnknownAge>
    <IgnoreUnknownGender>true</IgnoreUnknownGender>
    <IgnoreUnknownIncome>true</IgnoreUnknownIncome>
    <MaximumAge>1</MaximumAge>
    <MaximumIncome>1</MaximumIncome>
    <MinimumAge>1</MinimumAge>
    <MinimumIncome>1</MinimumIncome>
  </APICampaignTarget>
</ArrayOfAPICampaignTarget>