Изменить

Поделиться через

ApplyOfflineConversions Service Operation - Campaign Management

  • Статья

Applies offline conversions for the account with Microsoft Click Id among other offline conversion data.

Let's say a customer sees your ad, clicks on it, but ends up calling you, leading to a sale that was taken offline. How can you track when your search ad leads to a conversion offline and outside of your website? You can import offline conversions, to better measure what happens after your ad was clicked.

After creating an OfflineConversionGoal, you'll need to wait two hours before sending Microsoft Advertising any offline conversions. If you do not wait two hours, then your offline conversion data might not be applied. After you send Microsoft Advertising the offline conversions, it can take up to six hours to view conversion data.

Each offline conversion can be split across multiple click IDs. A single click ID can, however, be associated with multiple conversion goals and also be associated with the same goal multiple times, as long as the conversion time is different. Also, the same conversion can't be imported more than once. If more than one is attempted, the first instance will be used and the others will be ignored.

The value of the conversion can be included in the import file along with a custom currency. If no currency is stated, the conversion goal's default will be used.

For more information, see Tracking offline conversions.

Request Elements

The ApplyOfflineConversionsRequest 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
OfflineConversions The list of offline conversions for the account.

You can add a maximum of 1,000 offline conversions per service request.

Each offline conversion can be split across multiple click IDs. A single click ID can, however, be associated with multiple conversion goals and also be associated with the same goal multiple times, as long as the conversion time is different. Also, the same conversion can't be applied more than once. If you send Microsoft Advertising duplicates, the first instance will be used and the others will be ignored.		 OfflineConversion 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 ApplyOfflineConversionsResponse 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
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">ApplyOfflineConversions</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>
    <ApplyOfflineConversionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <OfflineConversions i:nil="false">
        <OfflineConversion>
          <ConversionCurrencyCode i:nil="false">ValueHere</ConversionCurrencyCode>
          <ConversionName i:nil="false">ValueHere</ConversionName>
          <ConversionTime>ValueHere</ConversionTime>
          <ConversionValue i:nil="false">ValueHere</ConversionValue>
          <ExternalAttributionCredit i:nil="false">ValueHere</ExternalAttributionCredit>
          <ExternalAttributionModel i:nil="false">ValueHere</ExternalAttributionModel>
          <HashedEmailAddress i:nil="false">ValueHere</HashedEmailAddress>
          <HashedPhoneNumber i:nil="false">ValueHere</HashedPhoneNumber>
          <MicrosoftClickId i:nil="false">ValueHere</MicrosoftClickId>
        </OfflineConversion>
      </OfflineConversions>
    </ApplyOfflineConversionsRequest>
  </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>
    <ApplyOfflineConversionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <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:e139="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e139:KeyValuePairOfstringstring>
              <e139:key d4p1:nil="false">ValueHere</e139:key>
              <e139:value d4p1:nil="false">ValueHere</e139:value>
            </e139: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>
    </ApplyOfflineConversionsResponse>
  </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<ApplyOfflineConversionsResponse> ApplyOfflineConversionsAsync(
	IList<OfflineConversion> offlineConversions)
{
	var request = new ApplyOfflineConversionsRequest
	{
		OfflineConversions = offlineConversions
	};

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

static ApplyOfflineConversionsResponse applyOfflineConversions(
	ArrayOfOfflineConversion offlineConversions) throws RemoteException, Exception
{
	ApplyOfflineConversionsRequest request = new ApplyOfflineConversionsRequest();

	request.setOfflineConversions(offlineConversions);

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

static function ApplyOfflineConversions(
	$offlineConversions)
{

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

	$request = new ApplyOfflineConversionsRequest();

	$request->OfflineConversions = $offlineConversions;

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

response=campaignmanagement_service.ApplyOfflineConversions(
	OfflineConversions=OfflineConversions)

Requirements

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

Request Url

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/OfflineConversions/Apply

Request Elements

The ApplyOfflineConversionsRequest 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
OfflineConversions The list of offline conversions for the account.

You can add a maximum of 1,000 offline conversions per service request.

Each offline conversion can be split across multiple click IDs. A single click ID can, however, be associated with multiple conversion goals and also be associated with the same goal multiple times, as long as the conversion time is different. Also, the same conversion can't be applied more than once. If you send Microsoft Advertising duplicates, the first instance will be used and the others will be ignored.		 OfflineConversion array

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 ApplyOfflineConversionsResponse 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
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.

{
  "OfflineConversions": [
    {
      "ConversionCurrencyCode": "ValueHere",
      "ConversionName": "ValueHere",
      "ConversionTime": "ValueHere",
      "ConversionValue": DoubleValueHere,
      "ExternalAttributionCredit": DoubleValueHere,
      "ExternalAttributionModel": "ValueHere",
      "HashedEmailAddress": "ValueHere",
      "HashedPhoneNumber": "ValueHere",
      "MicrosoftClickId": "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.

{
  "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<ApplyOfflineConversionsResponse> ApplyOfflineConversionsAsync(
	IList<OfflineConversion> offlineConversions)
{
	var request = new ApplyOfflineConversionsRequest
	{
		OfflineConversions = offlineConversions
	};

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

static ApplyOfflineConversionsResponse applyOfflineConversions(
	ArrayOfOfflineConversion offlineConversions) throws RemoteException, Exception
{
	ApplyOfflineConversionsRequest request = new ApplyOfflineConversionsRequest();

	request.setOfflineConversions(offlineConversions);

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

static function ApplyOfflineConversions(
	$offlineConversions)
{

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

	$request = new ApplyOfflineConversionsRequest();

	$request->OfflineConversions = $offlineConversions;

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

response=campaignmanagement_service.ApplyOfflineConversions(
	OfflineConversions=OfflineConversions)