geographic_view.proto 2.5 KB

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