GetConversionGoalsByIds Service Operation - Campaign Management
Gets the specified conversion goals.
Tip
For an implementation overview, see the Universal Event Tracking technical guide.
Request Elements
The GetConversionGoalsByIdsRequest 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 |
|---|---|---|
| ConversionGoalIds | A maximum of 100 identifiers of the conversion goals that you want to get. If ConversionGoalIds is null or empty, then you are effectively requesting all conversion goals of the specified types for the account. |
long array |
| ConversionGoalTypes | The type of conversion goals to return. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <ConversionGoalTypes>Url Duration</ConversionGoalTypes>. |
ConversionGoalType |
| ReturnAdditionalFields | The list of additional properties that you want included within each returned conversion goal. The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional. |
ConversionGoalAdditionalField |
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 GetConversionGoalsByIdsResponse 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 |
|---|---|---|
| ConversionGoals | An array of ConversionGoal objects that corresponds directly to the conversion goal identifiers that you specified in the request. Items of the array may be returned as null. For each array index where a conversion goal was not retrieved, the corresponding element will be null. | ConversionGoal 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">GetConversionGoalsByIds</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>
<GetConversionGoalsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<ConversionGoalIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</ConversionGoalIds>
<ConversionGoalTypes>ValueHere</ConversionGoalTypes>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetConversionGoalsByIdsRequest>
</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>
<GetConversionGoalsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<ConversionGoals d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<ConversionGoal d4p1:type="-- derived type specified here with the appropriate prefix --">
<AttributionModelType d4p1:nil="false">ValueHere</AttributionModelType>
<ConversionWindowInMinutes d4p1:nil="false">ValueHere</ConversionWindowInMinutes>
<CountType d4p1:nil="false">ValueHere</CountType>
<ExcludeFromBidding d4p1:nil="false">ValueHere</ExcludeFromBidding>
<GoalCategory d4p1:nil="false">ValueHere</GoalCategory>
<Id d4p1:nil="false">ValueHere</Id>
<IsEnhancedConversionsEnabled d4p1:nil="false">ValueHere</IsEnhancedConversionsEnabled>
<Name d4p1:nil="false">ValueHere</Name>
<Revenue d4p1:nil="false">
<CurrencyCode d4p1:nil="false">ValueHere</CurrencyCode>
<Type d4p1:nil="false">ValueHere</Type>
<Value d4p1:nil="false">ValueHere</Value>
</Revenue>
<Scope d4p1:nil="false">ValueHere</Scope>
<Status d4p1:nil="false">ValueHere</Status>
<TagId d4p1:nil="false">ValueHere</TagId>
<TrackingStatus d4p1:nil="false">ValueHere</TrackingStatus>
<Type d4p1:nil="false">ValueHere</Type>
<ViewThroughConversionWindowInMinutes d4p1:nil="false">ValueHere</ViewThroughConversionWindowInMinutes>
<!--These fields are applicable if the derived type attribute is set to UrlGoal-->
<UrlExpression d4p1:nil="false">ValueHere</UrlExpression>
<UrlOperator d4p1:nil="false">ValueHere</UrlOperator>
<!--This field is applicable if the derived type attribute is set to DurationGoal-->
<MinimumDurationInSeconds d4p1:nil="false">ValueHere</MinimumDurationInSeconds>
<!--This field is applicable if the derived type attribute is set to PagesViewedPerVisitGoal-->
<MinimumPagesViewed d4p1:nil="false">ValueHere</MinimumPagesViewed>
<!--These fields are applicable if the derived type attribute is set to EventGoal-->
<ActionExpression d4p1:nil="false">ValueHere</ActionExpression>
<ActionOperator d4p1:nil="false">ValueHere</ActionOperator>
<CategoryExpression d4p1:nil="false">ValueHere</CategoryExpression>
<CategoryOperator d4p1:nil="false">ValueHere</CategoryOperator>
<LabelExpression d4p1:nil="false">ValueHere</LabelExpression>
<LabelOperator d4p1:nil="false">ValueHere</LabelOperator>
<Value d4p1:nil="false">ValueHere</Value>
<ValueOperator d4p1:nil="false">ValueHere</ValueOperator>
<!--These fields are applicable if the derived type attribute is set to AppInstallGoal-->
<AppPlatform d4p1:nil="false">ValueHere</AppPlatform>
<AppStoreId d4p1:nil="false">ValueHere</AppStoreId>
<!--This field is applicable if the derived type attribute is set to OfflineConversionGoal-->
<IsExternallyAttributed d4p1:nil="false">ValueHere</IsExternallyAttributed>
<!--No additional fields are applicable if the derived type attribute is set to InStoreTransactionGoal-->
</ConversionGoal>
</ConversionGoals>
<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:e295="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e295:KeyValuePairOfstringstring>
<e295:key d4p1:nil="false">ValueHere</e295:key>
<e295:value d4p1:nil="false">ValueHere</e295:value>
</e295: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>
</GetConversionGoalsByIdsResponse>
</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<GetConversionGoalsByIdsResponse> GetConversionGoalsByIdsAsync(
IList<long> conversionGoalIds,
ConversionGoalType conversionGoalTypes,
ConversionGoalAdditionalField? returnAdditionalFields)
{
var request = new GetConversionGoalsByIdsRequest
{
ConversionGoalIds = conversionGoalIds,
ConversionGoalTypes = conversionGoalTypes,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetConversionGoalsByIdsAsync(r), request));
}
static GetConversionGoalsByIdsResponse getConversionGoalsByIds(
ArrayOflong conversionGoalIds,
ArrayList<ConversionGoalType> conversionGoalTypes,
ArrayList<ConversionGoalAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetConversionGoalsByIdsRequest request = new GetConversionGoalsByIdsRequest();
request.setConversionGoalIds(conversionGoalIds);
request.setConversionGoalTypes(conversionGoalTypes);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getConversionGoalsByIds(request);
}
static function GetConversionGoalsByIds(
$conversionGoalIds,
$conversionGoalTypes,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetConversionGoalsByIdsRequest();
$request->ConversionGoalIds = $conversionGoalIds;
$request->ConversionGoalTypes = $conversionGoalTypes;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetConversionGoalsByIds($request);
}
response=campaignmanagement_service.GetConversionGoalsByIds(
ConversionGoalIds=ConversionGoalIds,
ConversionGoalTypes=ConversionGoalTypes,
ReturnAdditionalFields=ReturnAdditionalFields)
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Request Url
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ConversionGoals/QueryByIds
Request Elements
The GetConversionGoalsByIdsRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| ConversionGoalIds | A maximum of 100 identifiers of the conversion goals that you want to get. If ConversionGoalIds is null or empty, then you are effectively requesting all conversion goals of the specified types for the account. |
long array |
| ConversionGoalTypes | The type of conversion goals to return. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <ConversionGoalTypes>Url Duration</ConversionGoalTypes>. |
ConversionGoalType |
| ReturnAdditionalFields | The list of additional properties that you want included within each returned conversion goal. The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional. |
ConversionGoalAdditionalField |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. 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 GetConversionGoalsByIdsResponse 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 JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| ConversionGoals | An array of ConversionGoal objects that corresponds directly to the conversion goal identifiers that you specified in the request. Items of the array may be returned as null. For each array index where a conversion goal was not retrieved, the corresponding element will be null. | ConversionGoal 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 JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"ConversionGoalIds": [
"LongValueHere"
],
"ConversionGoalTypes": "ValueHere",
"ReturnAdditionalFields": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
Below is an example that is applicable if the type of ConversionGoal is AppInstallGoal, BatchError is EditorialError.
{
"ConversionGoals": [
{
"AttributionModelType": "ValueHere",
"ConversionWindowInMinutes": IntValueHere,
"CountType": "ValueHere",
"ExcludeFromBidding": "ValueHere",
"GoalCategory": "ValueHere",
"Id": "LongValueHere",
"IsEnhancedConversionsEnabled": "ValueHere",
"Name": "ValueHere",
"Revenue": {
"CurrencyCode": "ValueHere",
"Type": "ValueHere",
"Value": DecimalValueHere
},
"Scope": "ValueHere",
"Status": "ValueHere",
"TagId": "LongValueHere",
"TrackingStatus": "ValueHere",
"Type": "AppInstall",
"ViewThroughConversionWindowInMinutes": IntValueHere,
"AppPlatform": "ValueHere",
"AppStoreId": "ValueHere"
}
],
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"FieldPath": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Index": IntValueHere,
"Message": "ValueHere",
"Type": "EditorialError",
"Appealable": "ValueHere",
"DisapprovedText": "ValueHere",
"Location": "ValueHere",
"PublisherCountry": "ValueHere",
"ReasonCode": IntValueHere
}
]
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<GetConversionGoalsByIdsResponse> GetConversionGoalsByIdsAsync(
IList<long> conversionGoalIds,
ConversionGoalType conversionGoalTypes,
ConversionGoalAdditionalField? returnAdditionalFields)
{
var request = new GetConversionGoalsByIdsRequest
{
ConversionGoalIds = conversionGoalIds,
ConversionGoalTypes = conversionGoalTypes,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetConversionGoalsByIdsAsync(r), request));
}
static GetConversionGoalsByIdsResponse getConversionGoalsByIds(
ArrayOflong conversionGoalIds,
ArrayList<ConversionGoalType> conversionGoalTypes,
ArrayList<ConversionGoalAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetConversionGoalsByIdsRequest request = new GetConversionGoalsByIdsRequest();
request.setConversionGoalIds(conversionGoalIds);
request.setConversionGoalTypes(conversionGoalTypes);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getConversionGoalsByIds(request);
}
static function GetConversionGoalsByIds(
$conversionGoalIds,
$conversionGoalTypes,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetConversionGoalsByIdsRequest();
$request->ConversionGoalIds = $conversionGoalIds;
$request->ConversionGoalTypes = $conversionGoalTypes;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetConversionGoalsByIds($request);
}
response=campaignmanagement_service.GetConversionGoalsByIds(
ConversionGoalIds=ConversionGoalIds,
ConversionGoalTypes=ConversionGoalTypes,
ReturnAdditionalFields=ReturnAdditionalFields)