1 // Copyright 2018 Google LLC.
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
7 // http://www.apache.org/licenses/LICENSE-2.0
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.
18 package google.ads.googleads.v0.resources;
20 import "google/ads/googleads/v0/common/tag_snippet.proto";
21 import "google/ads/googleads/v0/enums/attribution_model.proto";
22 import "google/ads/googleads/v0/enums/conversion_action_category.proto";
23 import "google/ads/googleads/v0/enums/conversion_action_counting_type.proto";
24 import "google/ads/googleads/v0/enums/conversion_action_status.proto";
25 import "google/ads/googleads/v0/enums/conversion_action_type.proto";
26 import "google/ads/googleads/v0/enums/data_driven_model_status.proto";
27 import "google/protobuf/wrappers.proto";
29 option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
30 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/resources;resources";
31 option java_multiple_files = true;
32 option java_outer_classname = "ConversionActionProto";
33 option java_package = "com.google.ads.googleads.v0.resources";
34 option objc_class_prefix = "GAA";
35 option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
36 option ruby_package = "Google::Ads::GoogleAds::V0::Resources";
38 // Proto file describing the Conversion Action resource.
40 // A conversion action.
41 message ConversionAction {
42 // Settings related to this conversion action's attribution model.
43 message AttributionModelSettings {
44 // The attribution model type of this conversion action.
45 google.ads.googleads.v0.enums.AttributionModelEnum.AttributionModel
46 attribution_model = 1;
48 // The status of the data-driven attribution model for the conversion
50 google.ads.googleads.v0.enums.DataDrivenModelStatusEnum
51 .DataDrivenModelStatus data_driven_model_status = 2;
54 // Settings related to the value for conversion events associated with this
56 message ValueSettings {
57 // The value to use when conversion events for this conversion action are
58 // sent with an invalid, disallowed or missing value, or when
59 // this conversion action is configured to always use the default value.
60 google.protobuf.DoubleValue default_value = 1;
62 // The currency code to use when conversion events for this conversion
63 // action are sent with an invalid or missing currency code, or when this
64 // conversion action is configured to always use the default value.
65 google.protobuf.StringValue default_currency_code = 2;
67 // Controls whether the default value and default currency code are used in
68 // place of the value and currency code specified in conversion events for
69 // this conversion action.
70 google.protobuf.BoolValue always_use_default_value = 3;
73 // The resource name of the conversion action.
74 // Conversion action resource names have the form:
76 // `customers/{customer_id}/conversionActions/{conversion_action_id}`
77 string resource_name = 1;
79 // The ID of the conversion action.
80 google.protobuf.Int64Value id = 2;
82 // The name of the conversion action.
84 // This field is required and should not be empty when creating new
85 // conversion actions.
86 google.protobuf.StringValue name = 3;
88 // The status of this conversion action for conversion event accrual.
89 google.ads.googleads.v0.enums.ConversionActionStatusEnum
90 .ConversionActionStatus status = 4;
92 // The type of this conversion action.
93 google.ads.googleads.v0.enums.ConversionActionTypeEnum.ConversionActionType
96 // The category of conversions reported for this conversion action.
97 google.ads.googleads.v0.enums.ConversionActionCategoryEnum
98 .ConversionActionCategory category = 6;
100 // The resource name of the conversion action owner customer, or null if this
101 // is a system-defined conversion action.
102 google.protobuf.StringValue owner_customer = 7;
104 // Whether this conversion action should be included in the "conversions"
106 google.protobuf.BoolValue include_in_conversions_metric = 8;
108 // The maximum number of days that may elapse between an interaction
109 // (e.g., a click) and a conversion event.
110 google.protobuf.Int64Value click_through_lookback_window_days = 9;
112 // The maximum number of days which may elapse between an impression and a
113 // conversion without an interaction.
114 google.protobuf.Int64Value view_through_lookback_window_days = 10;
116 // Settings related to the value for conversion events associated with this
117 // conversion action.
118 ValueSettings value_settings = 11;
120 // How to count conversion events for the conversion action.
121 google.ads.googleads.v0.enums.ConversionActionCountingTypeEnum
122 .ConversionActionCountingType counting_type = 12;
124 // Settings related to this conversion action's attribution model.
125 AttributionModelSettings attribution_model_settings = 13;
127 // The snippets used for tracking conversions.
128 repeated google.ads.googleads.v0.common.TagSnippet tag_snippets = 14;
130 // The phone call duration in seconds after which a conversion should be
131 // reported for this conversion action.
133 // The value must be between 0 and 10000, inclusive.
134 google.protobuf.Int64Value phone_call_duration_seconds = 15;
136 // App ID for an app conversion action.
137 google.protobuf.StringValue app_id = 16;