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