Edit

Share via

AppInstallGoal Data Object - Campaign Management

  • Article

Defines an app install conversion goal. Use this type of goal to track every time someone installs your app as a conversion.

For other conversion goal types you create a Universal Event Tracking (UET) tag, add it to your website, and then create a conversion goal. But for app install conversion goals, all you have to do is use the app-specific URL that is provided by the Microsoft Advertising-certified partner. For more information, please see How to track mobile app installs as conversions.

Tip

For an implementation overview, see the Universal Event Tracking technical guide.

Syntax

<xs:complexType name="AppInstallGoal" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ConversionGoal">
      <xs:sequence>
        <xs:element minOccurs="0" name="AppPlatform" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="AppStoreId" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The AppInstallGoal object has the following elements: AppPlatform, AppStoreId.

Element Description Data Type
AppPlatform The application platform.

Possible values include Android, iOS, Windows and WindowsPhone.

Add: Required
Update: Optional		 string
AppStoreId The application identifier provided by the app store.

Add: Required
Update: Optional		 string

The AppInstallGoal object has Inherited Elements.

Inherited Elements

Inherited Elements from ConversionGoal

The AppInstallGoal object derives from the ConversionGoal object, and inherits the following elements: AttributionModelType, ConversionWindowInMinutes, CountType, ExcludeFromBidding, GoalCategory, Id, IsEnhancedConversionsEnabled, Name, Revenue, Scope, Status, TagId, TrackingStatus, Type, ViewThroughConversionWindowInMinutes. The descriptions below are specific to AppInstallGoal, and might not apply to other objects that inherit the same elements from the ConversionGoal object.

Element Description Data Type
AttributionModelType Not applicable for app install goals. AttributionModelType
ConversionWindowInMinutes The conversion window is the length of time in minutes after a click that you want to track conversions. If you set this value to 43200 minutes (30 days), then conversions that happen within 30 days after a click are tracked. Past conversions aren't affected. The minimum value supported is 1 minute, although keep in mind that a shorter conversion window will reduce the number of conversions your account records. The maximum value supported is 129600 minutes (90 days).

Add: Optional
Update: Optional		 int
CountType Not applicable for app install goals. ConversionGoalCountType
ExcludeFromBidding Determines whether or not to exclude data otherwise related to this conversion goal from a subset of performance report columns.

This element is only available for customers who are enabled for the Include in Conversions feature (GetCustomerPilotFeatures returns 574).

If this element is set to true, data otherwise related to this conversion goal will be excluded from the Conversions, ConversionRate, CostPerConversion, ReturnOnAdSpend, RevenuePerConversion, and Revenue report columns. Also, if you use an automated bidding bid strategy, setting this property true will result in the goal's conversions no longer factoring into automated bidding calculations. Setting this property "true" is effectively the same as unchecking "Include in Conversions" in the Microsoft Advertising web application.

Regardless of this element value, the AllConversions, AllConversionRate, AllCostPerConversion, AllReturnOnAdSpend, AllRevenuePerConversion, and AllRevenue report columns will include data for all conversion goals. By default this element is false, and data related to this conversion goal are included in all report columns.

For more information, see Report Attributes and Performance Statistics and the help article Conversion goals: "Conversions" versus "All conversions".

Add: Optional
Update: Optional		 boolean
GoalCategory The category used to segment the conversion goal.

Categorize your conversion goals however makes sense for your business. Goal categories don't affect performance - they are here to help you segment your goals and their performance metrics.

The supported category values vary by conversion goal type. App install goals only support the Download category.

Add: Optional. If you leave this element nil or empty, the default category will be set to Download.
Update: Optional. If no value is set for the update, this setting is not changed.		 ConversionGoalCategory
Id The unique Microsoft Advertising identifier for the conversion goal.

Add: Read-only
Update: Required and Read-Only		 long
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.		 boolean
Name The conversion goal name.

The maximum length of the name is 100, and the name must be unique among all conversion goals belonging to the same customer.

Add: Required
Update: Optional		 string
Revenue Determines how much each conversion is worth to your business.

When adding a conversion goal if you do not specify any revenue tracking preferences, then each ConversionGoalRevenue will be set to their respective default values.

When updating a conversion goal, if the Revenue element is nil or empty then none of the nested properties will be updated. However, if this element is not nil or empty then you are effectively replacing any existing revenue properties.

The VariableValue option is not available for app install conversion goals.

Add: Optional
Update: Optional		 ConversionGoalRevenue
Scope Determines if the goal applies to all accounts or only the account specified in the required CustomerAccountId header element. If you have multiple Microsoft Advertising accounts, you can track conversions across all of those accounts. If you associate a goal with one account, conversions will be tracked for that account only.

For app install goals the Account level scope is not supported. You can set this element to Customer or leave it nil. If not specified, the scope will be set to Customer by default.

Add: Optional
Update: Optional		 EntityScope
Status Defines the possible user-determined status values of a conversion goal. These are the status values that a user can decide to set, for example a goal can be set to Paused if you no longer wish to track conversions for that goal.

For status values that can be set by the system, see the TrackingStatus element.

Add: Optional
Update: Optional		 ConversionGoalStatus
TagId Not applicable for app install goals. long
TrackingStatus Defines the possible system-determined status values of a conversion goal. These are the status values that can be set by the system, for example the system sets the status to RecordingConversions if we have recorded conversions within the last 7 days.

Only the NoRecentConversions and RecordingConversions statuses are applicable for app install conversion goals.

For status values that a user can decide to set, for example setting the status to Paused if you no longer wish to track conversions for that goal, see the Status element.

Add: Read-only
Update: Read-only		 ConversionGoalTrackingStatus
Type The type of the conversion goal. This value is AppInstall when you retrieve an app install goal. For more information about conversion goal types, see the ConversionGoal Data Object Remarks.

Add: Read-only
Update: Read-only		 ConversionGoalType
ViewThroughConversionWindowInMinutes Not applicable for app install goals. int

Requirements

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