• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.errors;
18
19import "google/ads/googleads/v16/common/policy.proto";
20import "google/ads/googleads/v16/common/value.proto";
21import "google/ads/googleads/v16/enums/resource_limit_type.proto";
22import "google/ads/googleads/v16/errors/access_invitation_error.proto";
23import "google/ads/googleads/v16/errors/account_budget_proposal_error.proto";
24import "google/ads/googleads/v16/errors/account_link_error.proto";
25import "google/ads/googleads/v16/errors/ad_customizer_error.proto";
26import "google/ads/googleads/v16/errors/ad_error.proto";
27import "google/ads/googleads/v16/errors/ad_group_ad_error.proto";
28import "google/ads/googleads/v16/errors/ad_group_bid_modifier_error.proto";
29import "google/ads/googleads/v16/errors/ad_group_criterion_customizer_error.proto";
30import "google/ads/googleads/v16/errors/ad_group_criterion_error.proto";
31import "google/ads/googleads/v16/errors/ad_group_customizer_error.proto";
32import "google/ads/googleads/v16/errors/ad_group_error.proto";
33import "google/ads/googleads/v16/errors/ad_group_feed_error.proto";
34import "google/ads/googleads/v16/errors/ad_parameter_error.proto";
35import "google/ads/googleads/v16/errors/ad_sharing_error.proto";
36import "google/ads/googleads/v16/errors/adx_error.proto";
37import "google/ads/googleads/v16/errors/asset_error.proto";
38import "google/ads/googleads/v16/errors/asset_group_asset_error.proto";
39import "google/ads/googleads/v16/errors/asset_group_error.proto";
40import "google/ads/googleads/v16/errors/asset_group_listing_group_filter_error.proto";
41import "google/ads/googleads/v16/errors/asset_group_signal_error.proto";
42import "google/ads/googleads/v16/errors/asset_link_error.proto";
43import "google/ads/googleads/v16/errors/asset_set_asset_error.proto";
44import "google/ads/googleads/v16/errors/asset_set_error.proto";
45import "google/ads/googleads/v16/errors/asset_set_link_error.proto";
46import "google/ads/googleads/v16/errors/audience_error.proto";
47import "google/ads/googleads/v16/errors/audience_insights_error.proto";
48import "google/ads/googleads/v16/errors/authentication_error.proto";
49import "google/ads/googleads/v16/errors/authorization_error.proto";
50import "google/ads/googleads/v16/errors/batch_job_error.proto";
51import "google/ads/googleads/v16/errors/bidding_error.proto";
52import "google/ads/googleads/v16/errors/bidding_strategy_error.proto";
53import "google/ads/googleads/v16/errors/billing_setup_error.proto";
54import "google/ads/googleads/v16/errors/campaign_budget_error.proto";
55import "google/ads/googleads/v16/errors/campaign_conversion_goal_error.proto";
56import "google/ads/googleads/v16/errors/campaign_criterion_error.proto";
57import "google/ads/googleads/v16/errors/campaign_customizer_error.proto";
58import "google/ads/googleads/v16/errors/campaign_draft_error.proto";
59import "google/ads/googleads/v16/errors/campaign_error.proto";
60import "google/ads/googleads/v16/errors/campaign_experiment_error.proto";
61import "google/ads/googleads/v16/errors/campaign_feed_error.proto";
62import "google/ads/googleads/v16/errors/campaign_lifecycle_goal_error.proto";
63import "google/ads/googleads/v16/errors/campaign_shared_set_error.proto";
64import "google/ads/googleads/v16/errors/change_event_error.proto";
65import "google/ads/googleads/v16/errors/change_status_error.proto";
66import "google/ads/googleads/v16/errors/collection_size_error.proto";
67import "google/ads/googleads/v16/errors/context_error.proto";
68import "google/ads/googleads/v16/errors/conversion_action_error.proto";
69import "google/ads/googleads/v16/errors/conversion_adjustment_upload_error.proto";
70import "google/ads/googleads/v16/errors/conversion_custom_variable_error.proto";
71import "google/ads/googleads/v16/errors/conversion_goal_campaign_config_error.proto";
72import "google/ads/googleads/v16/errors/conversion_upload_error.proto";
73import "google/ads/googleads/v16/errors/conversion_value_rule_error.proto";
74import "google/ads/googleads/v16/errors/conversion_value_rule_set_error.proto";
75import "google/ads/googleads/v16/errors/country_code_error.proto";
76import "google/ads/googleads/v16/errors/criterion_error.proto";
77import "google/ads/googleads/v16/errors/currency_code_error.proto";
78import "google/ads/googleads/v16/errors/currency_error.proto";
79import "google/ads/googleads/v16/errors/custom_audience_error.proto";
80import "google/ads/googleads/v16/errors/custom_conversion_goal_error.proto";
81import "google/ads/googleads/v16/errors/custom_interest_error.proto";
82import "google/ads/googleads/v16/errors/customer_client_link_error.proto";
83import "google/ads/googleads/v16/errors/customer_customizer_error.proto";
84import "google/ads/googleads/v16/errors/customer_error.proto";
85import "google/ads/googleads/v16/errors/customer_feed_error.proto";
86import "google/ads/googleads/v16/errors/customer_lifecycle_goal_error.proto";
87import "google/ads/googleads/v16/errors/customer_manager_link_error.proto";
88import "google/ads/googleads/v16/errors/customer_sk_ad_network_conversion_value_schema_error.proto";
89import "google/ads/googleads/v16/errors/customer_user_access_error.proto";
90import "google/ads/googleads/v16/errors/customizer_attribute_error.proto";
91import "google/ads/googleads/v16/errors/database_error.proto";
92import "google/ads/googleads/v16/errors/date_error.proto";
93import "google/ads/googleads/v16/errors/date_range_error.proto";
94import "google/ads/googleads/v16/errors/distinct_error.proto";
95import "google/ads/googleads/v16/errors/enum_error.proto";
96import "google/ads/googleads/v16/errors/experiment_arm_error.proto";
97import "google/ads/googleads/v16/errors/experiment_error.proto";
98import "google/ads/googleads/v16/errors/extension_feed_item_error.proto";
99import "google/ads/googleads/v16/errors/extension_setting_error.proto";
100import "google/ads/googleads/v16/errors/feed_attribute_reference_error.proto";
101import "google/ads/googleads/v16/errors/feed_error.proto";
102import "google/ads/googleads/v16/errors/feed_item_error.proto";
103import "google/ads/googleads/v16/errors/feed_item_set_error.proto";
104import "google/ads/googleads/v16/errors/feed_item_set_link_error.proto";
105import "google/ads/googleads/v16/errors/feed_item_target_error.proto";
106import "google/ads/googleads/v16/errors/feed_item_validation_error.proto";
107import "google/ads/googleads/v16/errors/feed_mapping_error.proto";
108import "google/ads/googleads/v16/errors/field_error.proto";
109import "google/ads/googleads/v16/errors/field_mask_error.proto";
110import "google/ads/googleads/v16/errors/function_error.proto";
111import "google/ads/googleads/v16/errors/function_parsing_error.proto";
112import "google/ads/googleads/v16/errors/geo_target_constant_suggestion_error.proto";
113import "google/ads/googleads/v16/errors/header_error.proto";
114import "google/ads/googleads/v16/errors/id_error.proto";
115import "google/ads/googleads/v16/errors/identity_verification_error.proto";
116import "google/ads/googleads/v16/errors/image_error.proto";
117import "google/ads/googleads/v16/errors/internal_error.proto";
118import "google/ads/googleads/v16/errors/invoice_error.proto";
119import "google/ads/googleads/v16/errors/keyword_plan_ad_group_error.proto";
120import "google/ads/googleads/v16/errors/keyword_plan_ad_group_keyword_error.proto";
121import "google/ads/googleads/v16/errors/keyword_plan_campaign_error.proto";
122import "google/ads/googleads/v16/errors/keyword_plan_campaign_keyword_error.proto";
123import "google/ads/googleads/v16/errors/keyword_plan_error.proto";
124import "google/ads/googleads/v16/errors/keyword_plan_idea_error.proto";
125import "google/ads/googleads/v16/errors/label_error.proto";
126import "google/ads/googleads/v16/errors/language_code_error.proto";
127import "google/ads/googleads/v16/errors/list_operation_error.proto";
128import "google/ads/googleads/v16/errors/manager_link_error.proto";
129import "google/ads/googleads/v16/errors/media_bundle_error.proto";
130import "google/ads/googleads/v16/errors/media_file_error.proto";
131import "google/ads/googleads/v16/errors/media_upload_error.proto";
132import "google/ads/googleads/v16/errors/merchant_center_error.proto";
133import "google/ads/googleads/v16/errors/multiplier_error.proto";
134import "google/ads/googleads/v16/errors/mutate_error.proto";
135import "google/ads/googleads/v16/errors/new_resource_creation_error.proto";
136import "google/ads/googleads/v16/errors/not_allowlisted_error.proto";
137import "google/ads/googleads/v16/errors/not_empty_error.proto";
138import "google/ads/googleads/v16/errors/null_error.proto";
139import "google/ads/googleads/v16/errors/offline_user_data_job_error.proto";
140import "google/ads/googleads/v16/errors/operation_access_denied_error.proto";
141import "google/ads/googleads/v16/errors/operator_error.proto";
142import "google/ads/googleads/v16/errors/partial_failure_error.proto";
143import "google/ads/googleads/v16/errors/payments_account_error.proto";
144import "google/ads/googleads/v16/errors/policy_finding_error.proto";
145import "google/ads/googleads/v16/errors/policy_validation_parameter_error.proto";
146import "google/ads/googleads/v16/errors/policy_violation_error.proto";
147import "google/ads/googleads/v16/errors/product_link_error.proto";
148import "google/ads/googleads/v16/errors/product_link_invitation_error.proto";
149import "google/ads/googleads/v16/errors/query_error.proto";
150import "google/ads/googleads/v16/errors/quota_error.proto";
151import "google/ads/googleads/v16/errors/range_error.proto";
152import "google/ads/googleads/v16/errors/reach_plan_error.proto";
153import "google/ads/googleads/v16/errors/recommendation_error.proto";
154import "google/ads/googleads/v16/errors/recommendation_subscription_error.proto";
155import "google/ads/googleads/v16/errors/region_code_error.proto";
156import "google/ads/googleads/v16/errors/request_error.proto";
157import "google/ads/googleads/v16/errors/resource_access_denied_error.proto";
158import "google/ads/googleads/v16/errors/resource_count_limit_exceeded_error.proto";
159import "google/ads/googleads/v16/errors/search_term_insight_error.proto";
160import "google/ads/googleads/v16/errors/setting_error.proto";
161import "google/ads/googleads/v16/errors/shared_criterion_error.proto";
162import "google/ads/googleads/v16/errors/shared_set_error.proto";
163import "google/ads/googleads/v16/errors/size_limit_error.proto";
164import "google/ads/googleads/v16/errors/smart_campaign_error.proto";
165import "google/ads/googleads/v16/errors/string_format_error.proto";
166import "google/ads/googleads/v16/errors/string_length_error.proto";
167import "google/ads/googleads/v16/errors/third_party_app_analytics_link_error.proto";
168import "google/ads/googleads/v16/errors/time_zone_error.proto";
169import "google/ads/googleads/v16/errors/url_field_error.proto";
170import "google/ads/googleads/v16/errors/user_data_error.proto";
171import "google/ads/googleads/v16/errors/user_list_error.proto";
172import "google/ads/googleads/v16/errors/video_campaign_error.proto";
173import "google/ads/googleads/v16/errors/youtube_video_registration_error.proto";
174import "google/protobuf/duration.proto";
175
176option csharp_namespace = "Google.Ads.GoogleAds.V16.Errors";
177option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/errors;errors";
178option java_multiple_files = true;
179option java_outer_classname = "ErrorsProto";
180option java_package = "com.google.ads.googleads.v16.errors";
181option objc_class_prefix = "GAA";
182option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Errors";
183option ruby_package = "Google::Ads::GoogleAds::V16::Errors";
184
185// Proto file describing the common error protos
186
187// Describes how a GoogleAds API call failed. It's returned inside
188// google.rpc.Status.details when a call fails.
189message GoogleAdsFailure {
190  // The list of errors that occurred.
191  repeated GoogleAdsError errors = 1;
192
193  // The unique ID of the request that is used for debugging purposes.
194  string request_id = 2;
195}
196
197// GoogleAds-specific error.
198message GoogleAdsError {
199  // An enum value that indicates which error occurred.
200  ErrorCode error_code = 1;
201
202  // A human-readable description of the error.
203  string message = 2;
204
205  // The value that triggered the error.
206  google.ads.googleads.v16.common.Value trigger = 3;
207
208  // Describes the part of the request proto that caused the error.
209  ErrorLocation location = 4;
210
211  // Additional error details, which are returned by certain error codes. Most
212  // error codes do not include details.
213  ErrorDetails details = 5;
214}
215
216// The error reason represented by type and enum.
217message ErrorCode {
218  // The list of error enums
219  oneof error_code {
220    // An error caused by the request
221    RequestErrorEnum.RequestError request_error = 1;
222
223    // An error with a Bidding Strategy mutate.
224    BiddingStrategyErrorEnum.BiddingStrategyError bidding_strategy_error = 2;
225
226    // An error with a URL field mutate.
227    UrlFieldErrorEnum.UrlFieldError url_field_error = 3;
228
229    // An error with a list operation.
230    ListOperationErrorEnum.ListOperationError list_operation_error = 4;
231
232    // An error with an AWQL query
233    QueryErrorEnum.QueryError query_error = 5;
234
235    // An error with a mutate
236    MutateErrorEnum.MutateError mutate_error = 7;
237
238    // An error with a field mask
239    FieldMaskErrorEnum.FieldMaskError field_mask_error = 8;
240
241    // An error encountered when trying to authorize a user.
242    AuthorizationErrorEnum.AuthorizationError authorization_error = 9;
243
244    // An unexpected server-side error.
245    InternalErrorEnum.InternalError internal_error = 10;
246
247    // An error with the amount of quota remaining.
248    QuotaErrorEnum.QuotaError quota_error = 11;
249
250    // An error with an Ad Group Ad mutate.
251    AdErrorEnum.AdError ad_error = 12;
252
253    // An error with an Ad Group mutate.
254    AdGroupErrorEnum.AdGroupError ad_group_error = 13;
255
256    // An error with a Campaign Budget mutate.
257    CampaignBudgetErrorEnum.CampaignBudgetError campaign_budget_error = 14;
258
259    // An error with a Campaign mutate.
260    CampaignErrorEnum.CampaignError campaign_error = 15;
261
262    // An error with a Video Campaign mutate.
263    VideoCampaignErrorEnum.VideoCampaignError video_campaign_error = 182;
264
265    // Indicates failure to properly authenticate user.
266    AuthenticationErrorEnum.AuthenticationError authentication_error = 17;
267
268    // The reasons for the ad group criterion customizer error.
269    AdGroupCriterionCustomizerErrorEnum.AdGroupCriterionCustomizerError
270        ad_group_criterion_customizer_error = 161;
271
272    // Indicates failure to properly authenticate user.
273    AdGroupCriterionErrorEnum.AdGroupCriterionError ad_group_criterion_error =
274        18;
275
276    // The reasons for the ad group customizer error.
277    AdGroupCustomizerErrorEnum.AdGroupCustomizerError
278        ad_group_customizer_error = 159;
279
280    // The reasons for the ad customizer error
281    AdCustomizerErrorEnum.AdCustomizerError ad_customizer_error = 19;
282
283    // The reasons for the ad group ad error
284    AdGroupAdErrorEnum.AdGroupAdError ad_group_ad_error = 21;
285
286    // The reasons for the ad sharing error
287    AdSharingErrorEnum.AdSharingError ad_sharing_error = 24;
288
289    // The reasons for the adx error
290    AdxErrorEnum.AdxError adx_error = 25;
291
292    // The reasons for the asset error
293    AssetErrorEnum.AssetError asset_error = 107;
294
295    // The reasons for the asset group asset error
296    AssetGroupAssetErrorEnum.AssetGroupAssetError asset_group_asset_error = 149;
297
298    // The reasons for the asset group listing group filter error
299    AssetGroupListingGroupFilterErrorEnum.AssetGroupListingGroupFilterError
300        asset_group_listing_group_filter_error = 155;
301
302    // The reasons for the asset group error
303    AssetGroupErrorEnum.AssetGroupError asset_group_error = 148;
304
305    // The reasons for the asset set asset error
306    AssetSetAssetErrorEnum.AssetSetAssetError asset_set_asset_error = 153;
307
308    // The reasons for the asset set link error
309    AssetSetLinkErrorEnum.AssetSetLinkError asset_set_link_error = 154;
310
311    // The reasons for the asset set error
312    AssetSetErrorEnum.AssetSetError asset_set_error = 152;
313
314    // The reasons for the bidding errors
315    BiddingErrorEnum.BiddingError bidding_error = 26;
316
317    // The reasons for the campaign criterion error
318    CampaignCriterionErrorEnum.CampaignCriterionError campaign_criterion_error =
319        29;
320
321    // The reasons for the campaign conversion goal error
322    CampaignConversionGoalErrorEnum.CampaignConversionGoalError
323        campaign_conversion_goal_error = 166;
324
325    // The reasons for the campaign customizer error.
326    CampaignCustomizerErrorEnum.CampaignCustomizerError
327        campaign_customizer_error = 160;
328
329    // The reasons for the collection size error
330    CollectionSizeErrorEnum.CollectionSizeError collection_size_error = 31;
331
332    // The reasons for the conversion goal campaign config error
333    ConversionGoalCampaignConfigErrorEnum.ConversionGoalCampaignConfigError
334        conversion_goal_campaign_config_error = 165;
335
336    // The reasons for the country code error
337    CountryCodeErrorEnum.CountryCodeError country_code_error = 109;
338
339    // The reasons for the criterion error
340    CriterionErrorEnum.CriterionError criterion_error = 32;
341
342    // The reasons for the custom conversion goal error
343    CustomConversionGoalErrorEnum.CustomConversionGoalError
344        custom_conversion_goal_error = 150;
345
346    // The reasons for the customer customizer error.
347    CustomerCustomizerErrorEnum.CustomerCustomizerError
348        customer_customizer_error = 158;
349
350    // The reasons for the customer error
351    CustomerErrorEnum.CustomerError customer_error = 90;
352
353    // The reasons for the customizer attribute error.
354    CustomizerAttributeErrorEnum.CustomizerAttributeError
355        customizer_attribute_error = 151;
356
357    // The reasons for the date error
358    DateErrorEnum.DateError date_error = 33;
359
360    // The reasons for the date range error
361    DateRangeErrorEnum.DateRangeError date_range_error = 34;
362
363    // The reasons for the distinct error
364    DistinctErrorEnum.DistinctError distinct_error = 35;
365
366    // The reasons for the feed attribute reference error
367    FeedAttributeReferenceErrorEnum.FeedAttributeReferenceError
368        feed_attribute_reference_error = 36;
369
370    // The reasons for the function error
371    FunctionErrorEnum.FunctionError function_error = 37;
372
373    // The reasons for the function parsing error
374    FunctionParsingErrorEnum.FunctionParsingError function_parsing_error = 38;
375
376    // The reasons for the id error
377    IdErrorEnum.IdError id_error = 39;
378
379    // The reasons for the image error
380    ImageErrorEnum.ImageError image_error = 40;
381
382    // The reasons for the language code error
383    LanguageCodeErrorEnum.LanguageCodeError language_code_error = 110;
384
385    // The reasons for the media bundle error
386    MediaBundleErrorEnum.MediaBundleError media_bundle_error = 42;
387
388    // The reasons for media uploading errors.
389    MediaUploadErrorEnum.MediaUploadError media_upload_error = 116;
390
391    // The reasons for the media file error
392    MediaFileErrorEnum.MediaFileError media_file_error = 86;
393
394    // Container for enum describing possible merchant center errors.
395    MerchantCenterErrorEnum.MerchantCenterError merchant_center_error = 162;
396
397    // The reasons for the multiplier error
398    MultiplierErrorEnum.MultiplierError multiplier_error = 44;
399
400    // The reasons for the new resource creation error
401    NewResourceCreationErrorEnum.NewResourceCreationError
402        new_resource_creation_error = 45;
403
404    // The reasons for the not empty error
405    NotEmptyErrorEnum.NotEmptyError not_empty_error = 46;
406
407    // The reasons for the null error
408    NullErrorEnum.NullError null_error = 47;
409
410    // The reasons for the operator error
411    OperatorErrorEnum.OperatorError operator_error = 48;
412
413    // The reasons for the range error
414    RangeErrorEnum.RangeError range_error = 49;
415
416    // The reasons for error in applying a recommendation
417    RecommendationErrorEnum.RecommendationError recommendation_error = 58;
418
419    // The reasons for the recommendation subscription error.
420    RecommendationSubscriptionErrorEnum.RecommendationSubscriptionError
421        recommendation_subscription_error = 180;
422
423    // The reasons for the region code error
424    RegionCodeErrorEnum.RegionCodeError region_code_error = 51;
425
426    // The reasons for the setting error
427    SettingErrorEnum.SettingError setting_error = 52;
428
429    // The reasons for the string format error
430    StringFormatErrorEnum.StringFormatError string_format_error = 53;
431
432    // The reasons for the string length error
433    StringLengthErrorEnum.StringLengthError string_length_error = 54;
434
435    // The reasons for the operation access denied error
436    OperationAccessDeniedErrorEnum.OperationAccessDeniedError
437        operation_access_denied_error = 55;
438
439    // The reasons for the resource access denied error
440    ResourceAccessDeniedErrorEnum.ResourceAccessDeniedError
441        resource_access_denied_error = 56;
442
443    // The reasons for the resource count limit exceeded error
444    ResourceCountLimitExceededErrorEnum.ResourceCountLimitExceededError
445        resource_count_limit_exceeded_error = 57;
446
447    // The reasons for YouTube video registration errors.
448    YoutubeVideoRegistrationErrorEnum.YoutubeVideoRegistrationError
449        youtube_video_registration_error = 117;
450
451    // The reasons for the ad group bid modifier error
452    AdGroupBidModifierErrorEnum.AdGroupBidModifierError
453        ad_group_bid_modifier_error = 59;
454
455    // The reasons for the context error
456    ContextErrorEnum.ContextError context_error = 60;
457
458    // The reasons for the field error
459    FieldErrorEnum.FieldError field_error = 61;
460
461    // The reasons for the shared set error
462    SharedSetErrorEnum.SharedSetError shared_set_error = 62;
463
464    // The reasons for the shared criterion error
465    SharedCriterionErrorEnum.SharedCriterionError shared_criterion_error = 63;
466
467    // The reasons for the campaign shared set error
468    CampaignSharedSetErrorEnum.CampaignSharedSetError
469        campaign_shared_set_error = 64;
470
471    // The reasons for the conversion action error
472    ConversionActionErrorEnum.ConversionActionError conversion_action_error =
473        65;
474
475    // The reasons for the conversion adjustment upload error
476    ConversionAdjustmentUploadErrorEnum.ConversionAdjustmentUploadError
477        conversion_adjustment_upload_error = 115;
478
479    // The reasons for the conversion custom variable error
480    ConversionCustomVariableErrorEnum.ConversionCustomVariableError
481        conversion_custom_variable_error = 143;
482
483    // The reasons for the conversion upload error
484    ConversionUploadErrorEnum.ConversionUploadError conversion_upload_error =
485        111;
486
487    // The reasons for the conversion value rule error
488    ConversionValueRuleErrorEnum.ConversionValueRuleError
489        conversion_value_rule_error = 145;
490
491    // The reasons for the conversion value rule set error
492    ConversionValueRuleSetErrorEnum.ConversionValueRuleSetError
493        conversion_value_rule_set_error = 146;
494
495    // The reasons for the header error.
496    HeaderErrorEnum.HeaderError header_error = 66;
497
498    // The reasons for the database error.
499    DatabaseErrorEnum.DatabaseError database_error = 67;
500
501    // The reasons for the policy finding error.
502    PolicyFindingErrorEnum.PolicyFindingError policy_finding_error = 68;
503
504    // The reason for enum error.
505    EnumErrorEnum.EnumError enum_error = 70;
506
507    // The reason for keyword plan error.
508    KeywordPlanErrorEnum.KeywordPlanError keyword_plan_error = 71;
509
510    // The reason for keyword plan campaign error.
511    KeywordPlanCampaignErrorEnum.KeywordPlanCampaignError
512        keyword_plan_campaign_error = 72;
513
514    // The reason for keyword plan campaign keyword error.
515    KeywordPlanCampaignKeywordErrorEnum.KeywordPlanCampaignKeywordError
516        keyword_plan_campaign_keyword_error = 132;
517
518    // The reason for keyword plan ad group error.
519    KeywordPlanAdGroupErrorEnum.KeywordPlanAdGroupError
520        keyword_plan_ad_group_error = 74;
521
522    // The reason for keyword plan ad group keyword error.
523    KeywordPlanAdGroupKeywordErrorEnum.KeywordPlanAdGroupKeywordError
524        keyword_plan_ad_group_keyword_error = 133;
525
526    // The reason for keyword idea error.
527    KeywordPlanIdeaErrorEnum.KeywordPlanIdeaError keyword_plan_idea_error = 76;
528
529    // The reasons for account budget proposal errors.
530    AccountBudgetProposalErrorEnum.AccountBudgetProposalError
531        account_budget_proposal_error = 77;
532
533    // The reasons for the user list error
534    UserListErrorEnum.UserListError user_list_error = 78;
535
536    // The reasons for the change event error
537    ChangeEventErrorEnum.ChangeEventError change_event_error = 136;
538
539    // The reasons for the change status error
540    ChangeStatusErrorEnum.ChangeStatusError change_status_error = 79;
541
542    // The reasons for the feed error
543    FeedErrorEnum.FeedError feed_error = 80;
544
545    // The reasons for the geo target constant suggestion error.
546    GeoTargetConstantSuggestionErrorEnum.GeoTargetConstantSuggestionError
547        geo_target_constant_suggestion_error = 81;
548
549    // The reasons for the campaign draft error
550    CampaignDraftErrorEnum.CampaignDraftError campaign_draft_error = 82;
551
552    // The reasons for the feed item error
553    FeedItemErrorEnum.FeedItemError feed_item_error = 83;
554
555    // The reason for the label error.
556    LabelErrorEnum.LabelError label_error = 84;
557
558    // The reasons for the billing setup error
559    BillingSetupErrorEnum.BillingSetupError billing_setup_error = 87;
560
561    // The reasons for the customer client link error
562    CustomerClientLinkErrorEnum.CustomerClientLinkError
563        customer_client_link_error = 88;
564
565    // The reasons for the customer manager link error
566    CustomerManagerLinkErrorEnum.CustomerManagerLinkError
567        customer_manager_link_error = 91;
568
569    // The reasons for the feed mapping error
570    FeedMappingErrorEnum.FeedMappingError feed_mapping_error = 92;
571
572    // The reasons for the customer feed error
573    CustomerFeedErrorEnum.CustomerFeedError customer_feed_error = 93;
574
575    // The reasons for the ad group feed error
576    AdGroupFeedErrorEnum.AdGroupFeedError ad_group_feed_error = 94;
577
578    // The reasons for the campaign feed error
579    CampaignFeedErrorEnum.CampaignFeedError campaign_feed_error = 96;
580
581    // The reasons for the custom interest error
582    CustomInterestErrorEnum.CustomInterestError custom_interest_error = 97;
583
584    // The reasons for the campaign experiment error
585    CampaignExperimentErrorEnum.CampaignExperimentError
586        campaign_experiment_error = 98;
587
588    // The reasons for the extension feed item error
589    ExtensionFeedItemErrorEnum.ExtensionFeedItemError
590        extension_feed_item_error = 100;
591
592    // The reasons for the ad parameter error
593    AdParameterErrorEnum.AdParameterError ad_parameter_error = 101;
594
595    // The reasons for the feed item validation error
596    FeedItemValidationErrorEnum.FeedItemValidationError
597        feed_item_validation_error = 102;
598
599    // The reasons for the extension setting error
600    ExtensionSettingErrorEnum.ExtensionSettingError extension_setting_error =
601        103;
602
603    // The reasons for the feed item set error
604    FeedItemSetErrorEnum.FeedItemSetError feed_item_set_error = 140;
605
606    // The reasons for the feed item set link error
607    FeedItemSetLinkErrorEnum.FeedItemSetLinkError feed_item_set_link_error =
608        141;
609
610    // The reasons for the feed item target error
611    FeedItemTargetErrorEnum.FeedItemTargetError feed_item_target_error = 104;
612
613    // The reasons for the policy violation error
614    PolicyViolationErrorEnum.PolicyViolationError policy_violation_error = 105;
615
616    // The reasons for the mutate job error
617    PartialFailureErrorEnum.PartialFailureError partial_failure_error = 112;
618
619    // The reasons for the policy validation parameter error
620    PolicyValidationParameterErrorEnum.PolicyValidationParameterError
621        policy_validation_parameter_error = 114;
622
623    // The reasons for the size limit error
624    SizeLimitErrorEnum.SizeLimitError size_limit_error = 118;
625
626    // The reasons for the offline user data job error.
627    OfflineUserDataJobErrorEnum.OfflineUserDataJobError
628        offline_user_data_job_error = 119;
629
630    // The reasons for the not allowlisted error
631    NotAllowlistedErrorEnum.NotAllowlistedError not_allowlisted_error = 137;
632
633    // The reasons for the manager link error
634    ManagerLinkErrorEnum.ManagerLinkError manager_link_error = 121;
635
636    // The reasons for the currency code error
637    CurrencyCodeErrorEnum.CurrencyCodeError currency_code_error = 122;
638
639    // The reasons for the experiment error
640    ExperimentErrorEnum.ExperimentError experiment_error = 123;
641
642    // The reasons for the access invitation error
643    AccessInvitationErrorEnum.AccessInvitationError access_invitation_error =
644        124;
645
646    // The reasons for the reach plan error
647    ReachPlanErrorEnum.ReachPlanError reach_plan_error = 125;
648
649    // The reasons for the invoice error
650    InvoiceErrorEnum.InvoiceError invoice_error = 126;
651
652    // The reasons for errors in payments accounts service
653    PaymentsAccountErrorEnum.PaymentsAccountError payments_account_error = 127;
654
655    // The reasons for the time zone error
656    TimeZoneErrorEnum.TimeZoneError time_zone_error = 128;
657
658    // The reasons for the asset link error
659    AssetLinkErrorEnum.AssetLinkError asset_link_error = 129;
660
661    // The reasons for the user data error.
662    UserDataErrorEnum.UserDataError user_data_error = 130;
663
664    // The reasons for the batch job error
665    BatchJobErrorEnum.BatchJobError batch_job_error = 131;
666
667    // The reasons for the account link status change error
668    AccountLinkErrorEnum.AccountLinkError account_link_error = 134;
669
670    // The reasons for the third party app analytics link mutate error
671    ThirdPartyAppAnalyticsLinkErrorEnum.ThirdPartyAppAnalyticsLinkError
672        third_party_app_analytics_link_error = 135;
673
674    // The reasons for the customer user access mutate error
675    CustomerUserAccessErrorEnum.CustomerUserAccessError
676        customer_user_access_error = 138;
677
678    // The reasons for the custom audience error
679    CustomAudienceErrorEnum.CustomAudienceError custom_audience_error = 139;
680
681    // The reasons for the audience error
682    AudienceErrorEnum.AudienceError audience_error = 164;
683
684    // The reasons for the Search term insight error
685    SearchTermInsightErrorEnum.SearchTermInsightError
686        search_term_insight_error = 174;
687
688    // The reasons for the Smart campaign error
689    SmartCampaignErrorEnum.SmartCampaignError smart_campaign_error = 147;
690
691    // The reasons for the experiment arm error
692    ExperimentArmErrorEnum.ExperimentArmError experiment_arm_error = 156;
693
694    // The reasons for the Audience Insights error
695    AudienceInsightsErrorEnum.AudienceInsightsError audience_insights_error =
696        167;
697
698    // The reasons for the product link error
699    ProductLinkErrorEnum.ProductLinkError product_link_error = 169;
700
701    // The reasons for the customer SK Ad network conversion value schema error
702    CustomerSkAdNetworkConversionValueSchemaErrorEnum
703        .CustomerSkAdNetworkConversionValueSchemaError
704            customer_sk_ad_network_conversion_value_schema_error = 170;
705
706    // The reasons for the currency errors.
707    CurrencyErrorEnum.CurrencyError currency_error = 171;
708
709    // The reasons for the asset group hint error
710    AssetGroupSignalErrorEnum.AssetGroupSignalError asset_group_signal_error =
711        176;
712
713    // The reasons for the product link invitation error
714    ProductLinkInvitationErrorEnum.ProductLinkInvitationError
715        product_link_invitation_error = 177;
716
717    // The reasons for the customer lifecycle goal error
718    CustomerLifecycleGoalErrorEnum.CustomerLifecycleGoalError
719        customer_lifecycle_goal_error = 178;
720
721    // The reasons for the campaign lifecycle goal error
722    CampaignLifecycleGoalErrorEnum.CampaignLifecycleGoalError
723        campaign_lifecycle_goal_error = 179;
724
725    // The reasons for an identity verification error.
726    IdentityVerificationErrorEnum.IdentityVerificationError
727        identity_verification_error = 181;
728  }
729}
730
731// Describes the part of the request proto that caused the error.
732message ErrorLocation {
733  // A part of a field path.
734  message FieldPathElement {
735    // The name of a field or a oneof
736    string field_name = 1;
737
738    // If field_name is a repeated field, this is the element that failed
739    optional int32 index = 3;
740  }
741
742  // A field path that indicates which field was invalid in the request.
743  repeated FieldPathElement field_path_elements = 2;
744}
745
746// Additional error details.
747message ErrorDetails {
748  // The error code that should have been returned, but wasn't. This is used
749  // when the error code is not published in the client specified version.
750  string unpublished_error_code = 1;
751
752  // Describes an ad policy violation.
753  PolicyViolationDetails policy_violation_details = 2;
754
755  // Describes policy violation findings.
756  PolicyFindingDetails policy_finding_details = 3;
757
758  // Details on the quota error, including the scope (account or developer), the
759  // rate bucket name and the retry delay.
760  QuotaErrorDetails quota_error_details = 4;
761
762  // Details for a resource count limit exceeded error.
763  ResourceCountDetails resource_count_details = 5;
764}
765
766// Error returned as part of a mutate response.
767// This error indicates single policy violation by some text
768// in one of the fields.
769message PolicyViolationDetails {
770  // Human readable description of policy violation.
771  string external_policy_description = 2;
772
773  // Unique identifier for this violation.
774  // If policy is exemptible, this key may be used to request exemption.
775  google.ads.googleads.v16.common.PolicyViolationKey key = 4;
776
777  // Human readable name of the policy.
778  string external_policy_name = 5;
779
780  // Whether user can file an exemption request for this violation.
781  bool is_exemptible = 6;
782}
783
784// Error returned as part of a mutate response.
785// This error indicates one or more policy findings in the fields of a
786// resource.
787message PolicyFindingDetails {
788  // The list of policy topics for the resource. Contains the PROHIBITED or
789  // FULLY_LIMITED policy topic entries that prevented the resource from being
790  // saved (among any other entries the resource may also have).
791  repeated google.ads.googleads.v16.common.PolicyTopicEntry
792      policy_topic_entries = 1;
793}
794
795// Additional quota error details when there is QuotaError.
796message QuotaErrorDetails {
797  // Enum of possible scopes that quota buckets belong to.
798  enum QuotaRateScope {
799    // Unspecified enum
800    UNSPECIFIED = 0;
801
802    // Used for return value only. Represents value unknown in this version.
803    UNKNOWN = 1;
804
805    // Per customer account quota
806    ACCOUNT = 2;
807
808    // Per project or DevToken quota
809    DEVELOPER = 3;
810  }
811
812  // The rate scope of the quota limit.
813  QuotaRateScope rate_scope = 1;
814
815  // The high level description of the quota bucket.
816  // Examples are "Get requests for standard access" or "Requests per account".
817  string rate_name = 2;
818
819  // Backoff period that customers should wait before sending next request.
820  google.protobuf.Duration retry_delay = 3;
821}
822
823// Error details returned when an resource count limit was exceeded.
824message ResourceCountDetails {
825  // The ID of the resource whose limit was exceeded.
826  // External customer ID if the limit is for a customer.
827  string enclosing_id = 1;
828
829  // The name of the resource (Customer, Campaign etc.) whose limit was
830  // exceeded.
831  string enclosing_resource = 5;
832
833  // The limit which was exceeded.
834  int32 limit = 2;
835
836  // The resource limit type which was exceeded.
837  google.ads.googleads.v16.enums.ResourceLimitTypeEnum.ResourceLimitType
838      limit_type = 3;
839
840  // The count of existing entities.
841  int32 existing_count = 4;
842}
843