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/product_channel.proto"; 21import "google/api/field_behavior.proto"; 22import "google/api/resource.proto"; 23 24option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; 25option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; 26option java_multiple_files = true; 27option java_outer_classname = "VisitProto"; 28option java_package = "com.google.ads.searchads360.v0.resources"; 29option objc_class_prefix = "GASA360"; 30option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; 31option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; 32 33// Proto file describing the Visit resource. 34 35// A visit. 36message Visit { 37 option (google.api.resource) = { 38 type: "searchads360.googleapis.com/Visit" 39 pattern: "customers/{customer_id}/visits/{ad_group_id}~{criteria_id}~{ds_visit_id}" 40 }; 41 42 // Output only. The resource name of the visit. 43 // Visit resource names have the form: 44 // 45 // `customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit_id}` 46 string resource_name = 1 [ 47 (google.api.field_behavior) = OUTPUT_ONLY, 48 (google.api.resource_reference) = { 49 type: "searchads360.googleapis.com/Visit" 50 } 51 ]; 52 53 // Output only. The ID of the visit. 54 optional int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; 55 56 // Output only. Search Ads 360 keyword ID. A value of 0 indicates that the 57 // keyword is unattributed. 58 optional int64 criterion_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; 59 60 // Output only. The Search Ads 360 inventory account ID containing the product 61 // that was clicked on. Search Ads 360 generates this ID when you link an 62 // inventory account in Search Ads 360. 63 optional int64 merchant_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; 64 65 // Output only. Ad ID. A value of 0 indicates that the ad is unattributed. 66 optional int64 ad_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; 67 68 // Output only. A unique string for each visit that is passed to the landing 69 // page as the click id URL parameter. 70 optional string click_id = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; 71 72 // Output only. The timestamp of the visit event. The timestamp is in the 73 // customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. 74 optional string visit_date_time = 7 75 [(google.api.field_behavior) = OUTPUT_ONLY]; 76 77 // Output only. The ID of the product clicked on. 78 optional string product_id = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; 79 80 // Output only. The sales channel of the product that was clicked on: Online 81 // or Local. 82 optional google.ads.searchads360.v0.enums.ProductChannelEnum.ProductChannel 83 product_channel = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; 84 85 // Output only. The language (ISO-639-1) that has been set for the Merchant 86 // Center feed containing data about the product. 87 optional string product_language_code = 10 88 [(google.api.field_behavior) = OUTPUT_ONLY]; 89 90 // Output only. The store in the Local Inventory Ad that was clicked on. This 91 // should match the store IDs used in your local products feed. 92 optional string product_store_id = 11 93 [(google.api.field_behavior) = OUTPUT_ONLY]; 94 95 // Output only. The country (ISO-3166 format) registered for the inventory 96 // feed that contains the product clicked on. 97 optional string product_country_code = 12 98 [(google.api.field_behavior) = OUTPUT_ONLY]; 99 100 // Output only. ID of the asset which was interacted with during the visit 101 // event. 102 optional int64 asset_id = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; 103 104 // Output only. Asset field type of the visit event. 105 optional google.ads.searchads360.v0.enums.AssetFieldTypeEnum.AssetFieldType 106 asset_field_type = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; 107} 108