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/search_term_targeting_status.proto"; 20import "google/api/field_behavior.proto"; 21import "google/api/resource.proto"; 22 23option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources"; 24option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources"; 25option java_multiple_files = true; 26option java_outer_classname = "SearchTermViewProto"; 27option java_package = "com.google.ads.googleads.v16.resources"; 28option objc_class_prefix = "GAA"; 29option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources"; 30option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; 31 32// Proto file describing the SearchTermView resource. 33 34// A search term view with metrics aggregated by search term at the ad group 35// level. 36message SearchTermView { 37 option (google.api.resource) = { 38 type: "googleads.googleapis.com/SearchTermView" 39 pattern: "customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{query}" 40 }; 41 42 // Output only. The resource name of the search term view. 43 // Search term view resource names have the form: 44 // 45 // `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}` 46 string resource_name = 1 [ 47 (google.api.field_behavior) = OUTPUT_ONLY, 48 (google.api.resource_reference) = { 49 type: "googleads.googleapis.com/SearchTermView" 50 } 51 ]; 52 53 // Output only. The search term. 54 optional string search_term = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; 55 56 // Output only. The ad group the search term served in. 57 optional string ad_group = 6 [ 58 (google.api.field_behavior) = OUTPUT_ONLY, 59 (google.api.resource_reference) = { 60 type: "googleads.googleapis.com/AdGroup" 61 } 62 ]; 63 64 // Output only. Indicates whether the search term is currently one of your 65 // targeted or excluded keywords. 66 google.ads.googleads.v16.enums.SearchTermTargetingStatusEnum 67 .SearchTermTargetingStatus status = 4 68 [(google.api.field_behavior) = OUTPUT_ONLY]; 69} 70