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/api/field_behavior.proto"; 20import "google/api/resource.proto"; 21 22option csharp_namespace = "Google.Ads.GoogleAds.V14.Resources"; 23option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/resources;resources"; 24option java_multiple_files = true; 25option java_outer_classname = "AdParameterProto"; 26option java_package = "com.google.ads.googleads.v14.resources"; 27option objc_class_prefix = "GAA"; 28option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Resources"; 29option ruby_package = "Google::Ads::GoogleAds::V14::Resources"; 30 31// Proto file describing the ad parameter resource. 32 33// An ad parameter that is used to update numeric values (such as prices or 34// inventory levels) in any text line of an ad (including URLs). There can 35// be a maximum of two AdParameters per ad group criterion. (One with 36// parameter_index = 1 and one with parameter_index = 2.) 37// In the ad the parameters are referenced by a placeholder of the form 38// "{param#:value}". For example, "{param1:$17}" 39message AdParameter { 40 option (google.api.resource) = { 41 type: "googleads.googleapis.com/AdParameter" 42 pattern: "customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}" 43 }; 44 45 // Immutable. The resource name of the ad parameter. 46 // Ad parameter resource names have the form: 47 // 48 // `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}` 49 string resource_name = 1 [ 50 (google.api.field_behavior) = IMMUTABLE, 51 (google.api.resource_reference) = { 52 type: "googleads.googleapis.com/AdParameter" 53 } 54 ]; 55 56 // Immutable. The ad group criterion that this ad parameter belongs to. 57 optional string ad_group_criterion = 5 [ 58 (google.api.field_behavior) = IMMUTABLE, 59 (google.api.resource_reference) = { 60 type: "googleads.googleapis.com/AdGroupCriterion" 61 } 62 ]; 63 64 // Immutable. The unique index of this ad parameter. Must be either 1 or 2. 65 optional int64 parameter_index = 6 [(google.api.field_behavior) = IMMUTABLE]; 66 67 // Numeric value to insert into the ad text. The following restrictions 68 // apply: 69 // - Can use comma or period as a separator, with an optional period or 70 // comma (respectively) for fractional values. For example, 1,000,000.00 71 // and 2.000.000,10 are valid. 72 // - Can be prepended or appended with a currency symbol. For example, 73 // $99.99 is valid. 74 // - Can be prepended or appended with a currency code. For example, 99.99USD 75 // and EUR200 are valid. 76 // - Can use '%'. For example, 1.0% and 1,0% are valid. 77 // - Can use plus or minus. For example, -10.99 and 25+ are valid. 78 // - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are 79 // valid. 80 optional string insertion_text = 7; 81} 82