NAME

Microsoft::AdCenter::V8::CampaignManagementService - Service client for Microsoft AdCenter Campaign Management Service.

SYNOPSIS

use Microsoft::AdCenter::V8::CampaignManagementService;

my $service_client = Microsoft::AdCenter::V8::CampaignManagementService->new
    ->ApplicationToken("application token")
    ->CustomerAccountId("customer account id")
    ->CustomerId("customer id")
    ->DeveloperToken("developer token")
    ->Password("password")
    ->UserName("user name");

my $response = $service_client->AddAdGroups(
    CampaignId => ...
    AdGroups => ...
);

See http://msdn.microsoft.com/en-us/library/ee730327.aspx for detailed documentation for this service.

METHODS

EndPoint

Changes the end point for this service client.

Default value: https://adcenterapi.microsoft.com/Api/Advertiser/V8/CampaignManagement/CampaignManagementService.svc

ApplicationToken

Gets/sets ApplicationToken (string) in the request header

CustomerAccountId

Gets/sets CustomerAccountId (string) in the request header

CustomerId

Gets/sets CustomerId (string) in the request header

DeveloperToken

Gets/sets DeveloperToken (string) in the request header

Password

Gets/sets Password (string) in the request header

UserName

Gets/sets UserName (string) in the request header

TrackingId

Gets TrackingId (string) in the response header

AddAdGroups

Parameters:
CampaignId (long)
AdGroups (ArrayOfAdGroup)
Returns:
AddAdGroupsResponse

AddAds

Parameters:
AdGroupId (long)
Ads (ArrayOfAd)
Returns:
AddAdsResponse

AddBusinesses

Parameters:
Businesses (ArrayOfBusiness)
Returns:
AddBusinessesResponse

AddCampaigns

Parameters:
AccountId (long)
Campaigns (ArrayOfCampaign)
Returns:
AddCampaignsResponse

AddGoals

Parameters:
AccountId (long)
Goals (ArrayOfGoal)
Returns:
AddGoalsResponse

AddKeywords

Parameters:
AdGroupId (long)
Keywords (ArrayOfKeyword)
Returns:
AddKeywordsResponse

AddSitePlacements

Parameters:
AdGroupId (long)
SitePlacements (ArrayOfSitePlacement)
Returns:
AddSitePlacementsResponse

AddTarget

Parameters:
AdGroupId (long)
Target (Target)
Returns:
AddTargetResponse

AddTargetsToLibrary

Parameters:
Targets (ArrayOfTarget)
Returns:
AddTargetsToLibraryResponse

DeleteAdGroups

Parameters:
CampaignId (long)
AdGroupIds (ArrayOflong)
Returns:
DeleteAdGroupsResponse

DeleteAds

Parameters:
AdGroupId (long)
AdIds (ArrayOflong)
Returns:
DeleteAdsResponse

DeleteBusinesses

Parameters:
BusinessIds (ArrayOflong)
Returns:
DeleteBusinessesResponse

DeleteCampaigns

Parameters:
AccountId (long)
CampaignIds (ArrayOflong)
Returns:
DeleteCampaignsResponse

DeleteGoals

Parameters:
AccountId (long)
GoalIds (ArrayOflong)
Returns:
DeleteGoalsResponse

DeleteKeywords

Parameters:
AdGroupId (long)
KeywordIds (ArrayOflong)
Returns:
DeleteKeywordsResponse

DeleteSitePlacements

Parameters:
AdGroupId (long)
SitePlacementIds (ArrayOflong)
Returns:
DeleteSitePlacementsResponse

DeleteTarget

Parameters:
AdGroupId (long)
Returns:
DeleteTargetResponse

DeleteTargetFromAdGroup

Parameters:
AdGroupId (long)
Returns:
DeleteTargetFromAdGroupResponse

DeleteTargetFromCampaign

Parameters:
CampaignId (long)
Returns:
DeleteTargetFromCampaignResponse

DeleteTargetsFromLibrary

Parameters:
TargetIds (ArrayOflong)
Returns:
DeleteTargetsFromLibraryResponse

DownloadCampaignHierarchy

Parameters:
AccountIds (ArrayOflong)
Campaigns (ArrayOfCampaignScope)
LastSyncTimeInUTC (dateTime)
EntityFilter (DownloadEntityFilter)
Returns:
DownloadCampaignHierarchyResponse

GetAdEditorialReasonsByIds

Parameters:
AdIds (ArrayOflong)
AccountId (long)
Returns:
GetAdEditorialReasonsByIdsResponse

GetAdGroupsByCampaignId

