NAME

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

SYNOPSIS

use Microsoft::AdCenter::CampaignManagementService;

my $service_client = Microsoft::AdCenter::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%28v=MSADS.60%29.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/v6/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

AddBehavioralBids

Parameters: AdGroupId (long) BehavioralBids (ArrayOfBehavioralBid)

Returns: AddBehavioralBidsResponse

AddBusinesses

Parameters: Businesses (ArrayOfBusiness)

Returns: AddBusinessesResponse

AddCampaigns

Parameters: AccountId (long) Campaigns (ArrayOfCampaign)

Returns: AddCampaignsResponse

AddKeywords

Parameters: AdGroupId (long) Keywords (ArrayOfKeyword)

Returns: AddKeywordsResponse

AddSegments

Parameters: Segments (ArrayOfSegment)

Returns: AddSegmentsResponse

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

DeleteBehavioralBids

Parameters: AdGroupId (long) BehavioralBidIds (ArrayOflong)

Returns: DeleteBehavioralBidsResponse

DeleteBusinesses

Parameters: BusinessIds (ArrayOflong)

Returns: DeleteBusinessesResponse

DeleteCampaigns

Parameters: AccountId (long) CampaignIds (ArrayOflong)

Returns: DeleteCampaignsResponse

DeleteKeywords

Parameters: AdGroupId (long) KeywordIds (ArrayOflong)

Returns: DeleteKeywordsResponse

DeleteSegments

Parameters: SegmentIds (ArrayOflong)

Returns: DeleteSegmentsResponse

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

DeleteUsersFromSegment

Parameters: UserHash (ArrayOfbase64Binary)

Returns: DeleteUsersFromSegmentResponse

GetAdGroupsByCampaignId

Parameters: CampaignId (long)

Returns: GetAdGroupsByCampaignIdResponse

GetAdGroupsByIds

Parameters: CampaignId (long) AdGroupIds (ArrayOflong)

Returns: GetAdGroupsByIdsResponse

GetAdGroupsInfoByCampaignId

Parameters: CampaignId (long)

Returns: GetAdGroupsInfoByCampaignIdResponse

GetAdsByAdGroupId

Parameters: AdGroupId (long)

Returns: GetAdsByAdGroupIdResponse

GetAdsByEditorialStatus

Parameters: AdGroupId (long) EditorialStatus (AdEditorialStatus)

Returns: GetAdsByEditorialStatusResponse

GetAdsByIds

Parameters: AdGroupId (long) AdIds (ArrayOflong)

Returns: GetAdsByIdsResponse

GetBehavioralBidsByAdGroupId

Parameters: AdGroupId (long)

Returns: GetBehavioralBidsByAdGroupIdResponse

GetBehavioralBidsByIds

Parameters: AdGroupId (long) BehavioralBidIds (ArrayOflong)

Returns: GetBehavioralBidsByIdsResponse

GetBusinessesByIds

Parameters: BusinessIds (ArrayOflong)

Returns: GetBusinessesByIdsResponse

GetBusinessesInfo

Parameters:

Returns: GetBusinessesInfoResponse

GetCampaignsByAccountId

Parameters: AccountId (long)

Returns: GetCampaignsByAccountIdResponse

GetCampaignsByIds

Parameters: AccountId (long) CampaignIds (ArrayOflong)

Returns: GetCampaignsByIdsResponse

GetCampaignsInfoByAccountId

Parameters: AccountId (long)

Returns: GetCampaignsInfoByAccountIdResponse

GetCustomSegments

Parameters:

Returns: GetCustomSegmentsResponse

GetKeywordEstimatesByBids

Parameters: AccountId (long) LanguageAndRegion (string) Currency (string) KeywordBids (ArrayOfKeywordBid) PricingModel (PricingModel)

Returns: GetKeywordEstimatesByBidsResponse

GetKeywordQualityScoresByIds

Parameters: AdGroupId (long) KeywordIds (ArrayOflong)

Returns: GetKeywordQualityScoresByIdsResponse

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

GetPlacementDetailsForUrls

Parameters: Urls (ArrayOfstring)

Returns: GetPlacementDetailsForUrlsResponse

GetSegments

Parameters:

Returns: GetSegmentsResponse

GetSegmentsByIds

Parameters: SegmentIds (ArrayOflong)

Returns: GetSegmentsByIdsResponse

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

PauseBehavioralBids

Parameters: AdGroupId (long) BehavioralBidIds (ArrayOflong)

Returns: PauseBehavioralBidsResponse

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

ResumeBehavioralBids

Parameters: AdGroupId (long) BehavioralBidIds (ArrayOflong)

Returns: ResumeBehavioralBidsResponse

ResumeCampaigns

Parameters: AccountId (long) CampaignIds (ArrayOflong)

Returns: ResumeCampaignsResponse

ResumeKeywords

Parameters: AdGroupId (long) KeywordIds (ArrayOflong)

Returns: ResumeKeywordsResponse

ResumeSitePlacements

Parameters: AdGroupId (long) SitePlacementIds (ArrayOflong)

Returns: ResumeSitePlacementsResponse

SetNegativeKeywordsToAdGroups

Parameters: CampaignId (long) AdGroupNegativeKeywords (ArrayOfAdGroupNegativeKeywords)

Returns: SetNegativeKeywordsToAdGroupsResponse

SetNegativeKeywordsToCampaigns

Parameters: AccountId (long) CampaignNegativeKeywords (ArrayOfCampaignNegativeKeywords)

Returns: SetNegativeKeywordsToCampaignsResponse

SetTargetToAdGroup

Parameters: AdGroupId (long) TargetId (long)

Returns: SetTargetToAdGroupResponse

SetTargetToCampaign

Parameters: CampaignId (long) TargetId (long)

Returns: SetTargetToCampaignResponse

SetUsersToSegments

Parameters: SegmentId (long) UserHash (ArrayOfbase64Binary)

Returns: SetUsersToSegmentsResponse

SubmitAdGroupForApproval

Parameters: AdGroupId (long)

Returns: SubmitAdGroupForApprovalResponse

UpdateAdGroups

Parameters: CampaignId (long) AdGroups (ArrayOfAdGroup)

Returns: UpdateAdGroupsResponse

UpdateAds

Parameters: AdGroupId (long) Ads (ArrayOfAd)

Returns: UpdateAdsResponse

UpdateBehavioralBids

Parameters: AdGroupId (long) BehavioralBids (ArrayOfBehavioralBid)

Returns: UpdateBehavioralBidsResponse

UpdateBusinesses

Parameters: Businesses (ArrayOfBusiness)

Returns: UpdateBusinessesResponse

UpdateCampaigns

Parameters: AccountId (long) Campaigns (ArrayOfCampaign)

Returns: UpdateCampaignsResponse

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