• 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
19option csharp_namespace = "Google.Ads.GoogleAds.V14.Errors";
20option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/errors;errors";
21option java_multiple_files = true;
22option java_outer_classname = "RequestErrorProto";
23option java_package = "com.google.ads.googleads.v14.errors";
24option objc_class_prefix = "GAA";
25option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Errors";
26option ruby_package = "Google::Ads::GoogleAds::V14::Errors";
27
28// Proto file describing request errors.
29
30// Container for enum describing possible request errors.
31message RequestErrorEnum {
32  // Enum describing possible request errors.
33  enum RequestError {
34    // Enum unspecified.
35    UNSPECIFIED = 0;
36
37    // The received error code is not known in this version.
38    UNKNOWN = 1;
39
40    // Resource name is required for this request.
41    RESOURCE_NAME_MISSING = 3;
42
43    // Resource name provided is malformed.
44    RESOURCE_NAME_MALFORMED = 4;
45
46    // Resource name provided is malformed.
47    BAD_RESOURCE_ID = 17;
48
49    // Customer ID is invalid.
50    INVALID_CUSTOMER_ID = 16;
51
52    // Mutate operation should have either create, update, or remove specified.
53    OPERATION_REQUIRED = 5;
54
55    // Requested resource not found.
56    RESOURCE_NOT_FOUND = 6;
57
58    // Next page token specified in user request is invalid.
59    INVALID_PAGE_TOKEN = 7;
60
61    // Next page token specified in user request has expired.
62    EXPIRED_PAGE_TOKEN = 8;
63
64    // Page size specified in user request is invalid.
65    INVALID_PAGE_SIZE = 22;
66
67    // Required field is missing.
68    REQUIRED_FIELD_MISSING = 9;
69
70    // The field cannot be modified because it's immutable. It's also possible
71    // that the field can be modified using 'create' operation but not 'update'.
72    IMMUTABLE_FIELD = 11;
73
74    // Received too many entries in request.
75    TOO_MANY_MUTATE_OPERATIONS = 13;
76
77    // Request cannot be executed by a manager account.
78    CANNOT_BE_EXECUTED_BY_MANAGER_ACCOUNT = 14;
79
80    // Mutate request was attempting to modify a readonly field.
81    // For instance, Budget fields can be requested for Ad Group,
82    // but are read-only for adGroups:mutate.
83    CANNOT_MODIFY_FOREIGN_FIELD = 15;
84
85    // Enum value is not permitted.
86    INVALID_ENUM_VALUE = 18;
87
88    // The developer-token parameter is required for all requests.
89    DEVELOPER_TOKEN_PARAMETER_MISSING = 19;
90
91    // The login-customer-id parameter is required for this request.
92    LOGIN_CUSTOMER_ID_PARAMETER_MISSING = 20;
93
94    // page_token is set in the validate only request
95    VALIDATE_ONLY_REQUEST_HAS_PAGE_TOKEN = 21;
96
97    // return_summary_row cannot be enabled if request did not select any
98    // metrics field.
99    CANNOT_RETURN_SUMMARY_ROW_FOR_REQUEST_WITHOUT_METRICS = 29;
100
101    // return_summary_row should not be enabled for validate only requests.
102    CANNOT_RETURN_SUMMARY_ROW_FOR_VALIDATE_ONLY_REQUESTS = 30;
103
104    // return_summary_row parameter value should be the same between requests
105    // with page_token field set and their original request.
106    INCONSISTENT_RETURN_SUMMARY_ROW_VALUE = 31;
107
108    // The total results count cannot be returned if it was not requested in the
109    // original request.
110    TOTAL_RESULTS_COUNT_NOT_ORIGINALLY_REQUESTED = 32;
111
112    // Deadline specified by the client was too short.
113    RPC_DEADLINE_TOO_SHORT = 33;
114
115    // This API version has been sunset and is no longer supported.
116    UNSUPPORTED_VERSION = 38;
117
118    // The Google Cloud project in the request was not found.
119    CLOUD_PROJECT_NOT_FOUND = 39;
120  }
121}
122