Edit

ConversionGoalAdditionalField Value Set - Campaign Management

  • Article

Defines a list of optional conversion goal properties that you can request when calling GetConversionGoalsByIds and GetConversionGoalsByTagIds. 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 properties will be included in the conversion goal by default.

Syntax

<xs:simpleType name="ConversionGoalAdditionalField" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:list>
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="ViewThroughConversionWindowInMinutes" />
        <xs:enumeration value="IsExternallyAttributed" />
        <xs:enumeration value="GoalCategory" />
        <xs:enumeration value="InactiveDueToTagUnavailable" />
        <xs:enumeration value="AttributionModelType" />
        <xs:enumeration value="IsEnhancedConversionsEnabled" />
      </xs:restriction>
    </xs:simpleType>
  </xs:list>
</xs:simpleType>

Values

The ConversionGoalAdditionalField value set has the following values: AttributionModelType, GoalCategory, InactiveDueToTagUnavailable, IsEnhancedConversionsEnabled, IsExternallyAttributed, ViewThroughConversionWindowInMinutes.

Value Description
AttributionModelType Determines which attribution model, LastTouch or LastClick, is used with a conversion goal.
GoalCategory Request that the GoalCategory element be included within each returned ConversionGoal object.
InactiveDueToTagUnavailable Request that the InactiveDueToTagUnavailable value be included within each returned ConversionGoal object.

This status is represented as TagInactive by default. To discover whether the status stored in Microsoft Advertising is InactiveDueToTagUnavailable, you must include InactiveDueToTagUnavailable in the request.
IsEnhancedConversionsEnabled Determines whether enhanced conversions are enabled for a conversion goal.

Note: To create an enhanced conversion goal and set isEnhancedConversionsEnabled=true, you must create a conversion goal for the account via the Microsoft Advertising UI with the enhanced conversion setting selected and the associated checkbox checked.
IsExternallyAttributed Request that the IsExternallyAttributed element be included within each returned OfflineConversionGoal object.
ViewThroughConversionWindowInMinutes Request that the ViewThroughConversionWindowInMinutes element be included within each returned ConversionGoal object.

Requirements

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

Used By

GetConversionGoalsByIds
GetConversionGoalsByTagIds