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/conversion_custom_variable_cardinality.proto"; 20import "google/ads/searchads360/v0/enums/conversion_custom_variable_family.proto"; 21import "google/ads/searchads360/v0/enums/conversion_custom_variable_status.proto"; 22import "google/ads/searchads360/v0/enums/floodlight_variable_data_type.proto"; 23import "google/ads/searchads360/v0/enums/floodlight_variable_type.proto"; 24import "google/api/field_behavior.proto"; 25import "google/api/resource.proto"; 26 27option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; 28option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; 29option java_multiple_files = true; 30option java_outer_classname = "ConversionCustomVariableProto"; 31option java_package = "com.google.ads.searchads360.v0.resources"; 32option objc_class_prefix = "GASA360"; 33option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; 34option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; 35 36// Proto file describing the Conversion Custom Variable resource. 37 38// A conversion custom variable. 39// See "About custom Floodlight metrics and dimensions in the new 40// Search Ads 360" at https://support.google.com/sa360/answer/13567857 41message ConversionCustomVariable { 42 option (google.api.resource) = { 43 type: "searchads360.googleapis.com/ConversionCustomVariable" 44 pattern: "customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}" 45 }; 46 47 // Information for Search Ads 360 Floodlight Conversion Custom Variables. 48 message FloodlightConversionCustomVariableInfo { 49 // Output only. Floodlight variable type defined in Search Ads 360. 50 optional google.ads.searchads360.v0.enums.FloodlightVariableTypeEnum 51 .FloodlightVariableType floodlight_variable_type = 1 52 [(google.api.field_behavior) = OUTPUT_ONLY]; 53 54 // Output only. Floodlight variable data type defined in Search Ads 360. 55 optional google.ads.searchads360.v0.enums.FloodlightVariableDataTypeEnum 56 .FloodlightVariableDataType floodlight_variable_data_type = 2 57 [(google.api.field_behavior) = OUTPUT_ONLY]; 58 } 59 60 // Immutable. The resource name of the conversion custom variable. 61 // Conversion custom variable resource names have the form: 62 // 63 // `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}` 64 string resource_name = 1 [ 65 (google.api.field_behavior) = IMMUTABLE, 66 (google.api.resource_reference) = { 67 type: "searchads360.googleapis.com/ConversionCustomVariable" 68 } 69 ]; 70 71 // Output only. The ID of the conversion custom variable. 72 int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; 73 74 // Required. The name of the conversion custom variable. 75 // Name should be unique. The maximum length of name is 100 characters. 76 // There should not be any extra spaces before and after. 77 string name = 3 [(google.api.field_behavior) = REQUIRED]; 78 79 // Required. Immutable. The tag of the conversion custom variable. 80 // Tag should be unique and consist of a "u" character directly followed with 81 // a number less than ormequal to 100. For example: "u4". 82 string tag = 4 [ 83 (google.api.field_behavior) = REQUIRED, 84 (google.api.field_behavior) = IMMUTABLE 85 ]; 86 87 // The status of the conversion custom variable for conversion event accrual. 88 google.ads.searchads360.v0.enums.ConversionCustomVariableStatusEnum 89 .ConversionCustomVariableStatus status = 5; 90 91 // Output only. The resource name of the customer that owns the conversion 92 // custom variable. 93 string owner_customer = 6 [ 94 (google.api.field_behavior) = OUTPUT_ONLY, 95 (google.api.resource_reference) = { 96 type: "searchads360.googleapis.com/Customer" 97 } 98 ]; 99 100 // Output only. Family of the conversion custom variable. 101 google.ads.searchads360.v0.enums.ConversionCustomVariableFamilyEnum 102 .ConversionCustomVariableFamily family = 7 103 [(google.api.field_behavior) = OUTPUT_ONLY]; 104 105 // Output only. Cardinality of the conversion custom variable. 106 google.ads.searchads360.v0.enums.ConversionCustomVariableCardinalityEnum 107 .ConversionCustomVariableCardinality cardinality = 8 108 [(google.api.field_behavior) = OUTPUT_ONLY]; 109 110 // Output only. Fields for Search Ads 360 floodlight conversion custom 111 // variables. 112 FloodlightConversionCustomVariableInfo 113 floodlight_conversion_custom_variable_info = 9 114 [(google.api.field_behavior) = OUTPUT_ONLY]; 115 116 // Output only. The IDs of custom columns that use this conversion custom 117 // variable. 118 repeated int64 custom_column_ids = 10 119 [(google.api.field_behavior) = OUTPUT_ONLY]; 120} 121