xref: /aosp_15_r20/external/googleapis/google/ads/googleads/v14/resources/geographic_view.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
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/enums/geo_targeting_type.proto";
20import "google/api/field_behavior.proto";
21import "google/api/resource.proto";
22
23option csharp_namespace = "Google.Ads.GoogleAds.V14.Resources";
24option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/resources;resources";
25option java_multiple_files = true;
26option java_outer_classname = "GeographicViewProto";
27option java_package = "com.google.ads.googleads.v14.resources";
28option objc_class_prefix = "GAA";
29option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Resources";
30option ruby_package = "Google::Ads::GoogleAds::V14::Resources";
31
32// Proto file describing the geographic view resource.
33
34// A geographic view.
35//
36// Geographic View includes all metrics aggregated at the country level,
37// one row per country. It reports metrics at either actual physical location of
38// the user or an area of interest. If other segment fields are used, you may
39// get more than one row per country.
40message GeographicView {
41  option (google.api.resource) = {
42    type: "googleads.googleapis.com/GeographicView"
43    pattern: "customers/{customer_id}/geographicViews/{country_criterion_id}~{location_type}"
44  };
45
46  // Output only. The resource name of the geographic view.
47  // Geographic view resource names have the form:
48  //
49  // `customers/{customer_id}/geographicViews/{country_criterion_id}~{location_type}`
50  string resource_name = 1 [
51    (google.api.field_behavior) = OUTPUT_ONLY,
52    (google.api.resource_reference) = {
53      type: "googleads.googleapis.com/GeographicView"
54    }
55  ];
56
57  // Output only. Type of the geo targeting of the campaign.
58  google.ads.googleads.v14.enums.GeoTargetingTypeEnum.GeoTargetingType
59      location_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
60
61  // Output only. Criterion Id for the country.
62  optional int64 country_criterion_id = 5
63      [(google.api.field_behavior) = OUTPUT_ONLY];
64}
65