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_action_category.proto"; 20import "google/ads/googleads/v16/enums/conversion_value_rule_set_status.proto"; 21import "google/ads/googleads/v16/enums/value_rule_set_attachment_type.proto"; 22import "google/ads/googleads/v16/enums/value_rule_set_dimension.proto"; 23import "google/api/field_behavior.proto"; 24import "google/api/resource.proto"; 25 26option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources"; 27option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources"; 28option java_multiple_files = true; 29option java_outer_classname = "ConversionValueRuleSetProto"; 30option java_package = "com.google.ads.googleads.v16.resources"; 31option objc_class_prefix = "GAA"; 32option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources"; 33option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; 34 35// Proto file describing the Conversion Value Rule Set resource. 36 37// A conversion value rule set 38message ConversionValueRuleSet { 39 option (google.api.resource) = { 40 type: "googleads.googleapis.com/ConversionValueRuleSet" 41 pattern: "customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}" 42 }; 43 44 // Immutable. The resource name of the conversion value rule set. 45 // Conversion value rule set resource names have the form: 46 // 47 // `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}` 48 string resource_name = 1 [ 49 (google.api.field_behavior) = IMMUTABLE, 50 (google.api.resource_reference) = { 51 type: "googleads.googleapis.com/ConversionValueRuleSet" 52 } 53 ]; 54 55 // Output only. The ID of the conversion value rule set. 56 int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; 57 58 // Resource names of rules within the rule set. 59 repeated string conversion_value_rules = 3 60 [(google.api.resource_reference) = { 61 type: "googleads.googleapis.com/ConversionValueRule" 62 }]; 63 64 // Defines dimensions for Value Rule conditions. The condition types of value 65 // rules within this value rule set must be of these dimensions. The first 66 // entry in this list is the primary dimension of the included value rules. 67 // When using value rule primary dimension segmentation, conversion values 68 // will be segmented into the values adjusted by value rules and the original 69 // values, if some value rules apply. 70 repeated google.ads.googleads.v16.enums.ValueRuleSetDimensionEnum 71 .ValueRuleSetDimension dimensions = 4; 72 73 // Output only. The resource name of the conversion value rule set's owner 74 // customer. When the value rule set is inherited from a manager customer, 75 // owner_customer will be the resource name of the manager whereas the 76 // customer in the resource_name will be of the requesting serving customer. 77 // ** Read-only ** 78 string owner_customer = 5 [ 79 (google.api.field_behavior) = OUTPUT_ONLY, 80 (google.api.resource_reference) = { 81 type: "googleads.googleapis.com/Customer" 82 } 83 ]; 84 85 // Immutable. Defines the scope where the conversion value rule set is 86 // attached. 87 google.ads.googleads.v16.enums.ValueRuleSetAttachmentTypeEnum 88 .ValueRuleSetAttachmentType attachment_type = 6 89 [(google.api.field_behavior) = IMMUTABLE]; 90 91 // The resource name of the campaign when the conversion value rule 92 // set is attached to a campaign. 93 string campaign = 7 [(google.api.resource_reference) = { 94 type: "googleads.googleapis.com/Campaign" 95 }]; 96 97 // Output only. The status of the conversion value rule set. 98 // ** Read-only ** 99 google.ads.googleads.v16.enums.ConversionValueRuleSetStatusEnum 100 .ConversionValueRuleSetStatus status = 8 101 [(google.api.field_behavior) = OUTPUT_ONLY]; 102 103 // Immutable. The conversion action categories of the conversion value rule 104 // set. 105 repeated google.ads.googleads.v16.enums.ConversionActionCategoryEnum 106 .ConversionActionCategory conversion_action_categories = 9 107 [(google.api.field_behavior) = IMMUTABLE]; 108} 109