• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.v15.resources;
18
19import "google/ads/googleads/v15/enums/distance_bucket.proto";
20import "google/api/field_behavior.proto";
21import "google/api/resource.proto";
22
23option csharp_namespace = "Google.Ads.GoogleAds.V15.Resources";
24option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v15/resources;resources";
25option java_multiple_files = true;
26option java_outer_classname = "DistanceViewProto";
27option java_package = "com.google.ads.googleads.v15.resources";
28option objc_class_prefix = "GAA";
29option php_namespace = "Google\\Ads\\GoogleAds\\V15\\Resources";
30option ruby_package = "Google::Ads::GoogleAds::V15::Resources";
31
32// Proto file describing the DistanceView resource.
33
34// A distance view with metrics aggregated by the user's distance from an
35// advertiser's location extensions. Each DistanceBucket includes all
36// impressions that fall within its distance and a single impression will
37// contribute to the metrics for all DistanceBuckets that include the user's
38// distance.
39message DistanceView {
40  option (google.api.resource) = {
41    type: "googleads.googleapis.com/DistanceView"
42    pattern: "customers/{customer_id}/distanceViews/{placeholder_chain_id}~{distance_bucket}"
43  };
44
45  // Output only. The resource name of the distance view.
46  // Distance view resource names have the form:
47  //
48  // `customers/{customer_id}/distanceViews/1~{distance_bucket}`
49  string resource_name = 1 [
50    (google.api.field_behavior) = OUTPUT_ONLY,
51    (google.api.resource_reference) = {
52      type: "googleads.googleapis.com/DistanceView"
53    }
54  ];
55
56  // Output only. Grouping of user distance from location extensions.
57  google.ads.googleads.v15.enums.DistanceBucketEnum.DistanceBucket
58      distance_bucket = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
59
60  // Output only. True if the DistanceBucket is using the metric system, false
61  // otherwise.
62  optional bool metric_system = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
63}
64