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/asset_field_type.proto"; 20import "google/ads/searchads360/v0/enums/attribution_type.proto"; 21import "google/ads/searchads360/v0/enums/conversion_status.proto"; 22import "google/ads/searchads360/v0/enums/product_channel.proto"; 23import "google/api/field_behavior.proto"; 24import "google/api/resource.proto"; 25 26option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; 27option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; 28option java_multiple_files = true; 29option java_outer_classname = "ConversionProto"; 30option java_package = "com.google.ads.searchads360.v0.resources"; 31option objc_class_prefix = "GASA360"; 32option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; 33option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; 34 35// Proto file describing the Conversion resource. 36 37// A conversion. 38message Conversion { 39 option (google.api.resource) = { 40 type: "searchads360.googleapis.com/Conversion" 41 pattern: "customers/{customer_id}/conversions/{ad_group_id}~{criteria_id}~{ds_conversion_id}" 42 }; 43 44 // Output only. The resource name of the conversion. 45 // Conversion resource names have the form: 46 // 47 // `customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}` 48 string resource_name = 1 [ 49 (google.api.field_behavior) = OUTPUT_ONLY, 50 (google.api.resource_reference) = { 51 type: "searchads360.googleapis.com/Conversion" 52 } 53 ]; 54 55 // Output only. The ID of the conversion 56 optional int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; 57 58 // Output only. Search Ads 360 criterion ID. A value of 0 indicates that the 59 // criterion is unattributed. 60 optional int64 criterion_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; 61 62 // Output only. The SearchAds360 inventory account ID containing the product 63 // that was clicked on. SearchAds360 generates this ID when you link an 64 // inventory account in SearchAds360. 65 optional int64 merchant_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; 66 67 // Output only. Ad ID. A value of 0 indicates that the ad is unattributed. 68 optional int64 ad_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; 69 70 // Output only. A unique string, for the visit that the conversion is 71 // attributed to, that is passed to the landing page as the click id URL 72 // parameter. 73 optional string click_id = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; 74 75 // Output only. The SearchAds360 visit ID that the conversion is attributed 76 // to. 77 optional int64 visit_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; 78 79 // Output only. For offline conversions, this is an ID provided by 80 // advertisers. If an advertiser doesn't specify such an ID, Search Ads 360 81 // generates one. For online conversions, this is equal to the id column or 82 // the floodlight_order_id column depending on the advertiser's Floodlight 83 // instructions. 84 optional string advertiser_conversion_id = 8 85 [(google.api.field_behavior) = OUTPUT_ONLY]; 86 87 // Output only. The ID of the product clicked on. 88 optional string product_id = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; 89 90 // Output only. The sales channel of the product that was clicked on: Online 91 // or Local. 92 optional google.ads.searchads360.v0.enums.ProductChannelEnum.ProductChannel 93 product_channel = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; 94 95 // Output only. The language (ISO-639-1) that has been set for the Merchant 96 // Center feed containing data about the product. 97 optional string product_language_code = 11 98 [(google.api.field_behavior) = OUTPUT_ONLY]; 99 100 // Output only. The store in the Local Inventory Ad that was clicked on. This 101 // should match the store IDs used in your local products feed. 102 optional string product_store_id = 12 103 [(google.api.field_behavior) = OUTPUT_ONLY]; 104 105 // Output only. The country (ISO-3166-format) registered for the inventory 106 // feed that contains the product clicked on. 107 optional string product_country_code = 13 108 [(google.api.field_behavior) = OUTPUT_ONLY]; 109 110 // Output only. What the conversion is attributed to: Visit or Keyword+Ad. 111 optional google.ads.searchads360.v0.enums.AttributionTypeEnum.AttributionType 112 attribution_type = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; 113 114 // Output only. The timestamp of the conversion event. 115 optional string conversion_date_time = 15 116 [(google.api.field_behavior) = OUTPUT_ONLY]; 117 118 // Output only. The timestamp of the last time the conversion was modified. 119 optional string conversion_last_modified_date_time = 16 120 [(google.api.field_behavior) = OUTPUT_ONLY]; 121 122 // Output only. The timestamp of the visit that the conversion is attributed 123 // to. 124 optional string conversion_visit_date_time = 17 125 [(google.api.field_behavior) = OUTPUT_ONLY]; 126 127 // Output only. The quantity of items recorded by the conversion, as 128 // determined by the qty url parameter. The advertiser is responsible for 129 // dynamically populating the parameter (such as number of items sold in the 130 // conversion), otherwise it defaults to 1. 131 optional int64 conversion_quantity = 18 132 [(google.api.field_behavior) = OUTPUT_ONLY]; 133 134 // Output only. The adjusted revenue in micros for the conversion event. This 135 // will always be in the currency of the serving account. 136 optional int64 conversion_revenue_micros = 19 137 [(google.api.field_behavior) = OUTPUT_ONLY]; 138 139 // Output only. The original, unchanged revenue associated with the Floodlight 140 // event (in the currency of the current report), before Floodlight currency 141 // instruction modifications. 142 optional int64 floodlight_original_revenue = 20 143 [(google.api.field_behavior) = OUTPUT_ONLY]; 144 145 // Output only. The Floodlight order ID provided by the advertiser for the 146 // conversion. 147 optional string floodlight_order_id = 21 148 [(google.api.field_behavior) = OUTPUT_ONLY]; 149 150 // Output only. The status of the conversion, either ENABLED or REMOVED.. 151 optional 152 google.ads.searchads360.v0.enums.ConversionStatusEnum.ConversionStatus 153 status = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; 154 155 // Output only. ID of the asset which was interacted with during the 156 // conversion event. 157 optional int64 asset_id = 23 [(google.api.field_behavior) = OUTPUT_ONLY]; 158 159 // Output only. Asset field type of the conversion event. 160 optional google.ads.searchads360.v0.enums.AssetFieldTypeEnum.AssetFieldType 161 asset_field_type = 24 [(google.api.field_behavior) = OUTPUT_ONLY]; 162} 163