xref: /aosp_15_r20/external/googleapis/google/ads/searchads360/v0/resources/conversion_action.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9) 
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.ads.searchads360.v0.resources;
18
19import "google/ads/searchads360/v0/enums/attribution_model.proto";
20import "google/ads/searchads360/v0/enums/conversion_action_category.proto";
21import "google/ads/searchads360/v0/enums/conversion_action_status.proto";
22import "google/ads/searchads360/v0/enums/conversion_action_type.proto";
23import "google/ads/searchads360/v0/enums/data_driven_model_status.proto";
24import "google/api/field_behavior.proto";
25import "google/api/resource.proto";
26
27option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources";
28option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources";
29option java_multiple_files = true;
30option java_outer_classname = "ConversionActionProto";
31option java_package = "com.google.ads.searchads360.v0.resources";
32option objc_class_prefix = "GASA360";
33option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources";
34option ruby_package = "Google::Ads::SearchAds360::V0::Resources";
35
36// Proto file describing the Conversion Action resource.
37
38// A conversion action.
39message ConversionAction {
40  option (google.api.resource) = {
41    type: "searchads360.googleapis.com/ConversionAction"
42    pattern: "customers/{customer_id}/conversionActions/{conversion_type_id}"
43  };
44
45  // Settings related to this conversion action's attribution model.
46  message AttributionModelSettings {
47    // The attribution model type of this conversion action.
48    google.ads.searchads360.v0.enums.AttributionModelEnum.AttributionModel
49        attribution_model = 1;
50
51    // Output only. The status of the data-driven attribution model for the
52    // conversion action.
53    google.ads.searchads360.v0.enums.DataDrivenModelStatusEnum
54        .DataDrivenModelStatus data_driven_model_status = 2
55        [(google.api.field_behavior) = OUTPUT_ONLY];
56  }
57
58  // Settings related to the value for conversion events associated with this
59  // conversion action.
60  message ValueSettings {
61    // The value to use when conversion events for this conversion action are
62    // sent with an invalid, disallowed or missing value, or when
63    // this conversion action is configured to always use the default value.
64    optional double default_value = 4;
65
66    // The currency code to use when conversion events for this conversion
67    // action are sent with an invalid or missing currency code, or when this
68    // conversion action is configured to always use the default value.
69    optional string default_currency_code = 5;
70
71    // Controls whether the default value and default currency code are used in
72    // place of the value and currency code specified in conversion events for
73    // this conversion action.
74    optional bool always_use_default_value = 6;
75  }
76
77  // Settings related to a Floodlight conversion action.
78  message FloodlightSettings {
79    // Output only. String used to identify a Floodlight activity group when
80    // reporting conversions.
81    string activity_group_tag = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
82
83    // Output only. String used to identify a Floodlight activity when reporting
84    // conversions.
85    string activity_tag = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
86
87    // Output only. ID of the Floodlight activity in DoubleClick Campaign
88    // Manager (DCM).
89    int64 activity_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
90  }
91
92  // Immutable. The resource name of the conversion action.
93  // Conversion action resource names have the form:
94  //
95  // `customers/{customer_id}/conversionActions/{conversion_action_id}`
96  string resource_name = 1 [
97    (google.api.field_behavior) = IMMUTABLE,
98    (google.api.resource_reference) = {
99      type: "searchads360.googleapis.com/ConversionAction"
100    }
101  ];
102
103  // Output only. The ID of the conversion action.
104  optional int64 id = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
105
106  // The name of the conversion action.
107  //
108  // This field is required and should not be empty when creating new
109  // conversion actions.
110  optional string name = 22;
111
112  // Output only. Timestamp of the Floodlight activity's creation, formatted in
113  // ISO 8601.
114  string creation_time = 33 [(google.api.field_behavior) = OUTPUT_ONLY];
115
116  // The status of this conversion action for conversion event accrual.
117  google.ads.searchads360.v0.enums.ConversionActionStatusEnum
118      .ConversionActionStatus status = 4;
119
120  // Immutable. The type of this conversion action.
121  google.ads.searchads360.v0.enums.ConversionActionTypeEnum.ConversionActionType
122      type = 5 [(google.api.field_behavior) = IMMUTABLE];
123
124  // If a conversion action's primary_for_goal bit is false, the conversion
125  // action is non-biddable for all campaigns regardless of their customer
126  // conversion goal or campaign conversion goal.
127  // However, custom conversion goals do not respect primary_for_goal, so if
128  // a campaign has a custom conversion goal configured with a
129  // primary_for_goal = false conversion action, that conversion action is
130  // still biddable.
131  // By default, primary_for_goal will be true if not set. In V9,
132  // primary_for_goal can only be set to false after creation through an
133  // 'update' operation because it's not declared as optional.
134  optional bool primary_for_goal = 31;
135
136  // The category of conversions reported for this conversion action.
137  google.ads.searchads360.v0.enums.ConversionActionCategoryEnum
138      .ConversionActionCategory category = 6;
139
140  // Output only. The resource name of the conversion action owner customer, or
141  // null if this is a system-defined conversion action.
142  optional string owner_customer = 23 [
143    (google.api.field_behavior) = OUTPUT_ONLY,
144    (google.api.resource_reference) = {
145      type: "searchads360.googleapis.com/Customer"
146    }
147  ];
148
149  // Whether this conversion action should be included in the
150  // "client_account_conversions" metric.
151  optional bool include_in_client_account_conversions_metric = 24;
152
153  // Output only. Whether this conversion action should be included in the
154  // "conversions" metric.
155  optional bool include_in_conversions_metric = 32
156      [(google.api.field_behavior) = OUTPUT_ONLY];
157
158  // The maximum number of days that may elapse between an interaction
159  // (for example, a click) and a conversion event.
160  optional int64 click_through_lookback_window_days = 25;
161
162  // Settings related to the value for conversion events associated with this
163  // conversion action.
164  ValueSettings value_settings = 11;
165
166  // Settings related to this conversion action's attribution model.
167  AttributionModelSettings attribution_model_settings = 13;
168
169  // App ID for an app conversion action.
170  optional string app_id = 28;
171
172  // Output only. Floodlight settings for Floodlight conversion types.
173  FloodlightSettings floodlight_settings = 29
174      [(google.api.field_behavior) = OUTPUT_ONLY];
175}
176