Export (0) Print
Expand All
Expand Minimize
1 out of 1 rated this helpful - Rate this topic

REST Templates

Campaign Management provides Representational State Transfer (REST) URI templates that you can use to manage campaigns, ad groups, ads, and keywords. For lists of related REST templates, see the following template groups.

You can also access the list of URI templates at https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementServiceREST.svc/help. For each template, the list includes the schema and example XML for the request and response.

Campaign REST Templates

You can use the following REST templates to manage campaigns.

Action

Campaign Template

Description

AddCampaigns

/customer/account/{AccountId}/campaign

Adds one or more campaigns to the specified account.

DeleteCampaigns

/customer/account/{AccountId}/campaign?$field=ids

Deletes one or more campaigns from the specified account.

DeleteTargetFromCampaign

/customer/account/campaign/{CampaignId}?$field=target

Deletes the target group from the specified campaign.

GetCampaignAdExtensions

/customer/account/{AccountId}/campaignAdExtensions?$field=campaignIds

Gets the campaign’s preferences for whether to include the business’ address and phone number in its text ads.

GetCampaignsByAccountId

/customer/account/{AccountId}/campaign

Gets all campaigns from the specified account.

GetCampaignsByIds

/customer/account/{AccountId}/campaign?$field=ids

Gets one or more campaigns from the specified account.

GetNegativeKeywordsByCampaignIds

/customer/account/{AccountId}/campaign?$field=negativeKeywords

Gets the negative keywords for the specified campaigns.

GetNegativeSitesByCampaignIds

/customer/account/{AccountId}/campaign?$field=negativeSites

Gets the negative site URLs for the specified campaigns.

PauseCampaigns

/customer/account/{AccountId}/campaign/status/pause

Pauses one or more campaigns in the specified account.

ResumeCampaigns

/customer/account/{AccountId}/campaign/status/resume

Resumes one or more campaigns in the specified account.

SetCampaignAdExtension

/customer/account/{AccountId}/campaignAdExtension

Sets the campaign’s preference for whether to include the business’ address and phone number in its text ads.

SetNegativeKeywordsToCampaigns

/customer/account/{AccountId}/campaign?$field=negativeKeywords

Adds negative keywords to the specified campaigns.

SetNegativeSitesToCampaigns

/customer/account/{AccountId}/campaign?$field=negativeSites

Adds negative site URLs to the specified campaigns.

SetTargetToCampaign

/customer/account/campaign/{CampaignId}?$field=target

Associates a target group with the specified campaign.

UpdateCampaigns

/customer/account/{AccountId}/campaign

Updates the details of the specified campaigns.

Ad Group REST Templates

You can use the following REST templates to manage ad groups.

Action

Ad Group Template

Description

AddAdGroups

/customer/account/campaign/{CampaignId}/adGroup

Adds one or more ad groups to the specified campaign.

AddSitePlacement

/customer/account/campaign/adGroup/{AdGroupId}/sitePlacement

Adds one or more site placements to the specified ad group.

DeleteAdGroups

/customer/account/campaign/{CampaignId}/adGroup?$field=ids

Deletes one or more ad groups from the specified campaign.

DeleteSitePlacements

/customer/account/campaign/adGroup/{AdGroupId}/sitePlacement?$field=ids

Deletes one or more site placements from the specified ad group.

DeleteTargetFromAdGroup

/customer/account/campaign/adGroup/{AdGroupId}?$field=target

Deletes the target group from the specified ad group.

GetAdGroupsByCampaignId

/customer/account/campaign/{CampaignId}/adGroup

Gets all ad groups from the specified campaign.

GetAdGroupsByIds

/customer/account/campaign/{CampaignId}/adGroup?$field=ids

Gets one or more ad groups from the specified campaign.

GetNegativeKeywordsByAdGroupIds

/customer/account/campaign/{CampaignId}/adGroup?$field=negativeKeywords

Gets the negative keywords for the specified ad groups.

GetNegativeSitesByAdGroupIds

/customer/account/campaign/{CampaignId}/adGroup?$field=negativeSites

Gets the negative site URLs for the specified ad groups.

GetSitePlacementsByAdGroupId

/customer/account/campaign/adGroup/{AdGroupId}/sitePlacement

Gets all site placements from the specified ad group.

GetSitePlacementsByIds

/customer/account/campaign/adGroup/{AdGroupId}/sitePlacement?$field=ids

Gets one or more site placements from the specified ad group.

PauseAdGroups

/customer/account/campaign/{CampaignId}/adGroup/status/pause

Pauses one or more ad groups in the specified campaign.

PauseSitePlacements

/customer/account/campaign/adGroup/{AdGroupId}/sitePlacement/status/pause

