LabelService

This service is dedicated to label management. It allows retrieving advertiser and campaign labels list, and set labels to selected campaign. This service should be used to get advertiser labels and set them to selected campaign.
Target Namespace:
http://www.adform.com/api/2013/12/25
Location:
https://api.adform.com/Services/LabelService.svc
WSDL:
Operations:
  • GetAdvertiserLabels

    Description:
    Get list of all label groups, filtered by specified AdvertiserId. AdvertiserId is required.
    Input:
    GetAdvertiserLabelsData
    Field Type Description
    AdvertiserId
    int
    Get label groups by specified AdvertiserId. Field is required.
    Output:
    LabelGroups
    LabelGroup list.
    LabelGroup
    Field Type Description
    Id
    int
    Label group identifier.
    Name
    string
    Label group name.
    Labels
    Label[]
    Array of labels.
    Label
    Field Type Description
    Id
    int
    Label identifier.
    Name
    string
    Label name.
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
  • GetCampaignLabels

    Description:
    Get a list of campaign labels.
    Input:
    GetCampaignLabelsData
    Field Type Description
    CampaignId
    int
    Campaign identifier. Field is required.
    Output:
    CampaignLabelGroups
    CampaignLabelGroup list.
    CampaignLabelGroup
    Field Type Description
    LabelId
    int
    Label identifier.
    LabelName
    string
    Label name.
    GroupId
    int
    Label group identifier.
    GroupName
    string
    Label group name.
    CampaignId
    int
    Campaign identifier.
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
  • SetCampaignLabels

    Description:
    Set labers for selected campaign.
    Input:
    SetCampaignLabelsData
    Field Type Description
    CampaignId
    int
    Campaign id. Field is required.
    CampaignLabels
    CampaignLabel[]
    Array of campaign labels. Labels for selected campaign will be set to null if not provided.
    CampaignLabel
    Field Type Description
    Id
    int
    Label identifier, that you want to set. Field is required.
    Output:
    CampaignLabelGroups
    CampaignLabelGroup list.
    CampaignLabelGroup
    Field Type Description
    LabelId
    int
    Label identifier.
    LabelName
    string
    Label name.
    GroupId
    int
    Label group identifier.
    GroupName
    string
    Label group name.
    CampaignId
    int
    Campaign identifier.
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
  • AddAdvertiserLabel

    Description:
    Add a new label to the specified advertiser label group.
    Input:
    AddAdvertiserLabelData
    Field Type Description
    GroupId
    int
    Advertiser label group Id. Field is required.
    LabelName
    string
    Name of the new label. Field is required.
    Output:
    AddAdvertiserLabelResult
    Field Type Description
    Label
    AdvertiserLabel
    New label object.
    AdvertiserLabel
    Field Type Description
    Id
    int
    Label identifier.
    LabelName
    string
    Label name.
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
  • RemoveAdvertiserLabel

    Description:
    Remove specified label. Label will also be removed from all associated label groups.
    Input:
    RemoveAdvertiserLabelData
    Field Type Description
    LabelId
    int
    Label id. Field is required.
    Output:
    RemoveAdvertiserLabelResult
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
  • GetPlacementLabels

    Description:
    Get a list of selected placement labels.
    Input:
    GetPlacementLabelsData
    Field Type Description
    PlacementIds
    int[]
    Array of placement ids. Field is required.
    Output:
    PlacementsLabelGroups
    PlacementLabelGroup list.
    PlacementLabelGroup
    Field Type Description
    LabelId
    int
    Label identifier.
    LabelName
    string
    Label name.
    GroupId
    int
    Label group identifier.
    GroupName
    string
    Label group name.
    PlacementId
    int
    placement identifier.
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
  • SetPlacementLabels

    Description:
    Set labels for selected placements.
    Input:
    SetPlacementLabelsData
    Field Type Description
    PlacementId
    int
    Placement id. Field is required.
    PlacementLabels
    PlacementLabel[]
    Array of placement labels. Labels for selected placement will be set to null if not provided.
    PlacementLabel
    Field Type Description
    Id
    int
    Label identifier, that you want to set. Field is required.
    Output:
    PlacementLabelGroups
    PlacementLabelGroup list.
    PlacementLabelGroup
    Field Type Description
    LabelId
    int
    Label identifier.
    LabelName
    string
    Label name.
    GroupId
    int
    Label group identifier.
    GroupName
    string
    Label group name.
    PlacementId
    int
    placement identifier.
    Errors:
    For a list of errors see errors page
    Samples:
    For request/response samples see samples page
Go to documentation main