ad_group_ad_asset_view.proto 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. // Copyright 2022 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.v10.resources;
  16. import "google/ads/googleads/v10/common/policy.proto";
  17. import "google/ads/googleads/v10/enums/asset_field_type.proto";
  18. import "google/ads/googleads/v10/enums/asset_performance_label.proto";
  19. import "google/ads/googleads/v10/enums/policy_approval_status.proto";
  20. import "google/ads/googleads/v10/enums/policy_review_status.proto";
  21. import "google/api/field_behavior.proto";
  22. import "google/api/resource.proto";
  23. option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
  24. option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
  25. option java_multiple_files = true;
  26. option java_outer_classname = "AdGroupAdAssetViewProto";
  27. option java_package = "com.google.ads.googleads.v10.resources";
  28. option objc_class_prefix = "GAA";
  29. option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
  30. option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
  31. // Proto file describing the ad group ad asset view resource.
  32. // A link between an AdGroupAd and an Asset.
  33. // Currently we only support AdGroupAdAssetView for AppAds.
  34. message AdGroupAdAssetView {
  35. option (google.api.resource) = {
  36. type: "googleads.googleapis.com/AdGroupAdAssetView"
  37. pattern: "customers/{customer_id}/adGroupAdAssetViews/{ad_group_id}~{ad_id}~{asset_id}~{field_type}"
  38. };
  39. // Output only. The resource name of the ad group ad asset view.
  40. // Ad group ad asset view resource names have the form (Before V4):
  41. //
  42. // `customers/{customer_id}/adGroupAdAssets/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}`
  43. //
  44. // Ad group ad asset view resource names have the form (Beginning from V4):
  45. //
  46. // `customers/{customer_id}/adGroupAdAssetViews/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}`
  47. string resource_name = 1 [
  48. (google.api.field_behavior) = OUTPUT_ONLY,
  49. (google.api.resource_reference) = {
  50. type: "googleads.googleapis.com/AdGroupAdAssetView"
  51. }
  52. ];
  53. // Output only. The ad group ad to which the asset is linked.
  54. optional string ad_group_ad = 9 [
  55. (google.api.field_behavior) = OUTPUT_ONLY,
  56. (google.api.resource_reference) = {
  57. type: "googleads.googleapis.com/AdGroupAd"
  58. }
  59. ];
  60. // Output only. The asset which is linked to the ad group ad.
  61. optional string asset = 10 [
  62. (google.api.field_behavior) = OUTPUT_ONLY,
  63. (google.api.resource_reference) = {
  64. type: "googleads.googleapis.com/Asset"
  65. }
  66. ];
  67. // Output only. Role that the asset takes in the ad.
  68. google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType field_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  69. // Output only. The status between the asset and the latest version of the ad. If true, the
  70. // asset is linked to the latest version of the ad. If false, it means the
  71. // link once existed but has been removed and is no longer present in the
  72. // latest version of the ad.
  73. optional bool enabled = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
  74. // Output only. Policy information for the ad group ad asset.
  75. AdGroupAdAssetPolicySummary policy_summary = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
  76. // Output only. Performance of an asset linkage.
  77. google.ads.googleads.v10.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel performance_label = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  78. }
  79. // Contains policy information for an ad group ad asset.
  80. message AdGroupAdAssetPolicySummary {
  81. // Output only. The list of policy findings for the ad group ad asset.
  82. repeated google.ads.googleads.v10.common.PolicyTopicEntry policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  83. // Output only. Where in the review process this ad group ad asset is.
  84. google.ads.googleads.v10.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  85. // Output only. The overall approval status of this ad group ad asset, calculated based on
  86. // the status of its individual policy topic entries.
  87. google.ads.googleads.v10.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
  88. }