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