Bing Ads Connection

Overview
Quick Start
Configuration
Knowledge Base
What's New

Overview

Bing Ads Connection

Configuration is provided for establishing connections with Bing Ads service. The configuration is used in the REST Connection Manager.

Setup

Press icon to get more information about the connection parameters.

Obtain data

Use REST Source component to get data from service resource.

Insert data

Use REST Destination component to insert data into service resource.

Quick Start

OAuth Setup

No votes yet

In order to obtain an access token for the Bing Ads SOAP API, you will need your CustomerAccountId, CustomerId and DeveloperToken.

DISCLAIMER: This is not official documentation. For the official Microsoft documentation click here.

Step 1. Log in to your Microsoft Advertising account, you can access the login page here.

Step 2. After logging in while on the index page, take note of the url, it should look something like this:
https://ui.ads.microsoft.com/campaign/vnext/overview?aid=1143245&cid=643312134&uid=7554232

Your CustomerAccountId is the aid query parameter from the url e.g. aid=1143245

Your CustomerId is the cid query parameter from the url e.g. cid=643312134

You can use them to establish a connection.

Step 3. Get your developer token by logging in here as a Super Admin. If you did step 1 and 2 you should be logged in and the developer interface should be already in front of you.

Official documentation

Establish connection

No votes yet

In this task, we will show you step-by-step how to create a connection to Bing Ads SOAP API using COZYROC's REST Connection Manager.

Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.

Step 2. From drop-down menu Configuration select Bing Ads. Then click New in the Token File parameter to create a new token file.

Step 3: Provide Email or Mobile Number and hit Next button.

Step 4: Save generated access token. Specify token protection password. Click OK.

Step 5. Click "Test Connection" to test your connection.

Congratulations! You have now established a connection to your Bing Ads instance.

Consume data from service

No votes yet

In this guide, we will show how to read data from the Bing Ads service resource using the COZYROC REST Source component.

Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".

Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.

Step 3. Double click on the "REST Source" component and select Bing Ads connection from the combo. Select from available Bing Ads resources listed in the second combo below.

Step 4. Edit the default JSON body or paste your own, the body corresponds to the structure of the XML body shown in the documentation. Attributes are used as child nodes with key beginning with the "@" symbol, e.g. "@xsi:type" : "Attribute Value". And arrays are used as JSON arrays e.g. "a1:long": ["Value1", "Value2", "Value3"]

Step 4. Click on the "Columns" tab and select the Bing Ads columns you want to read.

Bravo! You have now learned how to read data from the Bing Ads API service.

Push data to service

No votes yet

In this guide, we will show you how to write data to the Bing Ads API service resource using the COZYROC REST Destination component.

Step 1. Select an existing or create a new "Data Flow Task".

Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.

Step 3. Double click on the "REST Destination" component and select the Bing Ads connection from the list. After that select the action you will be performing with your data and select the target Resource.

Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.

Done. You have now learned how to write data into the Bing Ads API resource.

Contribute

Configuration

Service

Base URL address: https://clientcenter.api.bingads.microsoft.com/Api.

Authentication

OAuth 2

The authentication uses an authorized token. The token will be refreshed with the following expression: {{=Date.now() + (response.expires_in - 299) * 1000}}.

The authentication has the following user-defined parameters:

CustomerAccountId: Required. Specify CustomerAccountId, can be extracted from the URL parameters in the landing page, e.g. aid=276543743.
CustomerId: Required. Specify CustomerId, can be extracted from the URL parameters in the landing page, e.g. cid=605445710.
DeveloperToken: Required. Specify Developer Token, documentation can be found here: https://learn.microsoft.com/en-us/advertising/guides/get-started#get-developer-token.

The following request parameters will be automatically processed during the authentication process:

text/xml: {{=BingAds.getXmlPayload(request, token)}}

Documentation: https://learn.microsoft.com/en-us/advertising/guides/authentication-oauth.

Resources

Ad Extension

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=[BingAds.sendRequest( resource, 'GetAdExtensionsByIds', { AccountId: parameters.AccountId, AdExtensionIds: BingAds.getArrayValue(response.Envelope.Body.GetAdExtensionIdsByAccountIdResponse.AdExtensionIds.long, 'long'), AdExtensionType: parameters.AdExtensionType }).GetAdExtensionsByIdsResponse.AdExtensions.AdExtension]}}.

The action has the following user-defined parameters:

AccountId: Required.
AdExtensionType: Required.
AssociationType: Optional.

The following request parameters will be automatically processed:

soapAction: GetAdExtensionIdsByAccountId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getadextensionidsbyaccountid.

[Create] action

