legacy-libs/google-proto-files/google/ads/googleads/v1/resources/conversion_action.proto

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