change_status.proto 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  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.v11.resources;
  16. import "google/ads/googleads/v11/enums/change_status_operation.proto";
  17. import "google/ads/googleads/v11/enums/change_status_resource_type.proto";
  18. import "google/api/field_behavior.proto";
  19. import "google/api/resource.proto";
  20. option csharp_namespace = "Google.Ads.GoogleAds.V11.Resources";
  21. option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v11/resources;resources";
  22. option java_multiple_files = true;
  23. option java_outer_classname = "ChangeStatusProto";
  24. option java_package = "com.google.ads.googleads.v11.resources";
  25. option objc_class_prefix = "GAA";
  26. option php_namespace = "Google\\Ads\\GoogleAds\\V11\\Resources";
  27. option ruby_package = "Google::Ads::GoogleAds::V11::Resources";
  28. // Proto file describing the Change Status resource.
  29. // Describes the status of returned resource. ChangeStatus could have up to 3
  30. // minutes delay to reflect a new change.
  31. message ChangeStatus {
  32. option (google.api.resource) = {
  33. type: "googleads.googleapis.com/ChangeStatus"
  34. pattern: "customers/{customer_id}/changeStatus/{change_status_id}"
  35. };
  36. // Output only. The resource name of the change status.
  37. // Change status resource names have the form:
  38. //
  39. // `customers/{customer_id}/changeStatus/{change_status_id}`
  40. string resource_name = 1 [
  41. (google.api.field_behavior) = OUTPUT_ONLY,
  42. (google.api.resource_reference) = {
  43. type: "googleads.googleapis.com/ChangeStatus"
  44. }
  45. ];
  46. // Output only. Time at which the most recent change has occurred on this resource.
  47. optional string last_change_date_time = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
  48. // Output only. Represents the type of the changed resource. This dictates what fields
  49. // will be set. For example, for AD_GROUP, campaign and ad_group fields will
  50. // be set.
  51. google.ads.googleads.v11.enums.ChangeStatusResourceTypeEnum.ChangeStatusResourceType resource_type = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  52. // Output only. The Campaign affected by this change.
  53. optional string campaign = 17 [
  54. (google.api.field_behavior) = OUTPUT_ONLY,
  55. (google.api.resource_reference) = {
  56. type: "googleads.googleapis.com/Campaign"
  57. }
  58. ];
  59. // Output only. The AdGroup affected by this change.
  60. optional string ad_group = 18 [
  61. (google.api.field_behavior) = OUTPUT_ONLY,
  62. (google.api.resource_reference) = {
  63. type: "googleads.googleapis.com/AdGroup"
  64. }
  65. ];
  66. // Output only. Represents the status of the changed resource.
  67. google.ads.googleads.v11.enums.ChangeStatusOperationEnum.ChangeStatusOperation resource_status = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
  68. // Output only. The AdGroupAd affected by this change.
  69. optional string ad_group_ad = 25 [
  70. (google.api.field_behavior) = OUTPUT_ONLY,
  71. (google.api.resource_reference) = {
  72. type: "googleads.googleapis.com/AdGroupAd"
  73. }
  74. ];
  75. // Output only. The AdGroupCriterion affected by this change.
  76. optional string ad_group_criterion = 26 [
  77. (google.api.field_behavior) = OUTPUT_ONLY,
  78. (google.api.resource_reference) = {
  79. type: "googleads.googleapis.com/AdGroupCriterion"
  80. }
  81. ];
  82. // Output only. The CampaignCriterion affected by this change.
  83. optional string campaign_criterion = 27 [
  84. (google.api.field_behavior) = OUTPUT_ONLY,
  85. (google.api.resource_reference) = {
  86. type: "googleads.googleapis.com/CampaignCriterion"
  87. }
  88. ];
  89. // Output only. The Feed affected by this change.
  90. optional string feed = 28 [
  91. (google.api.field_behavior) = OUTPUT_ONLY,
  92. (google.api.resource_reference) = {
  93. type: "googleads.googleapis.com/Feed"
  94. }
  95. ];
  96. // Output only. The FeedItem affected by this change.
  97. optional string feed_item = 29 [
  98. (google.api.field_behavior) = OUTPUT_ONLY,
  99. (google.api.resource_reference) = {
  100. type: "googleads.googleapis.com/FeedItem"
  101. }
  102. ];
  103. // Output only. The AdGroupFeed affected by this change.
  104. optional string ad_group_feed = 30 [
  105. (google.api.field_behavior) = OUTPUT_ONLY,
  106. (google.api.resource_reference) = {
  107. type: "googleads.googleapis.com/AdGroupFeed"
  108. }
  109. ];
  110. // Output only. The CampaignFeed affected by this change.
  111. optional string campaign_feed = 31 [
  112. (google.api.field_behavior) = OUTPUT_ONLY,
  113. (google.api.resource_reference) = {
  114. type: "googleads.googleapis.com/CampaignFeed"
  115. }
  116. ];
  117. // Output only. The AdGroupBidModifier affected by this change.
  118. optional string ad_group_bid_modifier = 32 [
  119. (google.api.field_behavior) = OUTPUT_ONLY,
  120. (google.api.resource_reference) = {
  121. type: "googleads.googleapis.com/AdGroupBidModifier"
  122. }
  123. ];
  124. // Output only. The SharedSet affected by this change.
  125. string shared_set = 33 [
  126. (google.api.field_behavior) = OUTPUT_ONLY,
  127. (google.api.resource_reference) = {
  128. type: "googleads.googleapis.com/SharedSet"
  129. }
  130. ];
  131. // Output only. The CampaignSharedSet affected by this change.
  132. string campaign_shared_set = 34 [
  133. (google.api.field_behavior) = OUTPUT_ONLY,
  134. (google.api.resource_reference) = {
  135. type: "googleads.googleapis.com/CampaignSharedSet"
  136. }
  137. ];
  138. // Output only. The Asset affected by this change.
  139. string asset = 35 [
  140. (google.api.field_behavior) = OUTPUT_ONLY,
  141. (google.api.resource_reference) = {
  142. type: "googleads.googleapis.com/Asset"
  143. }
  144. ];
  145. // Output only. The CustomerAsset affected by this change.
  146. string customer_asset = 36 [
  147. (google.api.field_behavior) = OUTPUT_ONLY,
  148. (google.api.resource_reference) = {
  149. type: "googleads.googleapis.com/CustomerAsset"
  150. }
  151. ];
  152. // Output only. The CampaignAsset affected by this change.
  153. string campaign_asset = 37 [
  154. (google.api.field_behavior) = OUTPUT_ONLY,
  155. (google.api.resource_reference) = {
  156. type: "googleads.googleapis.com/CampaignAsset"
  157. }
  158. ];
  159. // Output only. The AdGroupAsset affected by this change.
  160. string ad_group_asset = 38 [
  161. (google.api.field_behavior) = OUTPUT_ONLY,
  162. (google.api.resource_reference) = {
  163. type: "googleads.googleapis.com/AdGroupAsset"
  164. }
  165. ];
  166. }