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.v16.resources; 18 19import "google/ads/googleads/v16/enums/conversion_custom_variable_status.proto"; 20import "google/api/field_behavior.proto"; 21import "google/api/resource.proto"; 22 23option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources"; 24option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources"; 25option java_multiple_files = true; 26option java_outer_classname = "ConversionCustomVariableProto"; 27option java_package = "com.google.ads.googleads.v16.resources"; 28option objc_class_prefix = "GAA"; 29option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources"; 30option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; 31 32// Proto file describing the Conversion Custom Variable resource. 33 34// A conversion custom variable 35// See "About custom variables for conversions" at 36// https://support.google.com/google-ads/answer/9964350 37message ConversionCustomVariable { 38 option (google.api.resource) = { 39 type: "googleads.googleapis.com/ConversionCustomVariable" 40 pattern: "customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}" 41 }; 42 43 // Immutable. The resource name of the conversion custom variable. 44 // Conversion custom variable resource names have the form: 45 // 46 // `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}` 47 string resource_name = 1 [ 48 (google.api.field_behavior) = IMMUTABLE, 49 (google.api.resource_reference) = { 50 type: "googleads.googleapis.com/ConversionCustomVariable" 51 } 52 ]; 53 54 // Output only. The ID of the conversion custom variable. 55 int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; 56 57 // Required. The name of the conversion custom variable. 58 // Name should be unique. The maximum length of name is 100 characters. 59 // There should not be any extra spaces before and after. 60 string name = 3 [(google.api.field_behavior) = REQUIRED]; 61 62 // Required. Immutable. The tag of the conversion custom variable. It is used 63 // in the event snippet and sent to Google Ads along with conversion pings. 64 // For conversion uploads in Google Ads API, the resource name of the 65 // conversion custom variable is used. Tag should be unique. The maximum size 66 // of tag is 100 bytes. There should not be any extra spaces before and after. 67 // Currently only lowercase letters, numbers and underscores are allowed in 68 // the tag. 69 string tag = 4 [ 70 (google.api.field_behavior) = REQUIRED, 71 (google.api.field_behavior) = IMMUTABLE 72 ]; 73 74 // The status of the conversion custom variable for conversion event accrual. 75 google.ads.googleads.v16.enums.ConversionCustomVariableStatusEnum 76 .ConversionCustomVariableStatus status = 5; 77 78 // Output only. The resource name of the customer that owns the conversion 79 // custom variable. 80 string owner_customer = 6 [ 81 (google.api.field_behavior) = OUTPUT_ONLY, 82 (google.api.resource_reference) = { 83 type: "googleads.googleapis.com/Customer" 84 } 85 ]; 86} 87