legacy-libs/google-proto-files/google/ads/googleads/v0/resources/customer.proto

   1 // Copyright 2018 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.v0.resources;
  19
  20 import "google/protobuf/wrappers.proto";
  21
  22 option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
  23 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/resources;resources";
  24 option java_multiple_files = true;
  25 option java_outer_classname = "CustomerProto";
  26 option java_package = "com.google.ads.googleads.v0.resources";
  27 option objc_class_prefix = "GAA";
  28 option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
  29 option ruby_package = "Google::Ads::GoogleAds::V0::Resources";
  30
  31 // Proto file describing the Customer resource.
  32
  33 // A customer.
  34 message Customer {
  35   // The resource name of the customer.
  36   // Customer resource names have the form:
  37   //
  38   // `customers/{customer_id}`
  39   string resource_name = 1;
  40
  41   // The ID of the customer.
  42   google.protobuf.Int64Value id = 3;
  43
  44   // Optional, non-unique descriptive name of the customer.
  45   google.protobuf.StringValue descriptive_name = 4;
  46
  47   // The currency in which the account operates.
  48   // A subset of the currency codes from the ISO 4217 standard is
  49   // supported.
  50   google.protobuf.StringValue currency_code = 5;
  51
  52   // The local timezone ID of the customer.
  53   google.protobuf.StringValue time_zone = 6;
  54
  55   // The URL template for constructing a tracking URL out of parameters.
  56   google.protobuf.StringValue tracking_url_template = 7;
  57
  58   // The URL template for appending params to the final URL
  59   google.protobuf.StringValue final_url_suffix = 11;
  60
  61   // Whether auto-tagging is enabled for the customer.
  62   google.protobuf.BoolValue auto_tagging_enabled = 8;
  63
  64   // Whether the Customer has a Partners program badge. If the Customer is not
  65   // associated with the Partners program, this will be false. For more
  66   // information, see https://support.google.com/partners/answer/3125774.
  67   google.protobuf.BoolValue has_partners_badge = 9;
  68
  69   // Whether the customer is a manager.
  70   google.protobuf.BoolValue manager = 12;
  71
  72   // Whether the customer is a test account.
  73   google.protobuf.BoolValue test_account = 13;
  74
  75   // Call reporting setting for a customer.
  76   CallReportingSetting call_reporting_setting = 10;
  77
  78   // Conversion tracking setting for a customer.
  79   ConversionTrackingSetting conversion_tracking_setting = 14;
  80 }
  81
  82 // Call reporting setting for a customer.
  83 message CallReportingSetting {
  84   // Enable reporting of phone call events by redirecting them via Google
  85   // System.
  86   google.protobuf.BoolValue call_reporting_enabled = 1;
  87
  88   // Whether to enable call conversion reporting.
  89   google.protobuf.BoolValue call_conversion_reporting_enabled = 2;
  90
  91   // Customer-level call conversion action to attribute a call conversion to.
  92   // If not set a default conversion action is used. Only in effect when
  93   // call_conversion_reporting_enabled is set to true.
  94   google.protobuf.StringValue call_conversion_action = 9;
  95 }
  96
  97 // A collection of customer-wide settings related to Google Ads Conversion
  98 // Tracking.
  99 message ConversionTrackingSetting {
 100   // The conversion tracking id used for this account. This id is automatically
 101   // assigned after any conversion tracking feature is used. If the customer
 102   // doesn't use conversion tracking, this is 0. This field is read-only.
 103   google.protobuf.Int64Value conversion_tracking_id = 1;
 104
 105   // The conversion tracking id of the customer's manager. This is set when the
 106   // customer is opted into cross account conversion tracking, and it overrides
 107   // conversion_tracking_id. This field can only be managed through the Google
 108   // Ads UI. This field is read-only.
 109   google.protobuf.Int64Value cross_account_conversion_tracking_id = 2;
 110 }