Parameters:
CampaignId (long)
Returns:
GetAdGroupsByCampaignIdResponse

GetAdGroupsByIds

Parameters:
CampaignId (long)
AdGroupIds (ArrayOflong)
Returns:
GetAdGroupsByIdsResponse

GetAdsByAdGroupId

Parameters:
AdGroupId (long)
Returns:
GetAdsByAdGroupIdResponse

GetAdsByEditorialStatus

Parameters:
AdGroupId (long)
EditorialStatus (AdEditorialStatus)
Returns:
GetAdsByEditorialStatusResponse

GetAdsByIds

Parameters:
AdGroupId (long)
AdIds (ArrayOflong)
Returns:
GetAdsByIdsResponse

GetAnalyticsType

Parameters:
AccountIds (ArrayOflong)
Returns:
GetAnalyticsTypeResponse

GetBusinessesByIds

Parameters:
BusinessIds (ArrayOflong)
Returns:
GetBusinessesByIdsResponse

GetBusinessesInfo

Parameters:
Returns:
GetBusinessesInfoResponse

GetCampaignAdExtensions

Parameters:
AccountId (long)
CampaignIds (ArrayOflong)
Returns:
GetCampaignAdExtensionsResponse

GetCampaignsByAccountId

Parameters:
AccountId (long)
Returns:
GetCampaignsByAccountIdResponse

GetCampaignsByIds

Parameters:
AccountId (long)
CampaignIds (ArrayOflong)
Returns:
GetCampaignsByIdsResponse

GetDeviceOSTargetsByIds

Parameters:
TargetIds (ArrayOflong)
Returns:
GetDeviceOSTargetsByIdsResponse

GetDownloadStatus

Parameters:
DownloadRequestId (string)
Returns:
GetDownloadStatusResponse

GetGoals

Parameters:
AccountId (long)
Returns:
GetGoalsResponse

GetKeywordEditorialReasonsByIds

Parameters:
KeywordIds (ArrayOflong)
AccountId (long)
Returns:
GetKeywordEditorialReasonsByIdsResponse

GetKeywordsByAdGroupId

Parameters:
AdGroupId (long)
Returns:
GetKeywordsByAdGroupIdResponse

GetKeywordsByEditorialStatus

Parameters:
AdGroupId (long)
EditorialStatus (KeywordEditorialStatus)
Returns:
GetKeywordsByEditorialStatusResponse

GetKeywordsByIds

Parameters:
AdGroupId (long)
KeywordIds (ArrayOflong)
Returns:
GetKeywordsByIdsResponse

GetNegativeKeywordsByAdGroupIds

Parameters:
CampaignId (long)
AdGroupIds (ArrayOflong)
Returns:
GetNegativeKeywordsByAdGroupIdsResponse

GetNegativeKeywordsByCampaignIds

Parameters:
AccountId (long)
CampaignIds (ArrayOflong)
Returns:
GetNegativeKeywordsByCampaignIdsResponse

GetNegativeSitesByAdGroupIds

Parameters:
CampaignId (long)
AdGroupIds (ArrayOflong)
Returns:
GetNegativeSitesByAdGroupIdsResponse

GetNegativeSitesByCampaignIds

Parameters:
AccountId (long)
CampaignIds (ArrayOflong)
Returns:
GetNegativeSitesByCampaignIdsResponse

GetNormalizedStrings

Parameters:
Strings (ArrayOfstring)
Language (string)
Returns:
GetNormalizedStringsResponse

GetPlacementDetailsForUrls

Parameters:
Urls (ArrayOfstring)
Returns:
GetPlacementDetailsForUrlsResponse

GetSitePlacementsByAdGroupId

Parameters:
AdGroupId (long)
Returns:
GetSitePlacementsByAdGroupIdResponse

GetSitePlacementsByIds

Parameters:
AdGroupId (long)
SitePlacementIds (ArrayOflong)
Returns:
GetSitePlacementsByIdsResponse

GetTargetByAdGroupId

Parameters:
AdGroupId (long)
Returns:
GetTargetByAdGroupIdResponse

GetTargetsByAdGroupIds

Parameters:
AdGroupIds (ArrayOflong)
Returns:
GetTargetsByAdGroupIdsResponse

GetTargetsByCampaignIds

Parameters:
CampaignIds (ArrayOflong)
Returns:
GetTargetsByCampaignIdsResponse

GetTargetsByIds

Parameters:
TargetIds (ArrayOflong)
Returns:
GetTargetsByIdsResponse

GetTargetsInfoFromLibrary

Parameters:
Returns:
GetTargetsInfoFromLibraryResponse

