CampaignService

This service is dedicated to campaign management. It allows retrieving campaign list, creating and editing campaigns. This service should be used to get campaign id, campaign code to pass it as input to other services.
Target Namespace:
http://www.adform.com/api/2013/12/25
Location:
https://api.adform.com/Services/v20131225/CampaignService.svc
WSDL:
Operations:
  • GetCampaigns

    Description:
    Get list of all account campaigns filtered by specified parameters described below. All input parameters are optional.
    Input:
    GetCampaignsData
    Field Type Description
    AdvertiserId
    int
    Filter account campaigns by Advertiser.
    Ids
    int [ ]
    Filter account campaigns by a specified list of campaign identifiers.
    DateFrom
    dateTime
    Filter account campaigns by StartDate.
    DateTo
    dateTime
    Filter account campaigns by StartDate.
    Type
    string
    Filter account campaigns by campaign Type. Available values: 'Affiliate', 'Display', 'Print', 'Email', 'Mixed', 'Mobile', 'RTB', 'SearchNonAPI', 'SocialMedia'.
    State
    string
    Filter account campaigns by campaign State. Available values: 'Running', 'Pending', 'Finished'.
    Inactive
    boolean
    If true, then campaigns marked as inactive are returned. Field is optional. Default value - false.
    Output:
    Campaigns
    Campaign list.
    Campaign
    Field Type Description
    Id
    int
    Campaign identifier.
    AdvertiserId
    int
    Advertiser identifier.
    Code
    string
    Campaign code.
    Name
    string
    Campaign name.
    StartDate
    dateTime
    Campaign start date (time zone from campaign is used).
    EndDate
    dateTime
    Campaign end date (time zone from campaign is used).
    ResponsibleUserId
    int
    Responsible user identifier.
    CoResponsibleUserId
    int
    Co-Responsible user identifier.
    Type
    string
    Campaign type. Available values: Affiliate, Display, Print, Email, Mixed, Mobile, RTB, SearchNonAPI, SocialMedia.
    CategoryId
    int
    Campaign Category Id.
    Status
    string
    Campaign status. Ignored on input - a campaign is created with status 'Active'.
    Comment
    string
    Campaign comment.
    Currency
    string
    Campaign's currency code.
    CommentForReporting
    string
    Comment used in reporting services.
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
  • CreateCampaign

    Description:
    Create a new advertising campaign.
    Input:
    CreateCampaignData
    Field Type Description
    Campaign
    Campaign
    Campaign to create. Field is required.
    Campaign
    Field Type Description
    Id
    int
    Campaign identifier. Field is not used.
    AdvertiserId
    int
    Advertiser identifier. Field is required.
    Code
    string
    Campaign code. Field is not used.
    Name
    string
    Campaign name. Field length: 1-99. Field is required. Campaign name can not contain following symbols [\<>*'?"|;].
    StartDate
    dateTime
    Campaign start date (time zone from agency is used). Must be later than 3 months before campaign creation. Field is required.
    EndDate
    dateTime
    Campaign end date (time zone from agency is used). Must be earlier than 5 years from campaign creation. Field is required.
    ResponsibleUserId
    int
    Responsible user identifier. Field is optional. If user is not specified by default value is inherited from advertiser.
    CoResponsibleUserId
    int
    Co-Responsible user identifier. Field is optional. If user is not specified by default value is inherited from advertiser.
    Type
    string
    Campaign type. Available values: Affiliate, Display, Print, Email, Mixed, Mobile, RTB, SearchNonAPI, SocialMedia. Field is optional, by default 'Display'.
    CategoryId
    int
    Campaign Category. Field is required if categories functionality is enabled.
    Status
    string
    Campaign status. Field is not used.
    Comment
    string
    Campaign comment. Field is optional. Field length: 0-999.
    Currency
    string
    Campaign's currency code (as described in ISO 4217 standard). Field is optional. Default is campaign's agency's currency.
    CommentForReporting
    string
    Comment used in reporting services. Field is optional.
    Output:
    Campaign
    For detailed information on Campaign data type, see GetCampaigns Output documentation.
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
  • UpdateCampaign

    Description:
    Modify an existing advertising campaign.
    Input:
    UpdateCampaignData
    Field Type Description
    Campaign
    Campaign
    Campaign to update. Field is required.
    Campaign
    Field Type Description
    Id
    int
    Campaign identifier, that you want to update. Field is required.
    AdvertiserId
    int
    Advertiser identifier. Field is not used.
    Code
    string
    Campaign code. Field is not used.
    Name
    string
    Campaign name. Field length: 1-99. Field is optional. Campaign name can not contain following symbols [\<>*'?"|;].
    StartDate
    dateTime
    Campaign start date (time zone from campaign is used). Must be later than 3 months before campaign creation. Field is optional.
    EndDate
    dateTime
    Campaign end date (time zone from campaign is used). Must be earlier than 5 years from campaign creation. Field is optional.
    ResponsibleUserId
    int
    Responsible user identifier. Field is optional.
    CoResponsibleUserId
    int
    Co-Responsible user identifier. Field is optional.
    Type
    string
    Campaign type. Available values: Affiliate, Display, Print, Email, Mixed, Mobile, RTB, SearchNonAPI, SocialMedia. Field is optional.
    CategoryId
    int
    Campaign Category. Field is optional.
    Status
    string
    Campaign status. Field is optional.
    Comment
    string
    Campaign comment. Field is optional. Field length: 0-999.
    Currency
    string
    Campaign's currency code (as described in ISO 4217 standard). Field is optional.
    CommentForReporting
    string
    Comment used in reporting services. Field is optional.
    Output:
    Campaign
    For detailed information on Campaign data type, see GetCampaigns Output documentation.
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
  • GetCampaignCategories

    Description:
    Get a list of all campaign categories.
    Input:
    GetCampaignCategoriesData
    Output:
    CampaignCategories
    CampaignCategory list.
    CampaignCategory
    Field Type Description
    Id
    int
    Category identifier.
    Name
    string
    Category name.
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
Go to documentation main