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.googleads.v14.resources; 18 19import "google/ads/googleads/v14/enums/customer_status.proto"; 20import "google/api/field_behavior.proto"; 21import "google/api/resource.proto"; 22 23option csharp_namespace = "Google.Ads.GoogleAds.V14.Resources"; 24option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/resources;resources"; 25option java_multiple_files = true; 26option java_outer_classname = "CustomerClientProto"; 27option java_package = "com.google.ads.googleads.v14.resources"; 28option objc_class_prefix = "GAA"; 29option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Resources"; 30option ruby_package = "Google::Ads::GoogleAds::V14::Resources"; 31 32// Proto file describing the CustomerClient resource. 33 34// A link between the given customer and a client customer. CustomerClients only 35// exist for manager customers. All direct and indirect client customers are 36// included, as well as the manager itself. 37message CustomerClient { 38 option (google.api.resource) = { 39 type: "googleads.googleapis.com/CustomerClient" 40 pattern: "customers/{customer_id}/customerClients/{client_customer_id}" 41 }; 42 43 // Output only. The resource name of the customer client. 44 // CustomerClient resource names have the form: 45 // `customers/{customer_id}/customerClients/{client_customer_id}` 46 string resource_name = 1 [ 47 (google.api.field_behavior) = OUTPUT_ONLY, 48 (google.api.resource_reference) = { 49 type: "googleads.googleapis.com/CustomerClient" 50 } 51 ]; 52 53 // Output only. The resource name of the client-customer which is linked to 54 // the given customer. Read only. 55 optional string client_customer = 12 [ 56 (google.api.field_behavior) = OUTPUT_ONLY, 57 (google.api.resource_reference) = { 58 type: "googleads.googleapis.com/Customer" 59 } 60 ]; 61 62 // Output only. Specifies whether this is a 63 // [hidden account](https://support.google.com/google-ads/answer/7519830). 64 // Read only. 65 optional bool hidden = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; 66 67 // Output only. Distance between given customer and client. For self link, the 68 // level value will be 0. Read only. 69 optional int64 level = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; 70 71 // Output only. Common Locale Data Repository (CLDR) string representation of 72 // the time zone of the client, for example, America/Los_Angeles. Read only. 73 optional string time_zone = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; 74 75 // Output only. Identifies if the client is a test account. Read only. 76 optional bool test_account = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; 77 78 // Output only. Identifies if the client is a manager. Read only. 79 optional bool manager = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; 80 81 // Output only. Descriptive name for the client. Read only. 82 optional string descriptive_name = 18 83 [(google.api.field_behavior) = OUTPUT_ONLY]; 84 85 // Output only. Currency code (for example, 'USD', 'EUR') for the client. Read 86 // only. 87 optional string currency_code = 19 88 [(google.api.field_behavior) = OUTPUT_ONLY]; 89 90 // Output only. The ID of the client customer. Read only. 91 optional int64 id = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; 92 93 // Output only. The resource names of the labels owned by the requesting 94 // customer that are applied to the client customer. Label resource names have 95 // the form: 96 // 97 // `customers/{customer_id}/labels/{label_id}` 98 repeated string applied_labels = 21 [ 99 (google.api.field_behavior) = OUTPUT_ONLY, 100 (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" } 101 ]; 102 103 // Output only. The status of the client customer. Read only. 104 google.ads.googleads.v14.enums.CustomerStatusEnum.CustomerStatus status = 22 105 [(google.api.field_behavior) = OUTPUT_ONLY]; 106} 107