Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Retrieves offline conversion statistics and diagnostics for your accounts. Includes high-level summaries and detailed daily breakdowns to help you understand and troubleshoot unattributed offline conversions.
Request Elements
The GetOfflineConversionReportByGoalIdsRequest 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 |
|---|---|---|
| EndDateUtc | The end date of the report range in Coordinated Universal Time (UTC). The date range is up to 7 days. | dateTime |
| GoalIds | An array of conversion goal IDs used to filter the report. You can specify up to 20 goal IDs. | long array |
| StartDateUtc | The start date of the report range in Coordinated Universal Time (UTC). The date range is up to 7 days. | dateTime |
| UploadChannelFilter | A bitwise combination of upload channel flags. If null, the report includes data from all channels. | OfflineConversionUploadChannel |
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 |
Response Elements
The GetOfflineConversionReportByGoalIdsResponse 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 |
|---|---|---|
| OfflineGoalConversionSummaries | An array containing daily conversion performance summaries, grouped by individual Goal ID. | OfflineGoalConversionSummary array |
| PartialErrors | An array of error objects for specific Goal IDs that failed to retrieve data. Returns successful data for some goals while reporting failures for others. | 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">GetOfflineConversionReportByGoalIds</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>
<GetOfflineConversionReportByGoalIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<StartDateUtc>ValueHere</StartDateUtc>
<EndDateUtc>ValueHere</EndDateUtc>
<GoalIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</GoalIds>
<UploadChannelFilter i:nil="false">ValueHere</UploadChannelFilter>
</GetOfflineConversionReportByGoalIdsRequest>
</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>
<GetOfflineConversionReportByGoalIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<OfflineGoalConversionSummaries d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<OfflineGoalConversionSummary>
<GoalId>ValueHere</GoalId>
<ConversionName d4p1:nil="false">ValueHere</ConversionName>
<OverallSuccessCount>ValueHere</OverallSuccessCount>
<OverallUnattributedCount>ValueHere</OverallUnattributedCount>
<OverallSuccessRate>ValueHere</OverallSuccessRate>
<OverallAlerts d4p1:nil="false">
<OfflineConversionAlert>
<UnattributedReason>ValueHere</UnattributedReason>
<Count>ValueHere</Count>
</OfflineConversionAlert>
</OverallAlerts>
<DailySummaries d4p1:nil="false">
<OfflineGoalDailySummary>
<GoalId>ValueHere</GoalId>
<UploadDate>ValueHere</UploadDate>
<SuccessCount>ValueHere</SuccessCount>
<UnattributedCount>ValueHere</UnattributedCount>
<SuccessRate>ValueHere</SuccessRate>
<Alerts d4p1:nil="false">
<OfflineConversionAlert>
<UnattributedReason>ValueHere</UnattributedReason>
<Count>ValueHere</Count>
</OfflineConversionAlert>
</Alerts>
</OfflineGoalDailySummary>
</DailySummaries>
</OfflineGoalConversionSummary>
</OfflineGoalConversionSummaries>
<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:e375="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e375:KeyValuePairOfstringstring>
<e375:key d4p1:nil="false">ValueHere</e375:key>
<e375:value d4p1:nil="false">ValueHere</e375:value>
</e375: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>
</GetOfflineConversionReportByGoalIdsResponse>
</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<GetOfflineConversionReportByGoalIdsResponse> GetOfflineConversionReportByGoalIdsAsync(
DateTime startDateUtc,
DateTime endDateUtc,
IList<long> goalIds,
OfflineConversionUploadChannel? uploadChannelFilter)
{
var request = new GetOfflineConversionReportByGoalIdsRequest
{
StartDateUtc = startDateUtc,
EndDateUtc = endDateUtc,
GoalIds = goalIds,
UploadChannelFilter = uploadChannelFilter
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetOfflineConversionReportByGoalIdsAsync(r), request));
}
static GetOfflineConversionReportByGoalIdsResponse getOfflineConversionReportByGoalIds(
Calendar startDateUtc,
Calendar endDateUtc,
ArrayOflong goalIds,
ArrayList<OfflineConversionUploadChannel> uploadChannelFilter) throws RemoteException, Exception
{
GetOfflineConversionReportByGoalIdsRequest request = new GetOfflineConversionReportByGoalIdsRequest();
request.setStartDateUtc(startDateUtc);
request.setEndDateUtc(endDateUtc);
request.setGoalIds(goalIds);
request.setUploadChannelFilter(uploadChannelFilter);
return CampaignManagementService.getService().getOfflineConversionReportByGoalIds(request);
}
static function GetOfflineConversionReportByGoalIds(
$startDateUtc,
$endDateUtc,
$goalIds,
$uploadChannelFilter)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetOfflineConversionReportByGoalIdsRequest();
$request->StartDateUtc = $startDateUtc;
$request->EndDateUtc = $endDateUtc;
$request->GoalIds = $goalIds;
$request->UploadChannelFilter = $uploadChannelFilter;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetOfflineConversionReportByGoalIds($request);
}
response=campaignmanagement_service.GetOfflineConversionReportByGoalIds(
StartDateUtc=StartDateUtc,
EndDateUtc=EndDateUtc,
GoalIds=GoalIds,
UploadChannelFilter=UploadChannelFilter)
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Request Url
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/OfflineConversionReport/QueryByGoalIds
Request Elements
The GetOfflineConversionReportByGoalIdsRequest 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 |
|---|---|---|
| EndDateUtc | The end date of the report range in Coordinated Universal Time (UTC). The date range is up to 7 days. | dateTime |
| GoalIds | An array of conversion goal IDs used to filter the report. You can specify up to 20 goal IDs. | long array |
| StartDateUtc | The start date of the report range in Coordinated Universal Time (UTC). The date range is up to 7 days. | dateTime |
| UploadChannelFilter | A bitwise combination of upload channel flags. If null, the report includes data from all channels. | OfflineConversionUploadChannel |
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 |
Response Elements
The GetOfflineConversionReportByGoalIdsResponse 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 |
|---|---|---|
| OfflineGoalConversionSummaries | An array containing daily conversion performance summaries, grouped by individual Goal ID. | OfflineGoalConversionSummary array |
| PartialErrors | An array of error objects for specific Goal IDs that failed to retrieve data. Returns successful data for some goals while reporting failures for others. | 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.
{
"StartDateUtc": "ValueHere",
"EndDateUtc": "ValueHere",
"GoalIds": [
"LongValueHere"
],
"UploadChannelFilter": "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 BatchError is EditorialError.
{
"OfflineGoalConversionSummaries": [
{
"ConversionName": "ValueHere",
"DailySummaries": [
{
"Alerts": [
{
"Count": "LongValueHere",
"UnattributedReason": "ValueHere"
}
],
"GoalId": "LongValueHere",
"SuccessCount": IntValueHere,
"SuccessRate": DecimalValueHere,
"UnattributedCount": IntValueHere,
"UploadDate": "ValueHere"
}
],
"GoalId": "LongValueHere",
"OverallAlerts": [
{
"Count": "LongValueHere",
"UnattributedReason": "ValueHere"
}
],
"OverallSuccessCount": "LongValueHere",
"OverallSuccessRate": DecimalValueHere,
"OverallUnattributedCount": "LongValueHere"
}
],
"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<GetOfflineConversionReportByGoalIdsResponse> GetOfflineConversionReportByGoalIdsAsync(
DateTime startDateUtc,
DateTime endDateUtc,
IList<long> goalIds,
OfflineConversionUploadChannel? uploadChannelFilter)
{
var request = new GetOfflineConversionReportByGoalIdsRequest
{
StartDateUtc = startDateUtc,
EndDateUtc = endDateUtc,
GoalIds = goalIds,
UploadChannelFilter = uploadChannelFilter
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetOfflineConversionReportByGoalIdsAsync(r), request));
}
static GetOfflineConversionReportByGoalIdsResponse getOfflineConversionReportByGoalIds(
Calendar startDateUtc,
Calendar endDateUtc,
ArrayOflong goalIds,
ArrayList<OfflineConversionUploadChannel> uploadChannelFilter) throws RemoteException, Exception
{
GetOfflineConversionReportByGoalIdsRequest request = new GetOfflineConversionReportByGoalIdsRequest();
request.setStartDateUtc(startDateUtc);
request.setEndDateUtc(endDateUtc);
request.setGoalIds(goalIds);
request.setUploadChannelFilter(uploadChannelFilter);
return CampaignManagementService.getService().getOfflineConversionReportByGoalIds(request);
}
static function GetOfflineConversionReportByGoalIds(
$startDateUtc,
$endDateUtc,
$goalIds,
$uploadChannelFilter)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetOfflineConversionReportByGoalIdsRequest();
$request->StartDateUtc = $startDateUtc;
$request->EndDateUtc = $endDateUtc;
$request->GoalIds = $goalIds;
$request->UploadChannelFilter = $uploadChannelFilter;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetOfflineConversionReportByGoalIds($request);
}
response=campaignmanagement_service.GetOfflineConversionReportByGoalIds(
StartDateUtc=StartDateUtc,
EndDateUtc=EndDateUtc,
GoalIds=GoalIds,
UploadChannelFilter=UploadChannelFilter)