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.searchads360.v0.errors; 18 19option csharp_namespace = "Google.Ads.SearchAds360.V0.Errors"; 20option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/errors;errors"; 21option java_multiple_files = true; 22option java_outer_classname = "RequestErrorProto"; 23option java_package = "com.google.ads.searchads360.v0.errors"; 24option objc_class_prefix = "GASA360"; 25option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Errors"; 26option ruby_package = "Google::Ads::SearchAds360::V0::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 // Product name is invalid. 50 INVALID_PRODUCT_NAME = 35; 51 52 // Customer ID is invalid. 53 INVALID_CUSTOMER_ID = 16; 54 55 // Mutate operation should have either create, update, or remove specified. 56 OPERATION_REQUIRED = 5; 57 58 // Requested resource not found. 59 RESOURCE_NOT_FOUND = 6; 60 61 // Next page token specified in user request is invalid. 62 INVALID_PAGE_TOKEN = 7; 63 64 // Next page token specified in user request has expired. 65 EXPIRED_PAGE_TOKEN = 8; 66 67 // Page size specified in user request is invalid. 68 INVALID_PAGE_SIZE = 22; 69 70 // Required field is missing. 71 REQUIRED_FIELD_MISSING = 9; 72 73 // The field cannot be modified because it's immutable. It's also possible 74 // that the field can be modified using 'create' operation but not 'update'. 75 IMMUTABLE_FIELD = 11; 76 77 // Received too many entries in request. 78 TOO_MANY_MUTATE_OPERATIONS = 13; 79 80 // Request cannot be executed by a manager account. 81 CANNOT_BE_EXECUTED_BY_MANAGER_ACCOUNT = 14; 82 83 // Mutate request was attempting to modify a readonly field. 84 // For instance, Budget fields can be requested for Ad Group, 85 // but are read-only for adGroups:mutate. 86 CANNOT_MODIFY_FOREIGN_FIELD = 15; 87 88 // Enum value is not permitted. 89 INVALID_ENUM_VALUE = 18; 90 91 // The login-customer-id parameter is required for this request. 92 LOGIN_CUSTOMER_ID_PARAMETER_MISSING = 20; 93 94 // Either login-customer-id or linked-customer-id parameter is required for 95 // this request. 96 LOGIN_OR_LINKED_CUSTOMER_ID_PARAMETER_REQUIRED = 34; 97 98 // page_token is set in the validate only request 99 VALIDATE_ONLY_REQUEST_HAS_PAGE_TOKEN = 21; 100 101 // return_summary_row cannot be enabled if request did not select any 102 // metrics field. 103 CANNOT_RETURN_SUMMARY_ROW_FOR_REQUEST_WITHOUT_METRICS = 29; 104 105 // return_summary_row should not be enabled for validate only requests. 106 CANNOT_RETURN_SUMMARY_ROW_FOR_VALIDATE_ONLY_REQUESTS = 30; 107 108 // return_summary_row parameter value should be the same between requests 109 // with page_token field set and their original request. 110 INCONSISTENT_RETURN_SUMMARY_ROW_VALUE = 31; 111 112 // The total results count cannot be returned if it was not requested in the 113 // original request. 114 TOTAL_RESULTS_COUNT_NOT_ORIGINALLY_REQUESTED = 32; 115 116 // Deadline specified by the client was too short. 117 RPC_DEADLINE_TOO_SHORT = 33; 118 119 // The product associated with the request is not supported for the current 120 // request. 121 PRODUCT_NOT_SUPPORTED = 37; 122 } 123} 124