OfflineConversionAdjustment Data Object - Campaign Management
Defines an object to retract or restate an offline conversion via the ApplyOfflineConversionAdjustments operation.
You can adjust the conversion time and value for offline conversions previously applied via the ApplyOfflineConversions operation.
Syntax
<xs:complexType name="OfflineConversionAdjustment" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:sequence>
<xs:element minOccurs="0" name="AdjustmentCurrencyCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="AdjustmentTime" type="xs:dateTime" />
<xs:element minOccurs="0" name="AdjustmentType" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="AdjustmentValue" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="ConversionName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ConversionTime" type="xs:dateTime" />
<xs:element minOccurs="0" name="HashedEmailAddress" nillable="true" type="xs:string">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="HashedPhoneNumber" nillable="true" type="xs:string">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="MicrosoftClickId" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
Elements
The OfflineConversionAdjustment object has the following elements: AdjustmentCurrencyCode, AdjustmentTime, AdjustmentType, AdjustmentValue, ConversionName, ConversionTime, HashedEmailAddress, HashedPhoneNumber, MicrosoftClickId.
| Element | Description | Data Type |
|---|---|---|
| AdjustmentCurrencyCode | The currency code for the restated offline conversion. For more information, see Currencies. Apply: Required if AdjustmentType is set to "Restate", and otherwise this field is ignored. If you do not specify an adjustment currency code with the restatement, then the CurrencyCode element of the goal's ConversionGoalRevenue is used. |
string |
| AdjustmentTime | The date and time when the adjustment occurred. The adjustment time cannot be earlier than the original offline conversion date and time. Important: The value must be in Coordinated Universal Time (UTC). This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types. Apply: Required |
dateTime |
| AdjustmentType | Determines whether to retract or restate the offline conversion. If this value is "Restate", the offline conversion previously attributed to the specified MicrosoftClickId will be adjusted according to the new AdjustmentCurrencyCode, AdjustmentTime, and AdjustmentValue. If this value is "Retract", the offline conversion previously attributed to the specified MicrosoftClickId will be retracted or deleted. Apply: Required |
string |
| AdjustmentValue | The adjusted offline conversion value. Apply: Required if AdjustmentType is set to "Restate", and otherwise this field should not be set. |
double |
| ConversionName | The conversion goal name. This name must match an existing conversion goal name, otherwise the offline conversion goal data will not be applied. Apply: Required |
string |
| ConversionTime | The date and time when the original offline conversion occurred. The date and time must be within the last 90 days, otherwise the operation will fail when you attempt to send Microsoft Advertising the offline conversion data. To be counted by Microsoft Advertising as an offline conversion after successful upload, the following additional requirements must be met: - The date and time of the conversion must be set later than the date and time of the recorded click. - The date and time must be within the conversion window. The ConversionWindowInMinutes property of the OfflineConversionGoal determines the maximum length of time in minutes after a click that conversions will be tracked. For example if three clicks were recorded on April 30th, if the ConversionWindowInMinutes of the OfflineConversionGoal is equal to 30 days (43200 minutes), and if you send Microsoft Advertising the following offline conversions on July 31st, then Microsoft Advertising will only count the one with MicrosoftClickId=2 as an offline conversion. - MicrosoftClickId=1; ConversionTime=2020-04-30T17:02:35.6853793Z - MicrosoftClickId=2; ConversionTime=2020-05-15T17:02:35.6853793Z - MicrosoftClickId=3; ConversionTime=2020-06-15T17:02:35.6853793Z The offline conversion data with MicrosoftClickId=1 will not be uploaded since the conversion date and time is more than 90 days ago, and the offline conversion data with MicrosoftClickId=3 will not be counted because it does not fall within the conversion window (April 30 through May 29). Important: The value must be in Coordinated Universal Time (UTC). This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types. Apply: Required |
dateTime |
| HashedEmailAddress | The hashed email address using the SHA-256 algorithm for use with enhanced conversions. | string |
| HashedPhoneNumber | The hashed phone number according to the E.164 standard for use with enhanced conversions. | string |
| MicrosoftClickId | The MSCLKID for the offline conversion. To ensure that auto-tagging is enabled for Microsoft click ID tracking, use the GetAccountProperties and SetAccountProperties operations. Apply: Optional Note: The MSCLKID is optional when you provide a hashed email address or phone number for enhanced conversions. |
string |
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13