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