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/account_status.proto"; 20import "google/ads/searchads360/v0/enums/account_type.proto"; 21import "google/ads/searchads360/v0/enums/conversion_tracking_status_enum.proto"; 22import "google/ads/searchads360/v0/enums/customer_status.proto"; 23import "google/api/field_behavior.proto"; 24import "google/api/resource.proto"; 25 26option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; 27option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; 28option java_multiple_files = true; 29option java_outer_classname = "CustomerProto"; 30option java_package = "com.google.ads.searchads360.v0.resources"; 31option objc_class_prefix = "GASA360"; 32option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; 33option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; 34 35// Proto file describing the Customer resource. 36 37// A customer. 38message Customer { 39 option (google.api.resource) = { 40 type: "searchads360.googleapis.com/Customer" 41 pattern: "customers/{customer_id}" 42 }; 43 44 // Immutable. The resource name of the customer. 45 // Customer resource names have the form: 46 // 47 // `customers/{customer_id}` 48 string resource_name = 1 [ 49 (google.api.field_behavior) = IMMUTABLE, 50 (google.api.resource_reference) = { 51 type: "searchads360.googleapis.com/Customer" 52 } 53 ]; 54 55 // Output only. The ID of the customer. 56 optional int64 id = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; 57 58 // Optional, non-unique descriptive name of the customer. 59 optional string descriptive_name = 20; 60 61 // Immutable. The currency in which the account operates. 62 // A subset of the currency codes from the ISO 4217 standard is 63 // supported. 64 optional string currency_code = 21 [(google.api.field_behavior) = IMMUTABLE]; 65 66 // Immutable. The local timezone ID of the customer. 67 optional string time_zone = 22 [(google.api.field_behavior) = IMMUTABLE]; 68 69 // The URL template for constructing a tracking URL out of parameters. 70 optional string tracking_url_template = 23; 71 72 // The URL template for appending params to the final URL. 73 optional string final_url_suffix = 24; 74 75 // Whether auto-tagging is enabled for the customer. 76 optional bool auto_tagging_enabled = 25; 77 78 // Output only. Whether the customer is a manager. 79 optional bool manager = 27 [(google.api.field_behavior) = OUTPUT_ONLY]; 80 81 // Output only. Conversion tracking setting for a customer. 82 ConversionTrackingSetting conversion_tracking_setting = 14 83 [(google.api.field_behavior) = OUTPUT_ONLY]; 84 85 // Output only. Engine account type, for example, Google Ads, Microsoft 86 // Advertising, Yahoo Japan, Baidu, Facebook, Engine Track, etc. 87 google.ads.searchads360.v0.enums.AccountTypeEnum.AccountType account_type = 31 88 [(google.api.field_behavior) = OUTPUT_ONLY]; 89 90 // Output only. DoubleClick Campaign Manager (DCM) setting for a manager 91 // customer. 92 DoubleClickCampaignManagerSetting double_click_campaign_manager_setting = 32 93 [(google.api.field_behavior) = OUTPUT_ONLY]; 94 95 // Output only. Account status, for example, Enabled, Paused, Removed, etc. 96 google.ads.searchads360.v0.enums.AccountStatusEnum.AccountStatus 97 account_status = 33 [(google.api.field_behavior) = OUTPUT_ONLY]; 98 99 // Output only. The datetime when this customer was last modified. The 100 // datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" 101 // format. 102 string last_modified_time = 34 [(google.api.field_behavior) = OUTPUT_ONLY]; 103 104 // Output only. ID of the account in the external engine account. 105 string engine_id = 35 [(google.api.field_behavior) = OUTPUT_ONLY]; 106 107 // Output only. The status of the customer. 108 google.ads.searchads360.v0.enums.CustomerStatusEnum.CustomerStatus status = 36 109 [(google.api.field_behavior) = OUTPUT_ONLY]; 110 111 // Output only. The timestamp when this customer was created. The timestamp is 112 // in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. 113 string creation_time = 42 [(google.api.field_behavior) = OUTPUT_ONLY]; 114} 115 116// A collection of customer-wide settings related to Search Ads 360 Conversion 117// Tracking. 118message ConversionTrackingSetting { 119 // Output only. The conversion tracking id used for this account. This id 120 // doesn't indicate whether the customer uses conversion tracking 121 // (conversion_tracking_status does). This field is read-only. 122 optional int64 conversion_tracking_id = 3 123 [(google.api.field_behavior) = OUTPUT_ONLY]; 124 125 // Output only. The conversion tracking id of the customer's manager. This is 126 // set when the customer is opted into conversion tracking, and it overrides 127 // conversion_tracking_id. This field can only be managed through the Google 128 // Ads UI. This field is read-only. 129 optional int64 google_ads_cross_account_conversion_tracking_id = 4 130 [(google.api.field_behavior) = OUTPUT_ONLY]; 131 132 // Output only. The conversion tracking id of the customer's manager. This is 133 // set when the customer is opted into cross-account conversion tracking, and 134 // it overrides conversion_tracking_id. 135 optional int64 cross_account_conversion_tracking_id = 37 136 [(google.api.field_behavior) = OUTPUT_ONLY]; 137 138 // Output only. Whether the customer has accepted customer data terms. If 139 // using cross-account conversion tracking, this value is inherited from the 140 // manager. This field is read-only. For more 141 // information, see https://support.google.com/adspolicy/answer/7475709. 142 bool accepted_customer_data_terms = 5 143 [(google.api.field_behavior) = OUTPUT_ONLY]; 144 145 // Output only. Conversion tracking status. It indicates whether the customer 146 // is using conversion tracking, and who is the conversion tracking owner of 147 // this customer. If this customer is using cross-account conversion tracking, 148 // the value returned will differ based on the `login-customer-id` of the 149 // request. 150 google.ads.searchads360.v0.enums.ConversionTrackingStatusEnum 151 .ConversionTrackingStatus conversion_tracking_status = 6 152 [(google.api.field_behavior) = OUTPUT_ONLY]; 153 154 // Output only. Whether the customer is opted-in for enhanced conversions 155 // for leads. If using cross-account conversion tracking, this value is 156 // inherited from the manager. This field is read-only. 157 bool enhanced_conversions_for_leads_enabled = 7 158 [(google.api.field_behavior) = OUTPUT_ONLY]; 159 160 // Output only. The resource name of the customer where conversions are 161 // created and managed. This field is read-only. 162 string google_ads_conversion_customer = 8 163 [(google.api.field_behavior) = OUTPUT_ONLY]; 164} 165 166// DoubleClick Campaign Manager (DCM) setting for a manager customer. 167message DoubleClickCampaignManagerSetting { 168 // Output only. ID of the Campaign Manager advertiser associated with this 169 // customer. 170 int64 advertiser_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 171 172 // Output only. ID of the Campaign Manager network associated with this 173 // customer. 174 int64 network_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; 175 176 // Output only. Time zone of the Campaign Manager network associated with this 177 // customer in IANA Time Zone Database format, such as America/New_York. 178 string time_zone = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; 179} 180