AddConversionGoals Service Operation - Campaign Management

Article
07/31/2023

Adds new conversion goals to the account's shared conversion goal library.

Important

Every time you add or update a new DurationGoal, EventGoal, OfflineConversionGoal, PagesViewedPerVisitGoal or UrlGoal via either the Microsoft Advertising web application or Campaign Management API, the MSCLKIDAutoTaggingEnabled value of the corresponding AccountProperty is set to True automatically. If the Scope of the goal is set to Customer level, then the AccountProperty for all accounts under the Customer will be set.

Note

To create an enhanced conversion goal and set isEnhancedConversionsEnabled=true, you must create a conversion goal for the account via the Microsoft Advertising UI with the enhanced conversion setting selected and the associated checkbox checked.

Tip

For an implementation overview, see the Universal Event Tracking technical guide.

Request Elements

The AddConversionGoalsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
ConversionGoals	The list of conversion goals to add to the account's shared conversion goal library. You can add a maximum of 100 conversion goals per service request. The account is determined by the required CustomerAccountId header element.	ConversionGoal array

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The AddConversionGoalsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element	Description	Data Type
ConversionGoalIds	A list of unique system identifiers corresponding to the conversion goals that were added. The list of identifiers corresponds directly to the list of conversion goals in the request. Items of the list may be returned as null. For each list index where a conversion goal was not added, the corresponding element will be null.	long array
PartialErrors	An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.	BatchError array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <Action mustUnderstand="1">AddConversionGoals</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <AddConversionGoalsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoals i:nil="false">
        <ConversionGoal i:type="-- derived type specified here with the appropriate prefix --">
          <AttributionModelType i:nil="false">ValueHere</AttributionModelType>
          <ConversionWindowInMinutes i:nil="false">ValueHere</ConversionWindowInMinutes>
          <CountType i:nil="false">ValueHere</CountType>
          <ExcludeFromBidding i:nil="false">ValueHere</ExcludeFromBidding>
          <GoalCategory i:nil="false">ValueHere</GoalCategory>
          <Id i:nil="false">ValueHere</Id>
          <IsEnhancedConversionsEnabled i:nil="false">ValueHere</IsEnhancedConversionsEnabled>
          <Name i:nil="false">ValueHere</Name>
          <Revenue i:nil="false">
            <CurrencyCode i:nil="false">ValueHere</CurrencyCode>
            <Type i:nil="false">ValueHere</Type>
            <Value i:nil="false">ValueHere</Value>
          </Revenue>
          <Scope i:nil="false">ValueHere</Scope>
          <Status i:nil="false">ValueHere</Status>
          <TagId i:nil="false">ValueHere</TagId>
          <TrackingStatus i:nil="false">ValueHere</TrackingStatus>
          <Type i:nil="false">ValueHere</Type>
          <ViewThroughConversionWindowInMinutes i:nil="false">ValueHere</ViewThroughConversionWindowInMinutes>
          <!--These fields are applicable if the derived type attribute is set to UrlGoal-->
          <UrlExpression i:nil="false">ValueHere</UrlExpression>
          <UrlOperator i:nil="false">ValueHere</UrlOperator>
          <!--This field is applicable if the derived type attribute is set to DurationGoal-->
          <MinimumDurationInSeconds i:nil="false">ValueHere</MinimumDurationInSeconds>
          <!--This field is applicable if the derived type attribute is set to PagesViewedPerVisitGoal-->
          <MinimumPagesViewed i:nil="false">ValueHere</MinimumPagesViewed>
          <!--These fields are applicable if the derived type attribute is set to EventGoal-->
          <ActionExpression i:nil="false">ValueHere</ActionExpression>
          <ActionOperator i:nil="false">ValueHere</ActionOperator>
          <CategoryExpression i:nil="false">ValueHere</CategoryExpression>
          <CategoryOperator i:nil="false">ValueHere</CategoryOperator>
          <LabelExpression i:nil="false">ValueHere</LabelExpression>
          <LabelOperator i:nil="false">ValueHere</LabelOperator>
          <Value i:nil="false">ValueHere</Value>
          <ValueOperator i:nil="false">ValueHere</ValueOperator>
          <!--These fields are applicable if the derived type attribute is set to AppInstallGoal-->
          <AppPlatform i:nil="false">ValueHere</AppPlatform>
          <AppStoreId i:nil="false">ValueHere</AppStoreId>
          <!--This field is applicable if the derived type attribute is set to OfflineConversionGoal-->
          <IsExternallyAttributed i:nil="false">ValueHere</IsExternallyAttributed>
          <!--No additional fields are applicable if the derived type attribute is set to InStoreTransactionGoal-->
        </ConversionGoal>
      </ConversionGoals>
    </AddConversionGoalsRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <AddConversionGoalsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoalIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </ConversionGoalIds>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e44="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e44:KeyValuePairOfstringstring>
              <e44:key d4p1:nil="false">ValueHere</e44:key>
              <e44:value d4p1:nil="false">ValueHere</e44:value>
            </e44:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </AddConversionGoalsResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<AddConversionGoalsResponse> AddConversionGoalsAsync(
	IList<ConversionGoal> conversionGoals)
{
	var request = new AddConversionGoalsRequest
	{
		ConversionGoals = conversionGoals
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddConversionGoalsAsync(r), request));
}

static AddConversionGoalsResponse addConversionGoals(
	ArrayOfConversionGoal conversionGoals) throws RemoteException, Exception
{
	AddConversionGoalsRequest request = new AddConversionGoalsRequest();

	request.setConversionGoals(conversionGoals);

	return CampaignManagementService.getService().addConversionGoals(request);
}

static function AddConversionGoals(
	$conversionGoals)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new AddConversionGoalsRequest();

	$request->ConversionGoals = $conversionGoals;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddConversionGoals($request);
}

response=campaignmanagement_service.AddConversionGoals(
	ConversionGoals=ConversionGoals)

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Share via