Edit

OnlineConversionAdjustment Data Object - Campaign Management

  • Article

Defines an object to retract or restate an online conversion.

Syntax

<xs:complexType name="OnlineConversionAdjustment" 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="TransactionId" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

The OnlineConversionAdjustment object has the following elements: AdjustmentCurrencyCode, AdjustmentTime, AdjustmentType, AdjustmentValue, ConversionName, TransactionId.

Element Description Data Type
AdjustmentCurrencyCode The currency code for the restated online 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 online 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 online 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 online conversion goal data will not be applied.

Apply: Required		 string
TransactionId The ID for this transaction. string

Requirements

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

Used By

ApplyOnlineConversionAdjustments