GET api/campaign/detail/search/{id}

Retrieves the information for a given campaign."

Request Information

Authentication Method

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Successful Response:

Resource Description

Search Campaign Detail

Name	Description	Type
geoTargetRegion	The geographically targeted regions provinces or states for the campaign.	Collection of Geo Target Region
geoTargetCity	The geographically targeted cities for the campaign.	Collection of Geo Target City
targetLanguage	The language of the user to which the ads should be targeted	string
adGroups	A collection of Ad Groups for the given campaign	Collection of Search Ad Group
id	The campaign Id. Used for any action taken on the campaign or its subscritption.	integer
name	The name by which the user knows the campaign	string
landingUrl	The default landing URL for the ads under this campaign. This si the URL to which the browser should be directed when an ad is clicked.	string
campaignFocus	This is a place holder for a future feature and will return "Unknown" for now. The main purpose for the campaign. This defines what the site owner desires to accomplish with the campaign. See Campaign Focus.	string
geoTargetCountry	The geographically targeted country for the campaign. If targeting at a Region or City level they must fall within this country	string
geoTargetFocus	The Geographic Targeting Focus the campaign should use.	string
status	The current Campaign Status	string
type	The campaign type	string

Response Formats

application/json, text/json

Sample:

{
  "geoTargetRegion": null,
  "geoTargetCity": [
    {
      "id": 12345,
      "name": "Orlando",
      "regionCode": "FL",
      "country": "US"
    }
  ],
  "targetLanguage": "en",
  "adGroups": [
    {
      "ads": [
        {
          "headline1": "Visit Orlando for Family Fun",
          "headline2": "Disney, Universal, Legoland and more",
          "description": "Get Your Tickets Now",
          "id": 9876,
          "landingUrl": "https://www.mydomain.com/orlando",
          "displayUrl": "https://www.mydomain.com/",
          "status": "Active",
          "adGroupId": 6789
        },
        {
          "headline1": "Visit Orlando Today",
          "headline2": "{Keyword: Disney, Universal, Legoland and more}",
          "description": "Lowest Price on Tickets",
          "id": 9877,
          "landingUrl": "https://www.mydomain.com/orlando",
          "displayUrl": "https://www.mydomain.com/",
          "status": "Active",
          "adGroupId": 6789
        }
      ],
      "keywords": [
        {
          "text": "disney tickets",
          "matchType": "broad",
          "status": "enabled"
        },
        {
          "text": "disney tickets",
          "matchType": "phrase",
          "status": "enabled"
        },
        {
          "text": "disney tickets",
          "matchType": "exact",
          "status": "enabled"
        }
      ],
      "id": 6789,
      "name": "My AdGroup",
      "landingUrl": "https://www.mydomain.com/orlando",
      "status": "Active",
      "campaignId": 12345
    }
  ],
  "id": 12345,
  "name": "My campaign",
  "landingUrl": "https://www.mydomain.com/orlando",
  "campaignFocus": "GenerateSalesLeads",
  "geoTargetCountry": "US",
  "geoTargetFocus": "AreaOfInterest",
  "status": "Active",
  "type": "Search"
}

application/xml, text/xml

Sample:

<SearchCampaignDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <campaignFocus xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">GenerateSalesLeads</campaignFocus>
  <geoTargetCountry xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">US</geoTargetCountry>
  <geoTargetFocus xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">AreaOfInterest</geoTargetFocus>
  <id xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">12345</id>
  <landingUrl xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">https://www.mydomain.com/orlando</landingUrl>
  <name xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">My campaign</name>
  <status xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Active</status>
  <type xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Search</type>
  <adGroups>
    <SearchAdGroup>
      <campaignId xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">12345</campaignId>
      <id xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">6789</id>
      <landingUrl xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">https://www.mydomain.com/orlando</landingUrl>
      <name xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">My AdGroup</name>
      <status xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Active</status>
      <ads>
        <SearchAd>
          <adGroupId xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">6789</adGroupId>
          <displayUrl xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">https://www.mydomain.com/</displayUrl>
          <id xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">9876</id>
          <landingUrl xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">https://www.mydomain.com/orlando</landingUrl>
          <status xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Active</status>
          <description>Get Your Tickets Now</description>
          <headline1>Visit Orlando for Family Fun</headline1>
          <headline2>Disney, Universal, Legoland and more</headline2>
        </SearchAd>
        <SearchAd>
          <adGroupId xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">6789</adGroupId>
          <displayUrl xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">https://www.mydomain.com/</displayUrl>
          <id xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">9877</id>
          <landingUrl xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">https://www.mydomain.com/orlando</landingUrl>
          <status xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Active</status>
          <description>Lowest Price on Tickets</description>
          <headline1>Visit Orlando Today</headline1>
          <headline2>{Keyword: Disney, Universal, Legoland and more}</headline2>
        </SearchAd>
      </ads>
      <keywords>
        <Keyword>
          <matchType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">broad</matchType>
          <status xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">enabled</status>
          <text xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">disney tickets</text>
        </Keyword>
        <Keyword>
          <matchType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">phrase</matchType>
          <status xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">enabled</status>
          <text xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">disney tickets</text>
        </Keyword>
        <Keyword>
          <matchType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">exact</matchType>
          <status xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">enabled</status>
          <text xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">disney tickets</text>
        </Keyword>
      </keywords>
    </SearchAdGroup>
  </adGroups>
  <geoTargetCity>
    <GeoTargetCity>
      <country xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">US</country>
      <id xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">12345</id>
      <name xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Orlando</name>
      <regionCode xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">FL</regionCode>
    </GeoTargetCity>
  </geoTargetCity>
  <geoTargetRegion i:nil="true" />
  <targetLanguage>en</targetLanguage>
</SearchCampaignDetail>