Endpoint URL address: /.
The result is extracted from: {{=utils.ensureArray(response)}}.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: AddAdExtensions
text/xml: {{=BingAds.getActionPayload('AdExtension', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addadextensions.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: UpdateAdExtensions
text/xml: {{=BingAds.getActionPayload('AdExtension', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateadextensions.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: DeleteAdExtensions
text/xml: {{=BingAds.getDeletePayload('AdExtensionIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteadextensions.

The resource includes the fields from the AdExtension template.

Ad Group Criterion

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetAdGroupCriterionsByIdsResponse.AdGroupCriterions.AdGroupCriterion')}}.

The action has the following user-defined parameters:

AdGroupCriterionIds: Optional.
AdGroupId: Required.
CriterionType: Required.
ReturnAdditionalFields:

The following request parameters will be automatically processed:

soapAction: GetAdGroupCriterionsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getadgroupcriterionsbyids.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CriterionType: Required.

The following request parameters will be automatically processed:

soapAction: AddAdGroupCriterions
text/xml: {{=BingAds.getActionPayload('AdGroupCriterion', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addadgroupcriterions.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CriterionType: Required.

The following request parameters will be automatically processed:

soapAction: UpdateAdGroupCriterions
text/xml: {{=BingAds.getActionPayload('AdGroupCriterion', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateadgroupcriterions.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AdGroupId: Required.
CriterionType: Required.

The following request parameters will be automatically processed:

soapAction: DeleteAdGroupCriterions
text/xml: {{=BingAds.getDeletePayload('AdGroupCriterionIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteadgroupcriterions.

The resource includes the fields from the AdGroupCriterion template.

Ad Group

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetAdGroupsByCampaignIdResponse.AdGroups.AdGroup')}}.

The action has the following user-defined parameters:

CampaignId: Required.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetAdGroupsByCampaignId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getadgroupsbycampaignid.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: AddAdGroups
text/xml: {{=BingAds.getActionPayload('AdGroup', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addadgroups.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: UpdateAdGroups
text/xml: {{=BingAds.getActionPayload('AdGroup', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateadgroups.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: DeleteAdGroups
text/xml: {{=BingAds.getDeletePayload('AdGroupIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteadgroups.

The resource includes the fields from the AdGroup template.

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetAdsByAdGroupIdResponse.Ads.Ad')}}.

The action has the following user-defined parameters:

AdGroupId: Required.
AdTypes: Required.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetAdsByAdGroupId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getadsbyadgroupid.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AdGroupId: Required.

The following request parameters will be automatically processed:

soapAction: AddAds
text/xml: {{=BingAds.getActionPayload('Ad', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addads.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AdGroupId: Required.

The following request parameters will be automatically processed:

soapAction: UpdateAds
text/xml: {{=BingAds.getActionPayload('Ad', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateads.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AdGroupId: Required.

The following request parameters will be automatically processed:

soapAction: DeleteAds
text/xml: {{=BingAds.getDeletePayload('AdIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteads.

The resource includes the fields from the Ad template.

Asset Group

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetAssetGroupsByCampaignIdResponse.AssetGroups.AssetGroup')}}.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: GetAssetGroupsByCampaignId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getassetgroupsbycampaignid.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: AddAssetGroups
text/xml: {{=BingAds.getActionPayload('AssetGroup', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addassetgroups.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: UpdateAssetGroups
text/xml: {{=BingAds.getActionPayload('AssetGroup', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateassetgroups.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: DeleteAssetGroups
text/xml: {{=BingAds.getDeletePayload('AssetGroupIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteassetgroups.

The resource includes the fields from the AssetGroup template.

Audience Group

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetAudienceGroupsByIdsResponse.AudienceGroups.AudienceGroup')}}.

The action has the following user-defined parameters:

AudienceGroupIds: Optional.

The following request parameters will be automatically processed:

soapAction: GetAudienceGroupsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getaudiencegroupsbyids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddAudienceGroups
text/xml: {{=BingAds.getActionPayload('AudienceGroup', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addaudiencegroups.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateAudienceGroups
text/xml: {{=BingAds.getActionPayload('AudienceGroup', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateaudiencegroups.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DeleteAudienceGroups
text/xml: {{=BingAds.getDeletePayload('AudienceGroupIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteaudiencegroups.

The resource includes the fields from the AudienceGroup template.

Audience

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetAudiencesByIdsResponse.Audiences.Audience')}}.

The action has the following user-defined parameters:

AudienceIds: Optional.
Type: Required.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetAudiencesByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getaudiencesbyids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddAudiences
text/xml: {{=BingAds.getActionPayload('Audience', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addaudiences.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateAudiences
text/xml: {{=BingAds.getActionPayload('Audience', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateaudiences.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DeleteAudiences
text/xml: {{=BingAds.getDeletePayload('AudienceIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteaudiences.

The resource includes the fields from the Audience template.

Bid Strategy

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetBidStrategiesByIdsResponse.BidStrategies.BidStrategy')}}.

The action has the following user-defined parameters:

BidStrategyIds: Optional.

The following request parameters will be automatically processed:

soapAction: GetBidStrategiesByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getbidstrategiesbyids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddBidStrategies
text/xml: {{=BingAds.getActionPayload('BidStrategy', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addbidstrategies.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateBidStrategies
text/xml: {{=BingAds.getActionPayload('BidStrategy', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updatebidstrategies.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DeleteBidStrategies
text/xml: {{=BingAds.getDeletePayload('BidStrategyIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletebidstrategies.

The resource includes the fields from the BidStrategy template.

Budget

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetBudgetsByIdsResponse.Budgets.Budget')}}.

The action has the following user-defined parameters:

BudgetIds: Optional.

The following request parameters will be automatically processed:

soapAction: GetBudgetsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getbudgetsbyids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddBudgets
text/xml: {{=BingAds.getActionPayload('Budget', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addbudgets.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateBudgets
text/xml: {{=BingAds.getActionPayload('Budget', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updatebudgets.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DeleteBudgets
text/xml: {{=BingAds.getDeletePayload('BudgetIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletebudgets.

The resource includes the fields from the Budget template.

Campaign Conversion Goal

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddCampaignConversionGoals
text/xml: {{={ CampaignConversionGoal: _.map(batch, function(item) { return { CampaignConversionGoal: item } }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addcampaignconversiongoals.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DeleteCampaignConversionGoals
text/xml: {{={ CampaignConversionGoal: _.map(batch, function(item) { return { CampaignConversionGoal: item } }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletecampaignconversiongoals.

The resource includes the fields from the CampaignConversionGoal template.

Campaign

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetCampaignsByAccountIdResponse.Campaigns.Campaign')}}.

The action has the following user-defined parameters:

AccountId: Required.
CampaignType: Optional.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetCampaignsByAccountId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getcampaignsbyaccountid.

[Read ids] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetCampaignsByIdsResponse.Campaigns.Campaign')}}.

The action has the following user-defined parameters:

AccountId: Required.
CampaignIds: Required.
CampaignType: Optional.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetCampaignsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getcampaignsbyids.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: AddCampaigns
text/xml: {{=BingAds.getActionPayload('Campaign', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addcampaigns.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: UpdateCampaigns
text/xml: {{=BingAds.getActionPayload('Campaign', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updatecampaigns.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: DeleteCampaigns
text/xml: {{=BingAds.getDeletePayload('CampaignIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletecampaigns.

The resource includes the fields from the Campaign template.

Conversion Goal

Based on resource template CampaignManagementBase.

[Read ids] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetConversionGoalsByIdsResponse.ConversionGoals.ConversionGoal')}}.

The action has the following user-defined parameters:

ConversionGoalIds: Optional.
ConversionGoalTypes: Required.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetConversionGoalsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getconversiongoalsbyids.

[Read tag] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetConversionGoalsByTagIdsResponse.ConversionGoals.ConversionGoal')}}.

The action has the following user-defined parameters:

TagIds: Required.
ConversionGoalTypes: Required.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetConversionGoalsByTagIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getconversiongoalsbytagids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddConversionGoals
text/xml: {{=BingAds.getActionPayload('ConversionGoal', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addconversiongoals.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateConversionGoals
text/xml: {{=BingAds.getActionPayload('ConversionGoal', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateconversiongoals.

The resource includes the fields from the ConversionGoal template.

Data Exclusion

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetDataExclusionsByAccountIdResponse.DataExclusions.DataExclusion')}}.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: GetDataExclusionsByAccountId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getdataexclusionsbyaccountid.

[Read ids] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetDataExclusionsByIdsResponse.DataExclusions.DataExclusion')}}.

The action has the following user-defined parameters:

AccountId: Required.
DataExclusionIds: Required.

The following request parameters will be automatically processed:

soapAction: GetDataExclusionsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getdataexclusionsbyids.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: AddDataExclusions
text/xml: {{=BingAds.getActionPayload('DataExclusion', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/adddataexclusions.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: UpdateDataExclusions
text/xml: {{=BingAds.getActionPayload('DataExclusion', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updatedataexclusions.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: DeleteDataExclusions
text/xml: {{=BingAds.getDeletePayload('DataExclusionIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletedataexclusions.

The resource includes the fields from the DataExclusion template.

Experiment

Based on resource template Pagination.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetExperimentsByIdsResponse.Experiments.Experiment')}}.
The result is paginated.

The action has the following user-defined parameters:

ExperimentIds: Required.

The following request parameters will be automatically processed:

soapAction: GetExperimentsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getexperimentsbyids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddExperiments
text/xml: {{=BingAds.getActionPayload('Experiment', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addexperiments.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateExperiments
text/xml: {{=BingAds.getActionPayload('Experiment', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateexperiments.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DeleteExperiments
text/xml: {{=BingAds.getDeletePayload('ExperimentIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteexperiments.

The resource includes the fields from the Experiment template.

Import job

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetImportJobsByIdsResponse.ImportJobs.ImportJob')}}.

The action has the following user-defined parameters:

ImportJobIds: Required.
ImportType: Required.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetImportJobsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getimportjobsbyids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddImportJobs
text/xml: {{=BingAds.getActionPayload('ImportJob', [item], parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addimportjobs.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateImportJobs
text/xml: {{=BingAds.getActionPayload('ImportJob', [item], parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateimportjobs.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

ImportType: Required.

The following request parameters will be automatically processed:

soapAction: DeleteImportJobs
text/xml: {{=BingAds.getDeletePayload('ImportJobIds', [item], parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteimportjobs.

The resource includes the fields from the ImportJob template.

Keyword

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetKeywordsByAdGroupIdResponse.Keywords.Keyword')}}.

The action has the following user-defined parameters:

AdGroupId: Required.

The following request parameters will be automatically processed:

soapAction: GetKeywordsByAdGroupId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getkeywordsbyadgroupid.

[Read ids] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetKeywordsByIdsResponse.Keywords.Keyword')}}.

The action has the following user-defined parameters:

AdGroupId: Required.
KeywordIds: Required.

The following request parameters will be automatically processed:

soapAction: GetKeywordsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getkeywordsbyids.

[Read status] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetKeywordsByEditorialStatusResponse.Keywords.Keyword')}}.

The action has the following user-defined parameters:

AdGroupId: Required.
EditorialStatus: Required.

The following request parameters will be automatically processed:

soapAction: GetKeywordsByEditorialStatus

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getkeywordsbyeditorialstatus.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AdGroupId: Required.

The following request parameters will be automatically processed:

soapAction: AddKeywords
text/xml: {{=BingAds.getActionPayload('Keyword', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addkeywords.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AdGroupId: Required.

The following request parameters will be automatically processed:

soapAction: UpdateKeywords
text/xml: {{=BingAds.getActionPayload('Keyword', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updatekeywords.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AdGroupId: Required.

The following request parameters will be automatically processed:

soapAction: DeleteKeywords
text/xml: {{=BingAds.getDeletePayload('KeywordIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletekeywords.

The resource includes the fields from the Keyword template.

Label

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetLabelsByIdsResponse.Labels.Label')}}.
The result is paginated.

The action has the following user-defined parameters:

LabelIds: Required.

The following request parameters will be automatically processed:

soapAction: GetLabelsByIds
text/xml: {{=BingAds.getPaginatedParams(parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getlabelsbyids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddLabels
text/xml: {{=BingAds.getActionPayload('Label', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addlabels.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateLabels
text/xml: {{=BingAds.getActionPayload('Label', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updatelabels.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DeleteLabels
text/xml: {{=BingAds.getDeletePayload('LabelIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletelabels.

The resource includes the fields from the Label template.

List Items To Shared List

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetListItemsBySharedListResponse.ListItems.SharedListItem')}}.

The action has the following user-defined parameters:

SharedList: Required.
SharedEntityScope: Required.

The following request parameters will be automatically processed:

soapAction: GetListItemsBySharedList

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getlistitemsbysharedlist.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

SharedEntityScope: Required.
SharedList: Required.

The following request parameters will be automatically processed:

soapAction: AddListItemsToSharedList
text/xml: {{=_.extend({ ListItems: _.map(batch, function(item) { return { SharedListItem: item } }) }, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addlistitemstosharedlist.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

SharedEntityScope: Required.
SharedList: Required.

The following request parameters will be automatically processed:

soapAction: DeleteListItemsFromSharedList
text/xml: {{=BingAds.getDeletePayload('ListItemIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletelistitemsfromsharedlist.

The resource includes the fields from the SharedListItem template.

Media

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: AddMedia
text/xml: {{=_.extend({ Media: _.map(batch, function(item) { return { Media: item } }) }, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addmedia.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: DeleteMedia
text/xml: {{=BingAds.getDeletePayload('MediaIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletemedia.

The resource includes the fields from the Media template.

Negative Keywords To Entities

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetNegativeKeywordsByEntityIdsResponse.EntityNegativeKeywords.EntityNegativeKeyword')}}.

The action has the following user-defined parameters:

EntityIds: Required.
EntityType: Required.
ParentEntityId: Required.

The following request parameters will be automatically processed:

soapAction: GetNegativeKeywordsByEntityIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getnegativekeywordsbyentityids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddNegativeKeywordsToEntities
text/xml: {{=BingAds.getActionPayload('EntityNegativeKeyword', [item], parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addnegativekeywordstoentities.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DeleteNegativeKeywordsFromEntities
text/xml: {{=BingAds.getActionPayload('EntityNegativeKeyword', [item], parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletenegativekeywordsfromentities.

The resource includes the fields from the EntityNegativeKeyword template.

Seasonality Adjustment

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetSeasonalityAdjustmentsByAccountIdResponse.SeasonalityAdjustments.SeasonalityAdjustment')}}.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: GetSeasonalityAdjustmentsByAccountId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getseasonalityadjustmentsbyaccountid.

[Read ids] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetSeasonalityAdjustmentsByIdsResponse.SeasonalityAdjustments.SeasonalityAdjustment')}}.

The action has the following user-defined parameters:

AccountId: Required.
SeasonalityAdjustmentIds: Required.

The following request parameters will be automatically processed:

soapAction: GetSeasonalityAdjustmentsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getseasonalityadjustmentsbyids.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: AddSeasonalityAdjustments
text/xml: {{=BingAds.getActionPayload('SeasonalityAdjustment', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addseasonalityadjustments.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: UpdateSeasonalityAdjustments
text/xml: {{=BingAds.getActionPayload('SeasonalityAdjustment', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateseasonalityadjustments.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: DeleteSeasonalityAdjustments
text/xml: {{=BingAds.getDeletePayload('SeasonalityAdjustmentIds', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteseasonalityadjustments.

The resource includes the fields from the SeasonalityAdjustment template.

Shared Entity

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetSharedEntitiesByAccountIdResponse.SharedEntities.SharedEntity')}}.

The action has the following user-defined parameters:

SharedEntityType: Required.

The following request parameters will be automatically processed:

soapAction: GetSharedEntitiesByAccountId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getsharedentitiesbyaccountid.

[Read type/scope] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetSharedEntitiesResponse.SharedEntities.SharedEntity')}}.

The action has the following user-defined parameters:

SharedEntityType: Required.
SharedEntityScope: Required.

The following request parameters will be automatically processed:

soapAction: GetSharedEntities

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getsharedentities.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

SharedEntityScope: Required.

The following request parameters will be automatically processed:

soapAction: AddSharedEntity
text/xml: {{={ ListItems: _.map(batch, function(item) { return { SharedListItem: item } }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addsharedentity.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

SharedEntityScope: Required.

The following request parameters will be automatically processed:

soapAction: UpdateSharedEntities
text/xml: {{=BingAds.getActionPayload('SharedEntity', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updatesharedentities.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

SharedEntityScope: Required.

The following request parameters will be automatically processed:

soapAction: DeleteSharedEntities
text/xml: {{=BingAds.getActionPayload('SharedEntity', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletesharedentities.

The resource includes the fields from the SharedEntityListItems template.

Uet Tag

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetUetTagsByIdsResponse.UetTags.UetTag')}}.

The action has the following user-defined parameters:

TagIds: Required.

The following request parameters will be automatically processed:

soapAction: GetUetTagsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getuettagsbyids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddUetTags
text/xml: {{=BingAds.getActionPayload('SeasonalityAdjustment', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/adduettags.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateUetTags
text/xml: {{=BingAds.getActionPayload('SeasonalityAdjustment', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updateuettags.

The resource includes the fields from the UetTag template.

Video

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetVideosByIdsResponse.Videos.Video')}}.
The result is paginated.

The action has the following user-defined parameters:

VideoIds: Required.

The following request parameters will be automatically processed:

soapAction: GetVideosByIds
text/xml: {{=BingAds.getPaginatedParams(parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getvideosbyids.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddVideos
text/xml: {{=BingAds.getActionPayload('Video', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addvideos.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateVideos
text/xml: {{=BingAds.getActionPayload('Video', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updatevideos.

The resource includes the fields from the Video template.

Appeal Editorial Rejection

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AppealEditorialRejections
text/xml: {{=BingAds.getActionPayload('EntityIdToParentIdAssociation', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/appealeditorialrejections.

Fields

EntityIdToParentIdAssociations: Template: ArrayOfEntityIdToParentIdAssociation.
EntityType: Template: EntityType.
JustificationText: Template: ShortText.

Asset Group Listing Group Action

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: ApplyAssetGroupListingGroupActions
text/xml: {{={ ListingGroupActions: _.map(batch, function(item) { return { AssetGroupListingGroupAction: item } }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/applyassetgrouplistinggroupactions.

The resource includes the fields from the AssetGroupListingGroupAction template.

Asset Group Listing Group

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetAssetGroupListingGroupsByIdsResponse.AssetGroupListingGroups.AssetGroupListingGroup')}}.

The action has the following user-defined parameters:

AssetGroupId: Required.
AssetGroupListingGroupIds: Required.

The following request parameters will be automatically processed:

soapAction: GetAssetGroupListingGroupsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getassetgrouplistinggroupsbyids.

The resource includes the fields from the AssetGroupListingGroup template.

Apply Customer List User Data

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: ApplyCustomerListUserData
text/xml: {{={ CustomerListUserData: item } }}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/applycustomerlistuserdata.

The resource includes the fields from the CustomerListUserData template.

Apply Hotel Group Action

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: ApplyHotelGroupActions
text/xml: {{={ CriterionActions: _.map(batch, function(item) { return { AdGroupCriterionAction: item } }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/applyhotelgroupactions.

The resource includes the fields from the AdGroupCriterionAction template.

Apply Offline Conversion Adjustment

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: ApplyOfflineConversionAdjustments
text/xml: {{=BingAds.getActionPayload('OfflineConversionAdjustment', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/applyofflineconversionadjustments.

The resource includes the fields from the OfflineConversionAdjustment template.

Apply Offline Conversion

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: ApplyOfflineConversions
text/xml: {{=BingAds.getActionPayload('OfflineConversion', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/applyofflineconversions.

The resource includes the fields from the OfflineConversion template.

Apply Product Partition Action

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: ApplyProductPartitionActions
text/xml: {{={ CriterionActions: _.map(batch, function(item) { return { AdGroupCriterionAction: item } }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/applyproductpartitionactions.

The resource includes the fields from the AdGroupCriterionAction template.

Ad Extensions Association

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetAdExtensionsAssociationsResponse.AdExtensionAssociationCollection.AdExtensionAssociationCollection.AdExtensionAssociation')}}.

The action has the following user-defined parameters:

AccountId: Required.
AdExtensionType: Required.
AssociationType: Required.
EntityIds: Required.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetAdExtensionsAssociations

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getadextensionsassociations.

The resource includes the fields from the AdExtensionAssociation template.

Ad Extensions Associations Operation

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: SetAdExtensionsAssociations
text/xml: {{=BingAds.getActionPayload('AdExtensionIdToEntityIdAssociation', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/setadextensionsassociations.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: DeleteAdExtensionsAssociations
text/xml: {{=BingAds.getActionPayload('AdExtensionIdToEntityIdAssociation', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteadextensionsassociations.

The resource includes the fields from the AdExtensionIdToEntityIdAssociation template.

Audience Group Asset Group Association

Based on resource template CampaignManagementBase.

[Read asset] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetAudienceGroupAssetGroupAssociationsByAssetGroupIdsResponse.AudienceGroupAssetGroupAssociations.AudienceGroupAssetGroupAssociation')}}.

The action has the following user-defined parameters:

AssetGroupIds: Required.

The following request parameters will be automatically processed:

soapAction: GetAudienceGroupAssetGroupAssociationsByAssetGroupIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getaudiencegroupassetgroupassociationsbyassetgroupids.

[Read audience] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetAudienceGroupAssetGroupAssociationsByAudienceGroupIdsResponse.AudienceGroupAssetGroupAssociations.AudienceGroupAssetGroupAssociation')}}.

The action has the following user-defined parameters:

AudienceGroupIds: Required.

The following request parameters will be automatically processed:

soapAction: GetAudienceGroupAssetGroupAssociationsByAudienceGroupIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getaudiencegroupassetgroupassociationsbyaudiencegroupids.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: SetAudienceGroupAssetGroupAssociations
text/xml: {{=BingAds.getActionPayload('AudienceGroupAssetGroupAssociation', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/setaudiencegroupassetgroupassociations.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DeleteAudienceGroupAssetGroupAssociations
text/xml: {{=BingAds.getActionPayload('AudienceGroupAssetGroupAssociation', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deleteaudiencegroupassetgroupassociations.

The resource includes the fields from the AudienceGroupAssetGroupAssociation template.

Label Association

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetLabelAssociationsByEntityIdsResponse.LabelAssociations.LabelAssociation')}}.

The action has the following user-defined parameters:

EntityIds: Required.
EntityType: Required.

The following request parameters will be automatically processed:

soapAction: GetLabelAssociationsByEntityIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getlabelassociationsbyentityids.

[Read ids] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetLabelAssociationsByLabelIdsResponse.LabelAssociations.LabelAssociation')}}.
The result is paginated.

The action has the following user-defined parameters:

EntityType: Required.
LabelIds: Required.

The following request parameters will be automatically processed:

soapAction: GetLabelAssociationsByLabelIds
text/xml: {{=BingAds.getPaginatedParams(parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getlabelassociationsbylabelids.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

EntityType: Required.

The following request parameters will be automatically processed:

soapAction: SetLabelAssociations
text/xml: {{=BingAds.getActionPayload('LabelAssociation', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/setlabelassociations.

[Delete] action

Endpoint URL address: /.

The action has the following user-defined parameters:

EntityType: Required.

The following request parameters will be automatically processed:

soapAction: DeleteLabelAssociations
text/xml: {{=BingAds.getActionPayload('LabelAssociation', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletelabelassociations.

The resource includes the fields from the LabelAssociation template.

Shared Entity Association

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetSharedEntityAssociationsByEntityIdsResponse.Associations.SharedEntityAssociation')}}.

The action has the following user-defined parameters:

EntityIds:
EntityType:
SharedEntityType:
SharedEntityScope:

The following request parameters will be automatically processed:

soapAction: GetSharedEntityAssociationsByEntityIds

[Read shared entity] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetSharedEntityAssociationsBySharedEntityIdsResponse.Associations.SharedEntityAssociation')}}.

The action has the following user-defined parameters:

EntityType: Required.
SharedEntityIds: Required.
SharedEntityType: Required.
SharedEntityScope: Required.

The following request parameters will be automatically processed:

soapAction: GetSharedEntityAssociationsBySharedEntityIds

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: SetSharedEntityAssociations
text/xml: {{={ Associations: _.map(batch, function(item) { return { SharedEntityAssociation: item } }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/setsharedentityassociations.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DeleteSharedEntityAssociations
text/xml: {{={ Associations: _.map(batch, function(item) { return { SharedEntityAssociation: item } }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/deletesharedentityassociations.

The resource includes the fields from the SharedEntityAssociation template.

Account Migration Status

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetAccountMigrationStatusesResponse.MigrationStatuses.AccountMigrationStatusesInfo')}}.

The action has the following user-defined parameters:

AccountIds: Required.
MigrationType: Optional.

The following request parameters will be automatically processed:

soapAction: GetAccountMigrationStatuses

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getaccountmigrationstatuses.

The resource includes the fields from the AccountMigrationStatusesInfo template.

Account Property

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetAccountPropertiesResponse.AccountProperties.AccountProperty')}}.

The action has the following user-defined parameters:

GetAccountPropertiesRequest: Required.

The following request parameters will be automatically processed:

soapAction: GetAccountProperties

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getaccountproperties.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: SetAccountProperties
text/xml: {{=BingAds.getActionPayload('AccountProperty', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/setaccountproperties.

The resource includes the fields from the AccountProperty template.

BMC Store

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetBMCStoresByCustomerIdResponse.BMCStores.BMCStore')}}.

The action has the following user-defined parameters:

ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetBMCStoresByCustomerId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getbmcstoresbycustomerid.

The resource includes the fields from the BMCStore template.

BSC Country

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=response.Envelope.Body.GetBSCCountriesResponse.CountryCodes[`a:string`]}}.

The following request parameters will be automatically processed:

soapAction: GetBSCCountries

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getbsccountries.

Fields

_@ttribute: Template: ShortText.

Campaign Criterion

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetCampaignCriterionsByIdsResponse.CampaignCriterions.CampaignCriterion')}}.

The action has the following user-defined parameters:

CampaignCriterionIds: Required.
CampaignId: Required.
CriterionType: Required.
ReturnAdditionalFields: Required.

The following request parameters will be automatically processed:

soapAction: GetCampaignCriterionsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getcampaigncriterionsbyids.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CriterionType: Required.

The following request parameters will be automatically processed:

soapAction: AddCampaignCriterions
text/xml: {{=BingAds.getActionPayload('CampaignCriterion', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addcampaigncriterions.

[Update] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CriterionType: Required.

The following request parameters will be automatically processed:

soapAction: UpdateCampaignCriterions
text/xml: {{=BingAds.getActionPayload('CampaignCriterion', batch, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/updatecampaigncriterions.

The resource includes the fields from the CampaignCriterion template.

Campaign Id

Based on resource template CampaignManagementBase.

[Read bid strategy] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetCampaignIdsByBidStrategyIdsResponse.CampaignIdCollection.IdCollection')}}.

The action has the following user-defined parameters:

BidStrategyIds: Required.

The following request parameters will be automatically processed:

soapAction: GetCampaignIdsByBidStrategyIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getcampaignidsbybidstrategyids.

[Read budget] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetCampaignIdsByBudgetIdsResponse.CampaignIdCollection.IdCollection')}}.

The action has the following user-defined parameters:

BudgetIds: Required.

The following request parameters will be automatically processed:

soapAction: GetCampaignIdsByBudgetIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getcampaignidsbybudgetids.

The resource includes the fields from the IdCollection template.

Editorial Reason

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetEditorialReasonsByIdsResponse.EditorialReasons.EditorialReasonCollection')}}.

The action has the following user-defined parameters:

AccountId: Required.
EntityIdToParentIdAssociations: Required.
EntityType: Required.

The following request parameters will be automatically processed:

soapAction: GetEditorialReasonsByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/geteditorialreasonsbyids.

The resource includes the fields from the EditorialReasonCollection template.

File Import Upload Url

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetFileImportUploadUrlResponse')}}.

The following request parameters will be automatically processed:

soapAction: GetFileImportUploadUrl

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getfileimportuploadurl.

Fields

FileImportUploadUrl: Template: ShortText.

Geo Locations File Url

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetGeoLocationsFileUrlResponse')}}.

The action has the following user-defined parameters:

CompressionType: Optional.
LanguageLocale: Required.
Version: Required.

The following request parameters will be automatically processed:

soapAction: GetGeoLocationsFileUrl

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getgeolocationsfileurl.

Fields

FileUrl: Template: ShortText.
FileUrlExpiryTimeUtc: Template: DateTime.
LastModifiedTimeUtc: Template: DateTime.

Import Entity Ids Mapping

Based on resource template CampaignManagementBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetImportEntityIdsMappingResponse.EntityIdsMapping.KeyValuePairOflonglong')}}.

The action has the following user-defined parameters:

ImportType: Required.
SourceEntityIds: Required.
ImportEntityType: Required.
SourceParentId: Optional.

The following request parameters will be automatically processed:

soapAction: GetImportEntityIdsMapping

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getimportentityidsmapping.

The resource includes the fields from the KeyValuePairOflonglong template.

Import Result

Based on resource template Pagination.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetImportResultsResponse.ImportResults.ImportResult')}}.
The result is paginated.

The action has the following user-defined parameters:

ImportType: Required.
ImportJobIds: Required.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetImportResults

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getimportresults.

The resource includes the fields from the ImportResult template.

Media Association

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetMediaAssociationsResponse.MediaAssociations.ArrayOfMediaAssociation')}}.

The action has the following user-defined parameters:

GetMediaAssociationsRequest: Required.

The following request parameters will be automatically processed:

soapAction: GetMediaAssociations

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getmediaassociations.

The resource includes the fields from the ArrayOfMediaAssociation template.

Media MetaData

Based on resource template Pagination.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetMediaMetaDataByAccountIdResponse.MediaMetaData.MediaMetaData')}}.
The result is paginated.

The action has the following user-defined parameters:

GetMediaMetaDataByAccountIdRequest: Required.

The following request parameters will be automatically processed:

soapAction: GetMediaMetaDataByAccountId

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getmediametadatabyaccountid.

[Read ids] action

The result is extracted from: {{=SOAP.getData(response, 'GetMediaMetaDataByIdsResponse.MediaMetaData.MediaMetaData')}}.

The action has the following user-defined parameters:

GetMediaMetaDataByIdsRequest: Required.

The following request parameters will be automatically processed:

soapAction: GetMediaMetaDataByIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getmediametadatabyids.

The resource includes the fields from the MediaMetaData template.

Negative Site

Based on resource template CampaignManagementBase.

[Read ad group] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetNegativeSitesByAdGroupIdsResponse.AdGroupNegativeSites.AdGroupNegativeSites')}}.

The action has the following user-defined parameters:

CampaignId: Required.
AdGroupIds: Required.

The following request parameters will be automatically processed:

soapAction: GetNegativeSitesByAdGroupIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getprofiledatafileurl.

[Read campaign] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetNegativeSitesByCampaignIdsResponse.CampaignNegativeSites.CampaignNegativeSites')}}.

The action has the following user-defined parameters:

AccountId: Required.
CampaignIds: Required.

The following request parameters will be automatically processed:

soapAction: GetNegativeSitesByCampaignIds

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getnegativesitesbycampaignids.

The resource includes the fields from the AdGroupNegativeSites template.

Profile Data File Url

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetProfileDataFileUrlResponse')}}.

The action has the following user-defined parameters:

LanguageLocale: Required.
ProfileType: Required.

The following request parameters will be automatically processed:

soapAction: GetProfileDataFileUrl

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/getprofiledatafileurl.

Fields

FileUrl: Template: ShortText.
FileUrlExpiryTimeUtc: Template: DateTime.
LastModifiedTimeUtc: Template: DateTime.

Search Company

Based on resource template CampaignManagementBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'SearchCompaniesResponse.Companies.Company')}}.

The action has the following user-defined parameters:

CompanyNameFilter: Required.
LanguageLocale: Required.

The following request parameters will be automatically processed:

soapAction: SearchCompanies

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/searchcompanies.

The resource includes the fields from the Company template.

Negative Sites Ad Group

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: SetNegativeSitesToAdGroups
text/xml: {{=_.extend({ AdGroupNegativeSites: _.map(batch, function(item) { return { AdGroupNegativeSites: item } }) }, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/setnegativesitestoadgroups.

The resource includes the fields from the AdGroupNegativeSites template.

Negative Sites To Campaign

Based on resource template CampaignManagementBase.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

AccountId: Required.

The following request parameters will be automatically processed:

soapAction: SetNegativeSitesToCampaigns
text/xml: {{=_.extend({ CampaignNegativeSites: _.map(batch, function(item) { return { CampaignNegativeSites: item } }) }, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/setnegativesitestocampaigns.

The resource includes the fields from the CampaignNegativeSites template.

Recommendation

Based on resource template AdInsightBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetRecommendationsResponse.Recommendations.Recommendation')}}.

The action has the following user-defined parameters:

CampaignId: Required.
AdGroupId: Required.
RecommendationType: Optional.

The following request parameters will be automatically processed:

soapAction: GetRecommendations

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getrecommendations.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: ApplyRecommendations
text/xml: {{={ Entities: _.map(batch, function(item){ return { ApplyRecommendationEntity: item } }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/applyrecommendations.

[Delete] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DismissRecommendations
text/xml: {{={ Entities: _.map(batch, function(item) { return { DismissRecommendationEntity: item } }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/dismissrecommendations.

The resource includes the fields from the Recommendation template.

Auto Apply Opt In Status

Based on resource template AdInsightBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetAutoApplyOptInStatusResponse.AutoApplyRecommendationsStatus.AutoApplyRecommendationsInfo')}}.

The action has the following user-defined parameters:

RecommendationTypesInputs:

The following request parameters will be automatically processed:

soapAction: GetAutoApplyOptInStatus

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getautoapplyoptinstatus.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: SetAutoApplyOptInStatus
text/xml: {{={ AutoApplyOptInStatusInputs: batch, '@xmlns:a1':'http://schemas.microsoft.com/2003/10/Serialization/Arrays' } }}

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/setautoapplyoptinstatus.

The resource includes the fields from the AutoApplyRecommendationsInfo template.

Auction Insight Data

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetAuctionInsightDataResponse.Result.Segments.AuctionSegment')}}.

The action has the following user-defined parameters:

EntityType: Required.
EntityIds: Required.
SearchParameters: Required.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: GetAuctionInsightData

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getauctioninsightdata.

The resource includes the fields from the AuctionSegment template.

Audience Full Estimation

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetAudienceFullEstimationResponse')}}.

The action has the following user-defined parameters:

Age: Required.
Gender: Required.
Audience: Required.
Company: Required.
Industry: Required.
JobFunction: Required.
Location: Required.
RadiusTargets: Required.
CampaignBiddingStrategy: Required.
CampaignSubType: Required.
Feed: Required.
DailyBudget: Required.
Bid: Optional.
Currency: Optional.

The following request parameters will be automatically processed:

soapAction: GetAudienceFullEstimation

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getaudiencefullestimation.

Fields

GetAudienceFullEstimationResponse

Field components:

Uses template: RangeResultOfDecimalRoundedResult.
Contains the following components: EstImpression, EstAudienceSize, EstClick, EstSpend, EstCostPerEvent, EstCTR, SuggestedBid, SuggestedBudget, EventsLostToBId, EventsLostToBudget, EstReachAudienceSize, EstReachImpression, Currency.

Bid Landscape By Ad Group Ids

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetBidLandscapeByAdGroupIdsResponse.BidLandscape.AdGroupBidLandscape')}}.

The action has the following user-defined parameters:

AdGroupBidLandscapeInputs: Required.

The following request parameters will be automatically processed:

soapAction: GetBidLandscapeByAdGroupIds

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getbidlandscapebyadgroupids.

The resource includes the fields from the AdGroupBidLandscape template.

Bid Landscape By Keyword Ids

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetBidLandscapeByKeywordIdsResponse.BidLandscape.KeywordBidLandscape')}}.

The action has the following user-defined parameters:

KeywordIds: Required.
IncludeCurrentBid: Optional.

The following request parameters will be automatically processed:

soapAction: GetBidLandscapeByKeywordIds

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getbidlandscapebykeywordids.

The resource includes the fields from the KeywordBidLandscape template.

Budget Opportunity

Based on resource template AdInsightBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetKeywordIdeasResponse.KeywordIdeas.KeywordIdea')}}.

The action has the following user-defined parameters:

CampaignId: Required.

The following request parameters will be automatically processed:

soapAction: GetBudgetOpportunities

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getbudgetopportunities.

The resource includes the fields from the BudgetOpportunity template.

Domain Category

Based on resource template AdInsightBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetKeywordIdeasResponse.KeywordIdeas.KeywordIdea')}}.

The action has the following user-defined parameters:

CategoryName: Required.
DomainName: Required.
Language: Required.

The following request parameters will be automatically processed:

soapAction: GetDomainCategories

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getdomaincategories.

The resource includes the fields from the DomainCategory template.

Estimated Bid

Based on resource template AdInsightBase.

[Read ids] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetEstimatedBidByKeywordIdsResponse.KeywordEstimatedBids.KeywordIdEstimatedBid')}}.

The action has the following user-defined parameters:

KeywordIds:
TargetPositionForAds:

The following request parameters will be automatically processed:

soapAction: GetEstimatedBidByKeywordIds

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getestimatedbidbykeywordids.

[Read keywords] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetEstimatedBidByKeywordsResponse.KeywordEstimatedBids.KeywordEstimatedBid')}}.

The action has the following user-defined parameters:

Keywords: Required.
TargetPositionForAds: Optional.
Language: Required.
LocationIds: Required.
CurrencyCode: Required.
CampaignId: Required.
AdGroupId: Required.
EntityLevelBid: Required.

The following request parameters will be automatically processed:

soapAction: GetEstimatedBidByKeywords

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getestimatedbidbykeywords.

The resource includes the fields from the KeywordEstimatedBid template.

Estimated Position

Based on resource template AdInsightBase.

[Read ids] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetEstimatedPositionByKeywordIdsResponse.KeywordEstimatedPositions.KeywordIdEstimatedPosition')}}.

The action has the following user-defined parameters:

KeywordIds: Required.
MaxBid: Optional.

The following request parameters will be automatically processed:

soapAction: GetEstimatedPositionByKeywordIds

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getestimatedpositionbykeywordids.

[Read keywords] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetEstimatedPositionByKeywordsResponse.KeywordEstimatedPositions.KeywordEstimatedPosition')}}.

The action has the following user-defined parameters:

Keywords: Required.
MaxBid: Optional.
Language: Optional.
LocationIds: Optional.
CurrencyCode: Optional.
MatchTypes: Required.
CampaignId: Optional.
AdGroupId: Optional.

The following request parameters will be automatically processed:

soapAction: GetEstimatedPositionByKeywords

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getestimatedpositionbykeywords.

The resource includes the fields from the KeywordEstimatedPosition template.

Historical Keyword Performance

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetHistoricalKeywordPerformanceResponse.KeywordHistoricalPerformances.KeywordHistoricalPerformance')}}.

The action has the following user-defined parameters:

Keywords: Required.
TimeInterval: Required.
TargetAdPosition: Required.
MatchTypes: Required.
Language: Required.
PublisherCountries: Optional.
Devices: Optional.

The following request parameters will be automatically processed:

soapAction: GetHistoricalKeywordPerformance

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/gethistoricalkeywordperformance.

The resource includes the fields from the KeywordHistoricalPerformance template.

Historical Search Count

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetHistoricalSearchCountResponse.KeywordSearchCounts.KeywordSearchCount')}}.

The action has the following user-defined parameters:

Keywords: Required.
Language: Required.
PublisherCountries: Required.
StartDate: Required.
EndDate: Required.
TimePeriodRollup: Required.
Devices: Required.

The following request parameters will be automatically processed:

soapAction: GetHistoricalSearchCount

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/gethistoricalsearchcount.

The resource includes the fields from the KeywordSearchCount template.

Keyword Idea

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetKeywordIdeasResponse.KeywordIdeas.KeywordIdea')}}.

The action has the following user-defined parameters:

ExpandIdeas: Required.
IdeaAttributes: Required.
SearchParameters: Required.

The following request parameters will be automatically processed:

soapAction: GetKeywordIdeas

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getkeywordideas.

The resource includes the fields from the KeywordIdea template.

Keyword Opportunity

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetKeywordOpportunitiesResponse.Opportunities.KeywordOpportunity')}}.

The action has the following user-defined parameters:

AdGroupId: Optional.
CampaignId: Required.
OpportunityType: Required.

The following request parameters will be automatically processed:

soapAction: GetKeywordOpportunities

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getkeywordopportunities.

The resource includes the fields from the KeywordOpportunity template.

Keyword Traffic Estimate

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetKeywordTrafficEstimatesResponse.CampaignEstimates.CampaignEstimate')}}.

The action has the following user-defined parameters:

CampaignEstimators: Required.

The following request parameters will be automatically processed:

soapAction: GetKeywordTrafficEstimates

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getkeywordtrafficestimates.

The resource includes the fields from the CampaignEstimate template.

Performance Insights Detail Data

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetPerformanceInsightsDetailDataByAccountIdResponse.Result.PerformanceInsightsDetail')}}.

The action has the following user-defined parameters:

EntityType: Required.
StartDate: Required.
EndDate: Required.

The following request parameters will be automatically processed:

soapAction: GetPerformanceInsightsDetailDataByAccountId

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/getperformanceinsightsdetaildatabyaccountid.

The resource includes the fields from the PerformanceInsightsDetail template.

Text Asset Suggestions By Final Urls

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetTextAssetSuggestionsByFinalUrlsResponse.TextAssetSuggestions.TextAssetSuggestions')}}.

The action has the following user-defined parameters:

FinalUrls: Required.

The following request parameters will be automatically processed:

soapAction: GetTextAssetSuggestionsByFinalUrls

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/gettextassetsuggestionsbyfinalurls.

The resource includes the fields from the TextAssetSuggestions template.

Retrieve Recommendation

Based on resource template AdInsightBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'RetrieveRecommendationsResponse.Recommendations.RecommendationBase')}}.

The action has the following user-defined parameters:

RecommendationTypes: Required.
MaxCount: Optional.

The following request parameters will be automatically processed:

soapAction: RetrieveRecommendations

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/retrieverecommendations.

The resource includes the fields from the RecommendationBase template.

Suggest Keywords For Url

Based on resource template AdInsightBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'SuggestKeywordsForUrlResponse.Keywords.KeywordAndConfidence')}}.

The action has the following user-defined parameters:

Url: Required.
Language: Required.
MaxKeywords: Optional.
MinConfidenceScore: Optional.
AdGroupId: Optional.
ExcludeBrand: Optional.

The following request parameters will be automatically processed:

soapAction: SuggestKeywordsForUrl

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/suggestkeywordsforurl.

The resource includes the fields from the KeywordAndConfidence template.

Suggest Keywords From Existing Keywords

Based on resource template AdInsightBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'SuggestKeywordsFromExistingKeywordsResponse.KeywordSuggestions.KeywordSuggestion')}}.

The action has the following user-defined parameters:

Keywords: Required.
Language: Required.
PublisherCountries: Required.
MaxSuggestionsPerKeyword: Required.
SuggestionType: Required.
RemoveDuplicates: Required.
ExcludeBrand: Required.
AdGroupId: Optional.
CampaignId: Optional.

The following request parameters will be automatically processed:

soapAction: SuggestKeywordsFromExistingKeywords

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/suggestkeywordsfromexistingkeywords.

The resource includes the fields from the KeywordSuggestion template.

Tag Recommendation

Based on resource template AdInsightBase.

[Create] action

Endpoint URL address: /.

The action has the following user-defined parameters:

Lable: Required.
RecommendationType: Required.

The following request parameters will be automatically processed:

soapAction: TagRecommendations
text/xml: {{=_.extend({ RecommendationsInfo: _.map(batch, function(item) { return { RecommendationsInfo: item } }) }, parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/tagrecommendations.

The resource includes the fields from the RecommendationInfo template.

Feature Adoption Coupon Eligibility

Based on resource template CustomerBillingBase.

[Read] action

The result is extracted from: {{=response.Envelope.Body.CheckFeatureAdoptionCouponEligibilityResponse.EligibleAccountIds[`a1:long`]}}.

The action has the following user-defined parameters:

AccountIds: Required.
FeatureId: Required.

The following request parameters will be automatically processed:

soapAction: CheckFeatureAdoptionCouponEligibility

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/checkfeatureadoptioncouponeligibility.

Fields

_@ttribute: Template: ShortText.

Feature Adoption Coupon

Based on resource template CustomerBillingBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: ClaimFeatureAdoptionCoupons
text/xml: {{={ AccountCouponPairs: _.extend(item, {'@xmlns:e2': 'https://bingads.microsoft.com/Customer/v13/Entities'}) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/claimfeatureadoptioncoupons.

The resource includes the fields from the FeatureAdoptionCouponKVP template.

Dispatch Coupon

Based on resource template CustomerBillingBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: DispatchCoupons

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/dispatchcoupons.

Fields

SendToEmails: Template: T_arrayString.
CustomerId: Template: Id.
CouponClassName: Template: ShortText.

Account Monthly Spend

Based on resource template CustomerBillingBase.

[Read] action

The result is extracted from: {{=SOAP.getData(response, 'GetAccountMonthlySpendResponse')}}.

The action has the following user-defined parameters:

AccountId: Required.
MonthYear: Required.

The following request parameters will be automatically processed:

soapAction: GetAccountMonthlySpend

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/getaccountmonthlyspend.

Fields

Amount: Template: Double.

Billing Document

Based on resource template CustomerBillingBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetBillingDocumentsResponse.BillingDocuments.BillingDocument')}}.

The action has the following user-defined parameters:

BillingDocumentsInfo: Required.
Type: Required.

The following request parameters will be automatically processed:

soapAction: GetBillingDocuments

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/getbillingdocuments.

The resource includes the fields from the BillingDocument template.

Billing Documents Info

Based on resource template CustomerBillingBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'GetBillingDocumentsInfoResponse.BillingDocumentsInfo.BillingDocumentInfo')}}.

The action has the following user-defined parameters:

AccountIds: Required.
StartDate: Required.
EndDate: Required.

The following request parameters will be automatically processed:

soapAction: GetBillingDocumentsInfo

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/getbillingdocumentsinfo.

The resource includes the fields from the BillingDocumentInfo template.

Redeem Coupon

Based on resource template CustomerBillingBase.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: RedeemCoupon

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/redeemcoupon.

Fields

AccountId: Template: Id.
CouponCode: Template: ShortText.

Search Coupon

Based on resource template CustomerBillingBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'SearchCouponsResponse.Coupons.Coupon')}}.
The result is paginated.

The action has the following user-defined parameters:

Predicates: Required.
Ordering: Optional.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: SearchCoupons

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/searchcoupons.

The resource includes the fields from the Coupon template.

Insertion Order

Based on resource template CustomerBillingBase.

[Read] action

Endpoint URL address: /.
The result is extracted from: {{=SOAP.getData(response, 'SearchInsertionOrdersResponse.InsertionOrders.InsertionOrder')}}.
The result is paginated.

The action has the following user-defined parameters:

Predicates: Required.
Ordering: Optional.
ReturnAdditionalFields: Optional.

The following request parameters will be automatically processed:

soapAction: SearchInsertionOrders
text/xml: {{=BingAds.getPaginatedParams(parameters)}}

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/searchinsertionorders.

[Create] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: AddInsertionOrder
text/xml: {{={ InsertionOrder: _.extend(item, { '@xmlns:e1': 'https://bingads.microsoft.com/Customer/v13/Entities' }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/addinsertionorder.

[Update] action

Endpoint URL address: /.

The following request parameters will be automatically processed:

soapAction: UpdateInsertionOrder
text/xml: {{={ InsertionOrder: _.extend(item, { '@xmlns:e1': 'https://bingads.microsoft.com/Customer/v13/Entities' }) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/updateinsertionorder.

The resource includes the fields from the InsertionOrder template.

Generate report

Based on resource template Base.

[Read] action

Endpoint URL address: https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/v13/ReportingService.svc.
The result is extracted from: {{=BingAds.getReportData(response, resource, parameters)}}.

The action has the following user-defined parameters:

@xsi:type: Required.
ReportName: Required.
ReturnOnlyCompleteData: Required.
Aggregation: Required.
Columns: Required.
Filter: Optional.
Scope: Required.
Time: Required.

The following request parameters will be automatically processed:

soapAction: SubmitGenerateReport
namespace: https://bingads.microsoft.com/Reporting/v13
text/xml: {{={ ReportRequest: SOAP.prepareParameters(parameters) } }}

Documentation: https://learn.microsoft.com/en-us/advertising/reporting-service/submitgeneratereport.

External Fields

[External]

The external fields list is extracted from: {{=BingAds.getReportFields(parameters.Columns)}}.

Referenced Resource Definitions

Base

[Read] action

The action uses POST method.

The following request parameters will be automatically processed:

namespace: {{=resource.ns}}
text/xml: {{=SOAP.prepareParameters(parameters)}}

[Create] action

The action uses POST method.

The following request parameters will be automatically processed:

namespace: {{=resource.ns}}
text/xml: {{=item}}

[Update] action

The action uses POST method.

The following request parameters will be automatically processed:

namespace: {{=resource.ns}}
text/xml: {{=item}}

[Delete] action

The action uses POST method.

The following request parameters will be automatically processed:

namespace: {{=resource.ns}}

CampaignManagementBase

Based on resource template Base.

[Read] action: Endpoint URL address: /.

AdInsightBase

Based on resource template Base.

[Read] action: Endpoint URL address: /.

CustomerBillingBase

Based on resource template Base.

[Read] action: Endpoint URL address: /.

Pagination

Based on resource template CampaignManagementBase.

[Read] action

The following request parameters will be automatically processed:

text/xml: {{=SOAP.prepareParameters(_.extend({ Index: (parameters.iterator || 0 ), Size: parameters.batchSize }, parameters))}}

Referenced Fields Definitions

ShortText

Data type: DT_WSTR ( length 255 )

LongText

Data type: DT_WSTR ( length 1000 )

Int

Data type: DT_I4

Double

Data type: DT_R8

DateTime

Data type: DT_DBTIMESTAMP

Date

Data type: DT_DBDATE

Bool

Data type: DT_BOOL

Id

Data type: DT_I8

MigrationStatusInfo

Field components:

Uses template: ShortText.
Contains the following components: MigrationType, StartTimeInUtc, Status.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/migrationstatusinfo.

ArrayOfMigrationStatusInfo

Field components:

An array.
Uses template: MigrationStatusInfo.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/migrationstatusinfo.

AccountMigrationStatusesInfo

Field components:

Uses template: Id.
Contains the following components: AccountId, MigrationStatusInfos.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/accountmigrationstatusesinfo.

AccountProperty

Field components:

Uses template: ShortText.
Contains the following components: Name, Value.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/accountproperty.

AppUrl

Field components:

Uses template: ShortText.
Contains the following components: OsType, Url.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/appurl.

ArrayOfAppUrl

Field components:

An array.
Uses template: AppUrl.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/appurl.

ArrayOfstring

Field components:

An array.
Uses template: ShortText.

CustomParameter

Field components:

Uses template: ShortText.
Contains the following components: Key, Value.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/customparameter.

ArrayOfCustomParameter

Field components:

An array.
Uses template: CustomParameter.

CustomParameters

Field components:

Uses template: ArrayOfCustomParameter.
Contains the following components: Parameters.

Ad

Field components:

Uses template: LongText.
Contains the following components: ForwardCompatibilityMap, DestinationUrl, DisplayUrl, Text, Title, PromotionalText, AppPlatform, AppStoreId, Domain, Path1, Path2, TextPart2, TitlePart1, TitlePart2, TitlePart3, AdSubType, BusinessName, CallToAction, CallToActionLanguage, Descriptions, Headline, Headlines, Images, ImpressionTrackingUrls, LongHeadline, LongHeadlineString, LongHeadlines, VerifiedTrackingSettings, Videos, @xsi:type, Id, AdFormatPreference, DevicePreference, EditorialStatus, FinalAppUrls, FinalMobileUrls, FinalUrlSuffix, FinalUrls, Status, TrackingUrlTemplate, Type, UrlCustomParameters.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/ad.

T_NoImageAsset

Field components:

Uses template: Id.
Contains the following components: Id, Name, Type, Text, SubType, ThumbnailImage, @xsi:type.

DayTime

Field components:

Uses template: ShortText.
Contains the following components: Day, EndHour, EndMinute, StartHour, StartMinute.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/daytime.

AdExtension

Field components:

Uses template: ShortText.
Contains the following components: @xsi:type, DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version, Text, IsExact, Source, Url, Address, CompanyName, GeoCodeStatus, GeoPoint, PhoneNumber, IsCallOnly, IsCallTrackingEnabled, RequireTollFreeTrackingNumber, AlternativeText, Description, DestinationUrl, DisplayText, FinalAppUrls, FinalMobileUrls, FinalUrlSuffix, FinalUrls, ImageMediaIds, Images, Layouts, SourceType, UrlCustomParameters, AppPlatform, AppStoreId, Description1, Description2, ActionType, Language, Header, Values, PriceExtensionType, TableRows, CurrencyCode, DiscountModifier, MoneyAmountOff, OrdersOverAmount, PercentOff, PromotionCode, PromotionEndDate, PromotionItem, PromotionOccasion, PromotionStartDate, TrackingUrlTemplate, AdExtensionHeaderType, Texts, FlyerName, ImageMediaUrls, StoreId, ActionText, Name, ThumbnailId, ThumbnailUrl, VideoId, DisclaimerLayout, LineText, PopupText, Title, BusinessLogo, BusinessLogoUrl, BusinessName, DomainName.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addadextensions.

T_arrayString

The gathered value is processed with {{=value.string}} expression. Before setting, the value is processed with {{=BingAds.getArrayValue(value, 'string')}} expression. Field components:

An array.
Uses template: ShortText.

T_arrayLong

The gathered value is processed with {{=value.long}} expression. Before setting, the value is processed with {{=BingAds.getArrayValue(value, 'long')}} expression. Field components:

An array.

T_TableRows

Field components:

Contains the following components: PriceTableRow.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/pricetablerow.

T_Images

Field components:

Uses template: T_AssetLink.
Contains the following components: AssetLink.

AdExtensionAssociation

Field components:

Uses template: AdExtension.
Contains the following components: AdExtension, AssociationType, EditorialStatus, EntityId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/adextensionassociation.

AdExtensionIdToEntityIdAssociation

Field components:

Uses template: Id.
Contains the following components: AdExtensionId, EntityId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/adextensionidtoentityidassociation.

AdRotation

Field components:

Uses template: ShortText.
Contains the following components: EndDate, StartDate, Type.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/adrotation.

RateAmount

Field components:

Uses template: Double.
Contains the following components: Amount.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/rateamount.

CriterionBid

Field components:

Uses template: ShortText.
Contains the following components: Type.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/criterionbid.

RateBid

Template: CriterionBid. Field components:

Uses template: RateAmount.
Contains the following components: RateAmount.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/ratebid.

Bid

Field components:

Uses template: Double.
Contains the following components: Amount.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/bid.

FrequencyCapSettings

Field components:

Uses template: Int.
Contains the following components: CapValue, TimeGranularity.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/frequencycapsettings.

ArrayOfFrequencyCapSettings

Field components:

An array.
Uses template: FrequencyCapSettings.

ArrayOfSetting

Field components:

An array.
Uses template: T_Setting.

BiddingScheme

Field components:

Uses template: ShortText.
Contains the following components: @xsi:type, InheritedBidStrategyType, MaxPercentCpc, CommissionRate, ManualCpi, TargetCostPerSale, Type, MaxCpc, TargetCpa, TargetRoas, TargetAdPosition, TargetImpressionShare.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/biddingscheme.

AdGroup

Field components:

Uses template: Id.
Contains the following components: Id, AdRotation, AudienceAdsBidAdjustment, BiddingScheme, CommissionRate, CpcBid, EndDate, FinalUrlSuffix, ForwardCompatibilityMap, FrequencyCapSettings, Language, MultimediaAdsBidAdjustment, Name, Network, PercentCpcBid, PrivacyStatus, Settings, StartDate, Status, TrackingUrlTemplate, UrlCustomParameters, UseOptimizedTargeting, UsePredictiveTargeting, AdScheduleUseSearcherTimeZone, AdGroupType, CpvBid, CpmBid, McpaBid.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/adgroup.

T_CampaignSetting

Field components:

Uses template: ShortText.
Contains the following components: Type, Details, FeedLabel, LocalInventoryAdsEnabled, Priority, SalesCountryCode, ShoppableAdsEnabled, StoreId, FeedId, DomainName, DynamicDescriptionEnabled, Language, PageFeedIds, Source, DisclaimerAdsEnabled, HotelAdGroupType, AutoGeneratedAssetsEnabled, AutoGeneratedImageOptOut, AutoGeneratedTextOptOut, CostPerSaleOptOut, FinalUrlExpansionOptOut, AutomatedCallToActionOptOut, DisplayUrlMode, WebsiteDescription, @xsi:type.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/setting.

T_Setting

Field components:

Uses template: ShortText.
Contains the following components: @xsi:type, Type, Details, FeedId, BidBoostValue, BidMaxValue, BidOption, DisclaimerAdsEnabled, HotelAdGroupType, AutoGeneratedAssetsEnabled, AutoGeneratedImageOptOut, AutoGeneratedTextOptOut, CostPerSaleOptOut, FinalUrlExpansionOptOut, PageFeedIds, AutomatedCallToActionOptOut, DisplayUrlMode, WebsiteDescription.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/setting.

T_Criterion

Field components:

Uses template: ShortText.
Contains the following components: Condition, PartitionType, Conditions, StoreId, @xsi:type, Listing, ListingType, ParentCriterionId, MaxDays, MinDays, EndDate, StartDate, CheckInDay, HotelDateSelectionType, MaxNights, MinNights, Parameter, AgeRange, DeviceName, OSName, Day, FromHour, FromMinute, ToHour, ToMinute, GenderType, LatitudeDegrees, LongitudeDegrees, Name, Radius, RadiusUnit, DisplayName, EnclosedLocationIds, LocationId, LocationType, IntentOption, AudienceId, AudienceType, ProfileId, ProfileType, DealId, GenreId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/criterion.

T_CriterionBid

Field components:

Uses template: ShortText.
Contains the following components: @xsi:type, RateAmount, Amount, Multiplier.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/criterionbid.

AdGroupCriterion

Field components:

Uses template: Id.
Contains the following components: Id, AdGroupId, Criterion, Status, CriterionBid, DestinationUrl, EditorialStatus, FinalAppUrls, FinalMobileUrls, FinalUrlSuffix, FinalUrls, TrackingUrlTemplate, UrlCustomParameters, CriterionCashback.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/adgroupcriterion.

AdGroupCriterionAction

Field components:

Uses template: ShortText.
Contains the following components: Action, AdGroupCriterion.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/adgroupcriterionaction.

AdGroupNegativeSites

Field components:

Uses template: Id.
Contains the following components: AdGroupId, NegativeSites.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/adgroupnegativesites.

Asset

Field components:

Uses template: Id.
Contains the following components: Id, Name, Type, Text, CropHeight, CropWidth, CropX, CropY, SubType, TargetHeight, TargetWidth, ThumbnailImage, @xsi:type.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/asset.

T_Date

Field components:

Uses template: Int.
Contains the following components: Day, Month, Year.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/date.

T_AssetLink

Field components:

Uses template: Asset.
Contains the following components: Asset, AssetPerformanceLabel, EditorialStatus, PinnedField.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/assetlink.

AssetGroup

Field components:

Uses template: ShortText.
Contains the following components: AssetGroupSearchThemes, Descriptions, EditorialStatus, FinalMobileUrls, FinalUrls, ForwardCompatibilityMap, Headlines, Images, LongHeadlines, Status, @xmlns:i, Id, BusinessName, CallToAction, EndDate, Name, Path1, Path2, StartDate.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/assetgroup.

ProductCondition

Field components:

Uses template: ShortText.
Contains the following components: Attribute, Operand, Operator.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/productcondition.

AssetGroupListingGroup

Field components:

Uses template: Id.
Contains the following components: Id, AssetGroupId, AssetGroupListingType, Dimension, IsExcluded, ParentListingGroupId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/assetgrouplistinggroup.

AssetGroupListingGroupAction

Field components:

Uses template: ShortText.
Contains the following components: Action, ListingGroup.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/assetgrouplistinggroupaction.

CustomerAccountShareAssociation

Field components:

Uses template: Int.
Contains the following components: AssociationCount, UsageType.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/customeraccountshareassociation.

ArrayOfCustomerAccountShareAssociation

Field components:

An array.
Uses template: CustomerAccountShareAssociation.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/customeraccountshareassociation.

CustomerAccountShare

Field components:

Uses template: Id.
Contains the following components: AccountId, Associations, CustomerId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/customeraccountshare.

ArrayOfCustomerAccountShare

Field components:

An array.
Uses template: CustomerAccountShare.

CustomerShare

Field components:

Uses template: ArrayOfCustomerAccountShare.
Contains the following components: CustomerAccountShares, OwnerCustomerId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/customershare.

T_RuleItemGroup

Field components:

Contains the following components: RuleItemGroup.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/ruleitemgroup.

Audience

Field components:

Uses template: LongText.
Contains the following components: ForwardCompatibilityMap, Rule, TagId, ProductAudienceType, SourceId, CombinationRules, AdGroupId, CampaignId, EntityType, @xsi:type, Id, AudienceNetworkSize, CustomerShare, Description, MembershipDuration, Name, ParentId, Scope, SearchSize, SupportedCampaignTypes, Type.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/audience.

AudienceGroupAssetGroupAssociation

Field components:

Uses template: Id.
Contains the following components: AssetGroupId, AudienceGroupId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/audiencegroupassetgroupassociation.

BidStrategy

Field components:

Uses template: Id.
Contains the following components: Id, AssociatedCampaignType, AssociationCount, BiddingScheme, Name.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/bidstrategy.

ArrayOflong

Field components:

An array.
Uses template: Int.

Campaign

Field components:

Uses template: Id.
Contains the following components: Id, AudienceAdsBidAdjustment, BiddingScheme, BudgetType, DailyBudget, DealIds, ExperimentId, FinalUrlSuffix, ForwardCompatibilityMap, GoalIds, MultimediaAdsBidAdjustment, Name, Status, SubType, TimeZone, TrackingUrlTemplate, UrlCustomParameters, CampaignType, Settings, BudgetId, Languages, AdScheduleUseSearcherTimeZone, BidStrategyId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/campaign.

CampaignAssociation

Field components:

Uses template: Id.
Contains the following components: CampaignId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/campaignassociation.

ArrayOfCampaignAssociation

Field components:

An array.
Uses template: CampaignAssociation.

CampaignConversionGoal

Field components:

Uses template: Id.
Contains the following components: CampaignId, GoalId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/addcampaignconversiongoals.

CampaignCriterion

Field components:

Uses template: Id.
Contains the following components: Id, CampaignId, Criterion, ForwardCompatibilityMap, Status, Type, CriterionBid.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/campaigncriterion.

CampaignNegativeSites

Field components:

Uses template: Id.
Contains the following components: CampaignId, NegativeSites.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/campaignnegativesites.

Company

Field components:

Uses template: ShortText.
Contains the following components: LogoUrl, Name, ProfileId, Status.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/company.

ConversionGoalRevenue

Field components:

Uses template: ShortText.
Contains the following components: CurrencyCode, Type, Value.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/conversiongoalrevenue.

ConversionGoal

Field components:

Uses template: ShortText.
Contains the following components: @xsi:type, Id, AttributionModelType, ConversionWindowInMinutes, CountType, ExcludeFromBidding, GoalCategory, IsEnhancedConversionsEnabled, Name, Revenue, Scope, Status, TagId, TrackingStatus, Type, ViewThroughConversionWindowInMinutes, UrlExpression, UrlOperator, MinimumDurationInSeconds, MinimumPagesViewed, ActionExpression, ActionOperator, CategoryExpression, CategoryOperator, LabelExpression, LabelOperator, Value, ValueOperator, AppPlatform, AppStoreId, IsExternallyAttributed.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/conversiongoal.

DataExclusion

Field components:

Uses template: Id.
Contains the following components: Id, CampaignAssociations, CampaignTypeFilter, Description, DeviceTypeFilter, EndDate, Name, StartDate.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/dataexclusion.

EditorialReason

Field components:

Uses template: ShortText.
Contains the following components: Location, PublisherCountries, ReasonCode, Term.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/editorialreason.

ArrayOfEditorialReason

Field components:

An array.
Uses template: EditorialReason.

EntityIdToParentIdAssociation

Field components:

Uses template: Id.
Contains the following components: EntityId, ParentId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/entityidtoparentidassociation.

ArrayOfEntityIdToParentIdAssociation

Field components:

An array.
Uses template: EntityIdToParentIdAssociation.

SharedListItem

Field components:

Uses template: LongText.
Contains the following components: ForwardCompatibilityMap, Type, Id, MatchType, Url, BrandId, Text, @xsi:type.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/sharedlistitem.

NegativeKeyword

Template: SharedListItem. Field components:

Uses template: Id.
Contains the following components: Id, MatchType, Text.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/negativekeyword.

ArrayOfNegativeKeyword

Field components:

An array.
Uses template: NegativeKeyword.

EntityNegativeKeyword

Field components:

Uses template: Id.
Contains the following components: EntityId, EntityType, NegativeKeywords.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/entitynegativekeyword.

Experiment

Field components:

Uses template: Id.
Contains the following components: Id, BaseCampaignId, EndDate, ExperimentCampaignId, ExperimentStatus, ExperimentType, Name, StartDate, TrafficSplitPercent.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/experiment.

ImportEntityStatistics

Field components:

Uses template: Int.
Contains the following components: Additions, Changes, Deletions, EntityType, Errors, Total.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/importentitystatistics.

ArrayOfImportEntityStatistics

Field components:

An array.
Uses template: ImportEntityStatistics.

Frequency

Field components:

Uses template: ShortText.
Contains the following components: Cron, TimeZone, Type.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/frequency.

ImportOption

Field components:

Uses template: LongText.
Contains the following components: ForwardCompatibilityMap, @xsi:type, Type, AccountUrlOptions, AdScheduleUseSearcherTimezone, AdjustmentForBids, AdjustmentForCampaignBudgets, AssociatedStoreId, AssociatedUetTagId, AutoDeviceBidOptimization, DeleteRemovedEntities, EnableAutoCurrencyConversion, EnableParentLocationMapping, NewAccountNegativeKeywords, NewActiveAdsForExistingAdGroups, NewActiveCampaignsAndChildEntities, NewAdCustomizerFeeds, NewAdGroupsAndChildEntitiesForExistingCampaigns, NewAdSchedules, NewAppAdExtensions, NewAudienceTargets, NewCallAdExtensions, NewCalloutAdExtensions, NewConversionGoals, NewDemographicTargets, NewDeviceTargets, NewEntities, NewImageAdExtensions, NewKeywordUrls, NewKeywordsForExistingAdGroups, NewLabels, NewLeadFormAdExtensions, NewLocationAdExtensions, NewLocationTargets, NewLogoAdExtensions, NewNegativeKeywordLists, NewNegativeKeywordsForExistingParents, NewNegativeSites, NewPageFeeds, NewPausedAdsForExistingAdGroups, NewPausedCampaignsAndChildEntities, NewPriceAdExtensions, NewProductFilters, NewPromotionAdExtensions, NewReviewAdExtensions, NewSitelinkAdExtensions, NewStructuredSnippetAdExtensions, NewUrlOptions, PauseAIMAdGroupIfAllAudienceCriterionNotImported, PauseCampaignsWithoutSupportedLocations, PauseNewCampaigns, RaiseBidsToMinimum, RaiseCampaignBudgetsToMinimum, RaiseProductGroupBidsToMinimum, RenameCampaignNameWithSuffix, SearchAndDsaMixedCampaignAsSearchCampaign, SearchAndReplaceForCampaignNames, SearchAndReplaceForCustomParameters, SearchAndReplaceForFinalURLSuffix, SearchAndReplaceForTrackingTemplates, SearchAndReplaceForUrls, SuffixForCampaignNames, SuffixForTrackingTemplates, SuffixForUrls, UpdateAccountNegativeKeywords, UpdateAdCustomizerAttributes, UpdateAdCustomizerFeeds, UpdateAdGroupNetwork, UpdateAdSchedules, UpdateAdUrls, UpdateAppAdExtensions, UpdateAudienceTargets, UpdateBiddingStrategies, UpdateBids, UpdateCallAdExtensions, UpdateCalloutAdExtensions, UpdateCampaignAdGroupLanguages, UpdateCampaignBudgets, UpdateCampaignNames, UpdateConversionGoals, UpdateDemographicTargets, UpdateDeviceTargets, UpdateEntities, UpdateImageAdExtensions, UpdateKeywordUrls, UpdateLabels, UpdateLeadFormAdExtensions, UpdateLocationAdExtensions, UpdateLocationTargets, UpdateLogoAdExtensions, UpdateNegativeKeywordLists, UpdateNegativeSites, UpdatePageFeeds, UpdatePriceAdExtensions, UpdateProductFilters, UpdatePromotionAdExtensions, UpdateReviewAdExtensions, UpdateSitelinkAdExtensions, UpdateSitelinkUrls, UpdateStatusForAdGroups, UpdateStatusForAds, UpdateStatusForCampaigns, UpdateStatusForKeywords, UpdateStructuredSnippetAdExtensions, UpdateUrlOptions.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/importoption.

ImportJob

Field components:

Uses template: Id.
Contains the following components: Id, CreatedByUserId, CreatedByUserName, CreatedDateTimeInUTC, Frequency, ImportOption, LastRunTimeInUTC, Name, NotificationEmail, NotificationType, Status, Type, @xsi:type, CampaignAdGroupIds, CredentialId, GoogleAccountId, GoogleUserName, FileSource, FileUrl.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/importjob.

ImportResult

Field components:

Uses template: Id.
Contains the following components: Id, EntityStatistics, ErrorLogUrl, ForwardCompatibilityMap, ImportJob, StartTimeInUTC, Status.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/importresult.

Keyword

Field components:

Uses template: Id.
Contains the following components: Id, Bid, BiddingScheme, DestinationUrl, EditorialStatus, FinalAppUrls, FinalMobileUrls, FinalUrlSuffix, FinalUrls, ForwardCompatibilityMap, MatchType, Param1, Param2, Param3, Status, Text, TrackingUrlTemplate, UrlCustomParameters.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keyword.

Label

Field components:

Uses template: Id.
Contains the following components: Id, ColorCode, Description, Name.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/label.

LabelAssociation

Field components:

Uses template: Id.
Contains the following components: EntityId, LabelId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/labelassociation.

Media

Field components:

Uses template: Id.
Contains the following components: Id, MediaType, Type, Text, Data.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/media.

MediaAssociation

Field components:

Uses template: Id.
Contains the following components: EntityId, MediaEnabledEntity, MediaId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/mediaassociation.

ArrayOfMediaAssociation

Field components:

An array.
Uses template: MediaAssociation.

MediaRepresentation

Field components:

Uses template: ShortText.
Contains the following components: Name, Type, Url.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/mediarepresentation.

ArrayOfMediaRepresentation

Field components:

An array.
Uses template: MediaRepresentation.

MediaMetaData

Field components:

Uses template: Id.
Contains the following components: Id, MediaType, Representations, Type.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/mediametadata.

ArrayOfNullableOflong

Field components:

An array.
Uses template: Int.

OfflineConversion

Field components:

Uses template: ShortText.
Contains the following components: ConversionCurrencyCode, ConversionName, ConversionTime, ConversionValue, ExternalAttributionCredit, ExternalAttributionModel, HashedEmailAddress, HashedPhoneNumber, MicrosoftClickId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/offlineconversion.

OfflineConversionAdjustment

Field components:

Uses template: ShortText.
Contains the following components: AdjustmentCurrencyCode, AdjustmentTime, AdjustmentType, AdjustmentValue, ConversionName, ConversionTime, HashedEmailAddress, HashedPhoneNumber, MicrosoftClickId.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/offlineconversionadjustment.

SeasonalityAdjustment

Field components:

Uses template: Id.
Contains the following components: Id, AdjustmentPercentage, CampaignAssociations, CampaignTypeFilter, Description, DeviceTypeFilter, EndDate, Name, StartDate.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/seasonalityadjustment.

SharedEntity

Field components:

Uses template: Id.
Contains the following components: Id, AssociationCount, ForwardCompatibilityMap, Name, Type, @xsi:type.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/sharedentity.

SharedEntityListItems

Field components:

Uses template: Id.
Contains the following components: Id, AssociationCount, ForwardCompatibilityMap, Name, Type, SharedEntity, ListItems.

SharedEntityAssociation

Field components:

Uses template: Id.
Contains the following components: EntityId, EntityType, SharedEntityCustomerId, SharedEntityId, SharedEntityType.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/sharedentityassociation.

ArrayOfSharedListItem

Field components:

An array.
Uses template: SharedListItem.

UetTag

Field components:

Uses template: Id.
Contains the following components: Id, CustomerShare, Description, Name, TrackingNoScript, TrackingScript, TrackingStatus.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/uettag.

Video

Field components:

Uses template: Id.
Contains the following components: Id, AspectRatio, CreatedDateTimeInUTC, Description, DurationInMilliseconds, FailureCode, ModifiedDateTimeInUTC, SourceUrl, Status, ThumbnailUrl, Url.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/video.

AudienceGroup

Field components:

Uses template: Id.
Contains the following components: Id, AssociationCount, Description, Dimensions, Name.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/audiencegroup.

AudienceGroupDimension

Field components:

Uses template: ShortText.
Contains the following components: Type, AgeRanges, GenderTypes, Audiences, @xsi:type.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/audiencegroupdimension.

BMCStore

Field components:

Uses template: Id.
Contains the following components: Id, HasCatalog, IsActive, IsProductAdsEnabled, Name, StoreUrl, SubType.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/bmcstore.

Budget

Field components:

Uses template: Id.
Contains the following components: Id, Amount, AssociationCount, BudgetType, Name.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/budget.

CustomerListUserData

Field components:

Uses template: ShortText.
Contains the following components: ActionType, AudienceId, CustomerListItemSubType, CustomerListItems.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/customerlistuserdata.

EditorialReasonCollection

Field components:

Uses template: Id.
Contains the following components: AdGroupId, AdOrKeywordId, AppealStatus, Reasons.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/editorialreasoncollection.

IdCollection

Field components:

Uses template: ArrayOfNullableOflong.
Contains the following components: Ids.

Documentation: https://learn.microsoft.com/en-us/advertising/campaign-management-service/idcollection.

KeyValuePairOflonglong

Field components:

Contains the following components: key, value.

EntityScope

Template: ShortText.

EntityType

Template: ShortText.

AuctionSegment

Template: ShortText.

Currency

Template: ShortText.

BidLandscapePoint

Field components:

Uses template: Double.
Contains the following components: Bid, Clicks, Impressions, TopImpressions, CurrencyCode, Cost, MarginalCPC.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/bidlandscapepoint.

ArrayOfBidLandscapePoint

Field components:

An array.
Uses template: BidLandscapePoint.

AdGroupBidLandscape

Field components:

Uses template: Id.
Contains the following components: AdGroupId, AdGroupBidLandscapeType, StartDate, EndDate, BidLandscapePoints.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/adgroupbidlandscape.

TrafficEstimate

Field components:

Uses template: Double.
Contains the following components: AverageCpc, AveragePosition, Clicks, Ctr, Impressions, TotalCost.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/trafficestimate.

KeywordEstimate

Field components:

Uses template: Keyword.
Contains the following components: Keyword, Maximum, Minimum.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordestimate.

ArrayOfKeywordEstimate

Field components:

An array.
Uses template: KeywordEstimate.

AdGroupEstimate

Field components:

Uses template: Id.
Contains the following components: AdGroupId, KeywordEstimates.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/adgroupestimate.

KeywordEstimator

Field components:

Uses template: Keyword.
Contains the following components: Keyword, MaxCpc.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordestimator.

ArrayOfAdGroupEstimate

Field components:

An array.
Uses template: AdGroupEstimate.

AutoApplyRecommendationsInfo

Field components:

Uses template: Bool.
Contains the following components: AAROptInStatus, RecommendationType, a1:string.

BudgetPoint

Field components:

Uses template: Double.
Contains the following components: BudgetAmount, BudgetPointType, EstimatedWeeklyClicks, EstimatedWeeklyCost, EstimatedWeeklyImpressions.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/budgetpoint.

ArrayOfBudgetPoint

Field components:

An array.
Uses template: BudgetPoint.

EstimatedBidAndTraffic

Field components:

Uses template: Double.
Contains the following components: MinClicksPerWeek, MaxClicksPerWeek, AverageCPC, MinImpressionsPerWeek, MaxImpressionsPerWeek, CTR, MinTotalCostPerWeek, MaxTotalCostPerWeek, CurrencyCode, MatchType, EstimatedMinBid.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/estimatedbidandtraffic.

ArrayOfEstimatedBidAndTraffic

Field components:

An array.
Uses template: EstimatedBidAndTraffic.

EstimatedPositionAndTraffic

Field components:

Uses template: ShortText.
Contains the following components: MatchType, MinClicksPerWeek, MaxClicksPerWeek, AverageCPC, MinImpressionsPerWeek, MaxImpressionsPerWeek, CTR, MinTotalCostPerWeek, MaxTotalCostPerWeek, CurrencyCode, EstimatedAdPosition.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/estimatedpositionandtraffic.

ArrayOfEstimatedPositionAndTraffic

Field components:

An array.
Uses template: EstimatedPositionAndTraffic.

ArrayOfGenderEnum

Field components:

An array.
Uses template: ShortText.

HistoricalSearchCountPeriodic

Field components:

Uses template: Int.
Contains the following components: SearchCount, DayMonthAndYear.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/historicalsearchcountperiodic.

ArrayOfHistoricalSearchCountPeriodic

Field components:

An array.
Uses template: HistoricalSearchCountPeriodic.

KeywordAndConfidence

Field components:

Uses template: ShortText.
Contains the following components: SuggestedKeyword, ConfidenceScore.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordandconfidence.

ArrayOfKeywordAndConfidence

Field components:

An array.
Uses template: KeywordAndConfidence.

KeywordCategory

Field components:

Uses template: ShortText.
Contains the following components: Category, ConfidenceScore.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordcategory.

ArrayOfKeywordCategory

Field components:

An array.
Uses template: KeywordCategory.

KeywordDemographic

Field components:

Uses template: ShortText.
Contains the following components: Device, EighteenToTwentyFour, TwentyFiveToThirtyFour, ThirtyFiveToFourtyNine, FiftyToSixtyFour, SixtyFiveAndAbove, AgeUnknown, Female, Male, GenderUnknown.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keyworddemographic.

ArrayOfKeywordDemographic

Field components:

An array.
Uses template: KeywordDemographic.

KeywordKPI

Field components:

Uses template: ShortText.
Contains the following components: Device, MatchType, AdPosition, Clicks, Impressions, AverageCPC, CTR, TotalCost, AverageBid.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordkpi.

ArrayOfKeywordKPI

Field components:

An array.
Uses template: KeywordKPI.

KeywordLocation

Field components:

Uses template: ShortText.
Contains the following components: Device, Location, Percentage.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordlocation.

ArrayOfKeywordLocation

Field components:

An array.
Uses template: KeywordLocation.

ArrayOfMatchType

Field components:

An array.
Uses template: ShortText.

PerformanceInsightsMessageParameter

Field components:

Uses template: ShortText.
Contains the following components: Type.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/performanceinsightsmessageparameter.

ArrayOfPerformanceInsightsMessageParameter

Field components:

An array.
Uses template: PerformanceInsightsMessageParameter.

PerformanceInsightsMessage

Field components:

Uses template: Id.
Contains the following components: TemplateId, Parameters, IndentationLevel.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/performanceinsightsmessage.

ArrayOfPerformanceInsightsMessage

Field components:

An array.
Uses template: PerformanceInsightsMessage.

RecommendationInfo

Field components:

Uses template: ShortText.
Contains the following components: RecommendationHash, RecommendationId, AdId .

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/recommendationinfo.

ArrayOfRecommendationInfo

Field components:

An array.
Uses template: RecommendationInfo.

SearchCountsByAttributes

Field components:

Uses template: ShortText.
Contains the following components: Device, HistoricalSearchCounts.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/searchcountsbyattributes.

ArrayOfSearchCountsByAttributes

Field components:

An array.
Uses template: SearchCountsByAttributes.

Opportunity

Field components:

Uses template: ShortText.
Contains the following components: OpportunityKey.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/opportunity.

BudgetOpportunity

Template: Opportunity. Field components:

Uses template: ArrayOfBudgetPoint.
Contains the following components: BudgetPoints, BudgetType, CampaignId, CurrentBudget, IncreaseInClicks, IncreaseInImpressions, PercentageIncreaseInClicks, PercentageIncreaseInImpressions, RecommendedBudget.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/budgetopportunity.

CampaignEstimate

Field components:

Uses template: ArrayOfAdGroupEstimate.
Contains the following components: AdGroupEstimates, CampaignId.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/campaignestimate.

DecimalRoundedResult

Field components:

Uses template: Double.
Contains the following components: Value, Unit.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/decimalroundedresult.

DismissRecommendationEntity

Field components:

Uses template: Id.
Contains the following components: RecommendationId, RecommendationType.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/dismissrecommendationentity.

DomainCategory

Field components:

Uses template: Double.
Contains the following components: Bid, CategoryName, Coverage.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/domaincategory.

KeywordBidLandscape

Field components:

Uses template: Id.
Contains the following components: KeywordId, StartDate, EndDate, BidLandscapePoints.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordbidlandscape.

KeywordEstimatedBid

Field components:

Uses template: ShortText.
Contains the following components: Keyword, KeywordId, EstimatedBids.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordestimatedbid.

KeywordEstimatedPosition

Field components:

Uses template: ShortText.
Contains the following components: Keyword, EstimatedPositions.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordestimatedposition.

KeywordHistoricalPerformance

Field components:

Uses template: ShortText.
Contains the following components: Keyword, KeywordKPIs.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordhistoricalperformance.

KeywordIdea

Field components:

Uses template: Id.
Contains the following components: AdGroupId, AdGroupName, AdImpressionShare, Competition, Keyword, MonthlySearchCounts, Relevance, Source, SuggestedBid.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordidea.

KeywordOpportunity

Template: Opportunity. Field components:

Uses template: Id.
Contains the following components: AdGroupId, AdGroupName, CampaignId, CampaignName, Competition, EstimatedIncreaseInClicks, EstimatedIncreaseInCost, EstimatedIncreaseInImpressions, MatchType, MonthlySearches, SuggestedBid, SuggestedKeyword.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordopportunity.

FeatureAdoptionCouponKVP

Field components:

Contains the following components: e2:KeyValueEntityOflongstring.

KeywordSearchCount

Field components:

Uses template: ShortText.
Contains the following components: Keyword, SearchCountsByAttributes.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordsearchcount.

KeywordSuggestion

Field components:

Uses template: ShortText.
Contains the following components: Keyword, SuggestionsAndConfidence.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/keywordsuggestion.

PerformanceInsightsDetail

Field components:

Uses template: Id.
Contains the following components: EntityId, EntityType, KPIType, Date, Description, RootCauses, Actions.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/performanceinsightsdetail.

RangeResultOfDecimalRoundedResult

Field components:

Uses template: DecimalRoundedResult.
Contains the following components: High, Low.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/rangeresultofdecimalroundedresult.

RangeResultOfdouble

Field components:

Uses template: Double.
Contains the following components: High, Low.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/rangeresultofdouble.

Recommendation

Field components:

Uses template: Id.
Contains the following components: AccountId, AdGroupId, CampaignId, CurrentClicks, CurrentConversions, CurrentCost, CurrentImpressions, EstimatedIncreaseInClicks, EstimatedIncreaseInConversions, EstimatedIncreaseInCost, EstimatedIncreaseInImpressions, RecommendationHash, SuggestedAd, RecommendationId, RecommendationType.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/recommendation.

RecommendationBase

Field components:

Uses template: Id.
Contains the following components: AccountId, AdGroupId, CampaignId, CurrentClicks, CurrentConversions, CurrentCost, CurrentImpressions, Dismissed, EstimatedIncreaseInClicks, EstimatedIncreaseInConversions, EstimatedIncreaseInCost, EstimatedIncreaseInImpressions, RecommendationHash, RecommendationId, RecommendationType, Type.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/recommendationbase.

TextAssetSuggestions

Field components:

Uses template: ShortText.
Contains the following components: FinalUrl, TextAssets.

Documentation: https://learn.microsoft.com/en-us/advertising/ad-insight-service/textassetsuggestions.

BillingDocument

Field components:

Uses template: Id.
Contains the following components: Id, Data, Type.

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/billingdocument.

BillingDocumentInfo

Field components:

Uses template: Id.
Contains the following components: AccountId, AccountName, AccountNumber, Amount, CurrencyCode, DocumentDate, DocumentId, CustomerId, CampaignId.

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/billingdocumentinfo.

CouponRedemption

Field components:

Uses template: Id.
Contains the following components: AccountId, AccountNumber, SpendToThreshold, Balance, CurrencyCode, RedemptionDate, ExpirationDate, ActivationDate.

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/couponredemption.

CouponClaimInfo

Field components:

Uses template: Id.
Contains the following components: AccountId, AccountNumber, ClaimDate.

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/couponclaiminfo.

Coupon

Field components:

Uses template: ShortText.
Contains the following components: CouponCode, ClassName, CouponType, Amount, SpendThreshold, CurrencyCode, PercentOff, ActiveDuration, ExpirationDate, StartDate, EndDate, SendToEmail, SendToDate, IsRedeemed, RedemptionInfo, ClaimInfo.

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/coupon.

InsertionOrder

Field components:

Uses template: Id.
Contains the following components: AccountId, BookingCountryCode, Comment, EndDate, Id, LastModifiedByUserId, LastModifiedTime, NotificationThreshold, ReferenceId, SpendCapAmount, StartDate, Name, Status, PurchaseOrder, PendingChanges, AccountNumber, BudgetRemaining, BudgetSpent, BudgetRemainingPercent, BudgetSpentPercent, SeriesName, IsInSeries, SeriesFrequencyType, IsUnlimited, IsEndless, e1:AccountId, e1:BookingCountryCode, e1:Comment, e1:EndDate, e1:Id, e1:LastModifiedByUserId, e1:LastModifiedTime, e1:NotificationThreshold, e1:ReferenceId, e1:SpendCapAmount, e1:StartDate, e1:Name, e1:Status, e1:PurchaseOrder, e1:PendingChanges, e1:AccountNumber, e1:BudgetRemaining, e1:BudgetSpent, e1:BudgetRemainingPercent, e1:BudgetSpentPercent, e1:SeriesName, e1:IsInSeries, e1:SeriesFrequencyType, e1:IsUnlimited, e1:IsEndless.

Documentation: https://learn.microsoft.com/en-us/advertising/customer-billing-service/insertionorder.

ReportRequest

Field components:

Uses template: Bool.
Contains the following components: ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData.

Documentation: https://learn.microsoft.com/en-us/advertising/reporting-service/reportrequest.

ReportRequestStatus