InStoreTransactionGoal Data Object - Campaign Management
Defines an in-store transaction goal.
In-store transactions empower retail advertisers with a holistic view of return on ad spend. You can observe how specific Microsoft Advertising accounts and campaigns drive offline purchases.
Note
In-store transaction goals are only available for alpha pilot customers. Only one in-store transaction goal can be created per customer.
Syntax
<xs:complexType name="InStoreTransactionGoal" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:ConversionGoal">
<xs:sequence />
</xs:extension>
</xs:complexContent>
</xs:complexType>
Elements
The InStoreTransactionGoal object has Inherited Elements.
Inherited Elements
Inherited Elements from ConversionGoal
The InStoreTransactionGoal 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 InStoreTransactionGoal, and might not apply to other objects that inherit the same elements from the ConversionGoal object.
| Element | Description | Data Type |
|---|---|---|
| AttributionModelType | Not applicable for in-store transaction 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 | This determines how your conversions are recorded within your chosen conversion window. There are two choices, and if you do not set a value the default is All: - All: All conversions that happen after an ad click will be counted. This is a common choice for sales. - Unique: Only one conversion that happens after an ad click will be counted. This is a common choice for leads. For example: You track two conversions: leads and sales. You pick Unique for leads and All for sales. When one ad click turns into two leads and two sales, it's counted as three conversions: one for the unique lead, and two for all the sales. Add: Optional Update: Optional |
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. In-store transaction goals only support the Purchase category. Add: Optional. If you leave this element nil or empty, the default category will be set to Purchase. 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. You must specify the ConversionGoalRevenue CurrencyCode when adding or updating an in-store transaction goal. 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. For in-store transaction 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 in-store transaction goals. | long |
| TrackingStatus | Not applicable for in-store transaction goals. | ConversionGoalTrackingStatus |
| Type | The type of the conversion goal. This value is InStoreTransaction when you retrieve an in-store transaction 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 in-store transaction goals. | int |
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for