Pauses one or more site placements in the specified ad group.

ResumeAdGroups

/customer/account/campaign/{CampaignId}/adGroup/status/resume

Resumes one or more ad groups in the specified campaign.

ResumeSitePlacements

/customer/account/campaign/adGroup/{AdGroupId}/sitePlacement/status/resume

Resumes one or more site placements in the specified ad group.

SubmitAdGroupForApproval

/customer/account/campaign/adGroup/{AdGroupId}/status/active

Submits the specified ad group for review review .

SetNegativeKeywordsToAdGroups

/customer/account/campaign/{CampaignId}/adGroup?$field=negativeKeywords

Adds negative keywords to the specified ad groups.

SetNegativeSitesToAdGroups

/customer/account/campaign/{CampaignId}/adGroup?$field=negativeSites

Adds negative site URLs to the specified ad groups.

SetTargetToAdGroup

/customer/account/campaign/adGroup/{AdGroupId}?$field=target

Associates a target group with the specified ad group.

UpdateAdGroups

/customer/account/campaign/{CampaignId}/adGroup

Updates the details of the specified ad groups.

UpdateSitePlacements

/customer/account/campaign/adGroup/{AdGroupId}/sitePlacement

Updates the details of the specified site placements.

Keyword REST Templates

You can use the following REST templates to manage keywords.

Action

Keyword Template

Description

AddKeywords

/customer/account/campaign/adGroup/{AdGroupId}/keyword

Adds one or more keywords to the specified ad group.

DeleteKeywords

/customer/account/campaign/adGroup/{AdGroupId}/keyword?$field=ids

Deletes one or more keywords from the specified ad group.

GetKeywordEditorialReasonsByIds

/customer/account/{AccountId}/adgroup/keyword/EditorialReason?$field=ids

Gets the reasons of why the specified keywords failed editorial review.

GetKeywordsByEditorialStatus

/customer/account/campaign/adGroup/{AdGroupId}/keyword?$field=editorialstatus

Gets keywords with the specified review status from the specified ad group.

GetKeywordsByIds

/customer/account/campaign/adGroup/{AdGroupId}/keyword?$field=ids

Gets one or more keywords from the specified ad group.

GetNormalizedStrings

/normalizedString

Gets the normalized strings for one or more keywords.

PauseKeywords

/customer/account/campaign/adGroup/{AdGroupId}/keyword/status/pause

Pauses one or more keywords in the specified ad group.

ResumeKeywords

/customer/account/campaign/adGroup/{AdGroupId}/keyword/status/resume

Resumes one or more keywords in the specified ad group.

UpdateKeywords

/customer/account/campaign/adGroup/{AdGroupId}/keyword

Updates the details of the specified keywords.

Target REST Templates

You can use the following REST templates to manage targets.

Action

Target Template

Description

AddTargetToLibrary

/customer/target

Adds a target group to the target library.

DeleteTargetsFromLibrary

/customer/target?$field=ids

Deletes one or more target groups from the target library.

GetDeviceOSTargetsByIds

/customer/deviceOSTarget?$field=ids

Gets the devices that specified targets target.

GetTargetsByAdGroupIds

/customer/target?$field=adgroupids

Gets the target groups that the specified ad groups reference.

GetTargetsByCampaignIds

/customer/target?$field=campaignids

Gets the target groups that the specified campaigns reference.

GetTargetsByIds

/customer/target?$field=ids

Gets one or more target groups from the target library.

GetTargetsInfoFromLibrary

/customer/targetInfo

Gets a list of objects that contains target group identification information (for example, the name and identifier of the target group). To get the complete details of a target group in the list, use the Get Targets By IDs REST template.

UpdateDeviceOSTargets

/customer/deviceOSTarget

Updates the devices that specified targets target.

UpdateTargetsInLibrary

/customer/target

Updates the details of the specified target groups.

Business REST Templates

You can use the following REST templates to manage businesses.

Action

Businesses Template

Description

AddBusinesses

/customer/business

Adds one or more businesses.

DeleteBusinesses

/customer/business?$field=ids

Deletes one or more businesses.

GetBusinessesByIds

/customer/business?$field=ids

Gets one or more businesses.

GetBusinessesInfo

/customer/businessInfo

Gets a list of objects that contains business identification information (for example, the name and identifier of the business). To get the complete details of a business in the list, use the Get Businesses By IDs REST template.

UpdateBusinesses

/customer/business

Updates the details of the specified businesses.

Miscellaneous REST Templates

The following are miscellaneous REST templates.

Action

Miscellaneous Template

Description

GetPlacementDetailsForUrls

/placementDetail

Gets the placement details for the specified URLs.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.