PauseAdGroups

Parameters:
CampaignId (long)
AdGroupIds (ArrayOflong)
Returns:
PauseAdGroupsResponse

PauseAds

Parameters:
AdGroupId (long)
AdIds (ArrayOflong)
Returns:
PauseAdsResponse

PauseCampaigns

Parameters:
AccountId (long)
CampaignIds (ArrayOflong)
Returns:
PauseCampaignsResponse

PauseKeywords

Parameters:
AdGroupId (long)
KeywordIds (ArrayOflong)
Returns:
PauseKeywordsResponse

PauseSitePlacements

Parameters:
AdGroupId (long)
SitePlacementIds (ArrayOflong)
Returns:
PauseSitePlacementsResponse

ResumeAdGroups

Parameters:
CampaignId (long)
AdGroupIds (ArrayOflong)
Returns:
ResumeAdGroupsResponse

ResumeAds

Parameters:
AdGroupId (long)
AdIds (ArrayOflong)
Returns:
ResumeAdsResponse

ResumeCampaigns

Parameters:
AccountId (long)
CampaignIds (ArrayOflong)
Returns:
ResumeCampaignsResponse

ResumeKeywords

Parameters:
AdGroupId (long)
KeywordIds (ArrayOflong)
Returns:
ResumeKeywordsResponse

ResumeSitePlacements

Parameters:
AdGroupId (long)
SitePlacementIds (ArrayOflong)
Returns:
ResumeSitePlacementsResponse

SetAnalyticsType

Parameters:
AccountAnalyticsTypes (ArrayOfAccountAnalyticsType)
Returns:
SetAnalyticsTypeResponse

SetCampaignAdExtensions

Parameters:
AccountId (long)
AdExtensions (ArrayOfAdExtension)
Returns:
SetCampaignAdExtensionsResponse

SetNegativeKeywordsToAdGroups

Parameters:
CampaignId (long)
AdGroupNegativeKeywords (ArrayOfAdGroupNegativeKeywords)
Returns:
SetNegativeKeywordsToAdGroupsResponse

SetNegativeKeywordsToCampaigns

Parameters:
AccountId (long)
CampaignNegativeKeywords (ArrayOfCampaignNegativeKeywords)
Returns:
SetNegativeKeywordsToCampaignsResponse

SetNegativeSitesToAdGroups

Parameters:
CampaignId (long)
AdGroupNegativeSites (ArrayOfAdGroupNegativeSites)
Returns:
SetNegativeSitesToAdGroupsResponse

SetNegativeSitesToCampaigns

Parameters:
AccountId (long)
CampaignNegativeSites (ArrayOfCampaignNegativeSites)
Returns:
SetNegativeSitesToCampaignsResponse

SetTargetToAdGroup

Parameters:
AdGroupId (long)
TargetId (long)
Returns:
SetTargetToAdGroupResponse

SetTargetToCampaign

Parameters:
CampaignId (long)
TargetId (long)
Returns:
SetTargetToCampaignResponse

SubmitAdGroupForApproval

Parameters:
AdGroupId (long)
Returns:
SubmitAdGroupForApprovalResponse

UpdateAdGroups

Parameters:
CampaignId (long)
AdGroups (ArrayOfAdGroup)
Returns:
UpdateAdGroupsResponse

UpdateAds

Parameters:
AdGroupId (long)
Ads (ArrayOfAd)
Returns:
UpdateAdsResponse

UpdateBusinesses

Parameters:
Businesses (ArrayOfBusiness)
Returns:
UpdateBusinessesResponse

UpdateCampaigns

Parameters:
AccountId (long)
Campaigns (ArrayOfCampaign)
Returns:
UpdateCampaignsResponse

UpdateDeviceOSTargets

Parameters:
TargetAssociations (ArrayOfTargetAssociation)
Returns:
UpdateDeviceOSTargetsResponse

UpdateGoals

Parameters:
AccountId (long)
Goals (ArrayOfGoal)
Returns:
UpdateGoalsResponse

UpdateKeywords

Parameters:
AdGroupId (long)
Keywords (ArrayOfKeyword)
Returns:
UpdateKeywordsResponse

UpdateSitePlacements

Parameters:
AdGroupId (long)
SitePlacements (ArrayOfSitePlacement)
Returns:
UpdateSitePlacementsResponse

UpdateTarget

Parameters:
AdGroupId (long)
Target (Target)
Returns:
UpdateTargetResponse

UpdateTargetsInLibrary

Parameters:
Targets (ArrayOfTarget)
Returns:
UpdateTargetsInLibraryResponse