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/ads/googleads/v14/common/click_location.proto"; 20import "google/ads/googleads/v14/common/criteria.proto"; 21import "google/api/field_behavior.proto"; 22import "google/api/resource.proto"; 23 24option csharp_namespace = "Google.Ads.GoogleAds.V14.Resources"; 25option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/resources;resources"; 26option java_multiple_files = true; 27option java_outer_classname = "ClickViewProto"; 28option java_package = "com.google.ads.googleads.v14.resources"; 29option objc_class_prefix = "GAA"; 30option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Resources"; 31option ruby_package = "Google::Ads::GoogleAds::V14::Resources"; 32 33// Proto file describing the ClickView resource. 34 35// A click view with metrics aggregated at each click level, including both 36// valid and invalid clicks. For non-Search campaigns, metrics.clicks 37// represents the number of valid and invalid interactions. 38// Queries including ClickView must have a filter limiting the results to one 39// day and can be requested for dates back to 90 days before the time of the 40// request. 41message ClickView { 42 option (google.api.resource) = { 43 type: "googleads.googleapis.com/ClickView" 44 pattern: "customers/{customer_id}/clickViews/{date}~{gclid}" 45 }; 46 47 // Output only. The resource name of the click view. 48 // Click view resource names have the form: 49 // 50 // `customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}` 51 string resource_name = 1 [ 52 (google.api.field_behavior) = OUTPUT_ONLY, 53 (google.api.resource_reference) = { 54 type: "googleads.googleapis.com/ClickView" 55 } 56 ]; 57 58 // Output only. The Google Click ID. 59 optional string gclid = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; 60 61 // Output only. The location criteria matching the area of interest associated 62 // with the impression. 63 google.ads.googleads.v14.common.ClickLocation area_of_interest = 3 64 [(google.api.field_behavior) = OUTPUT_ONLY]; 65 66 // Output only. The location criteria matching the location of presence 67 // associated with the impression. 68 google.ads.googleads.v14.common.ClickLocation location_of_presence = 4 69 [(google.api.field_behavior) = OUTPUT_ONLY]; 70 71 // Output only. Page number in search results where the ad was shown. 72 optional int64 page_number = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; 73 74 // Output only. The associated ad. 75 optional string ad_group_ad = 10 [ 76 (google.api.field_behavior) = OUTPUT_ONLY, 77 (google.api.resource_reference) = { 78 type: "googleads.googleapis.com/AdGroupAd" 79 } 80 ]; 81 82 // Output only. The associated campaign location target, if one exists. 83 optional string campaign_location_target = 11 [ 84 (google.api.field_behavior) = OUTPUT_ONLY, 85 (google.api.resource_reference) = { 86 type: "googleads.googleapis.com/GeoTargetConstant" 87 } 88 ]; 89 90 // Output only. The associated user list, if one exists. 91 optional string user_list = 12 [ 92 (google.api.field_behavior) = OUTPUT_ONLY, 93 (google.api.resource_reference) = { 94 type: "googleads.googleapis.com/UserList" 95 } 96 ]; 97 98 // Output only. The associated keyword, if one exists and the click 99 // corresponds to the SEARCH channel. 100 string keyword = 13 [ 101 (google.api.field_behavior) = OUTPUT_ONLY, 102 (google.api.resource_reference) = { 103 type: "googleads.googleapis.com/AdGroupCriterion" 104 } 105 ]; 106 107 // Output only. Basic information about the associated keyword, if it exists. 108 google.ads.googleads.v14.common.KeywordInfo keyword_info = 14 109 [(google.api.field_behavior) = OUTPUT_ONLY]; 110} 111