authorization_error.proto 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. // Copyright 2022 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. syntax = "proto3";
  15. package google.ads.googleads.v12.errors;
  16. option csharp_namespace = "Google.Ads.GoogleAds.V12.Errors";
  17. option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors";
  18. option java_multiple_files = true;
  19. option java_outer_classname = "AuthorizationErrorProto";
  20. option java_package = "com.google.ads.googleads.v12.errors";
  21. option objc_class_prefix = "GAA";
  22. option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Errors";
  23. option ruby_package = "Google::Ads::GoogleAds::V12::Errors";
  24. // Proto file describing authorization errors.
  25. // Container for enum describing possible authorization errors.
  26. message AuthorizationErrorEnum {
  27. // Enum describing possible authorization errors.
  28. enum AuthorizationError {
  29. // Enum unspecified.
  30. UNSPECIFIED = 0;
  31. // The received error code is not known in this version.
  32. UNKNOWN = 1;
  33. // User doesn't have permission to access customer. Note: If you're
  34. // accessing a client customer, the manager's customer ID must be set in the
  35. // `login-customer-id` header. Learn more at
  36. // https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid
  37. USER_PERMISSION_DENIED = 2;
  38. // The developer token is not on the allow-list.
  39. DEVELOPER_TOKEN_NOT_ON_ALLOWLIST = 13;
  40. // The developer token is not allowed with the project sent in the request.
  41. DEVELOPER_TOKEN_PROHIBITED = 4;
  42. // The Google Cloud project sent in the request does not have permission to
  43. // access the api.
  44. PROJECT_DISABLED = 5;
  45. // Authorization of the client failed.
  46. AUTHORIZATION_ERROR = 6;
  47. // The user does not have permission to perform this action
  48. // (for example, ADD, UPDATE, REMOVE) on the resource or call a method.
  49. ACTION_NOT_PERMITTED = 7;
  50. // Signup not complete.
  51. INCOMPLETE_SIGNUP = 8;
  52. // The customer can't be used because it isn't enabled.
  53. CUSTOMER_NOT_ENABLED = 24;
  54. // The developer must sign the terms of service. They can be found here:
  55. // ads.google.com/aw/apicenter
  56. MISSING_TOS = 9;
  57. // The developer token is not approved. Non-approved developer tokens can
  58. // only be used with test accounts.
  59. DEVELOPER_TOKEN_NOT_APPROVED = 10;
  60. // The login customer specified does not have access to the account
  61. // specified, so the request is invalid.
  62. INVALID_LOGIN_CUSTOMER_ID_SERVING_CUSTOMER_ID_COMBINATION = 11;
  63. // The developer specified does not have access to the service.
  64. SERVICE_ACCESS_DENIED = 12;
  65. // The customer (or login customer) isn't in Google Ads. It belongs to
  66. // another ads system.
  67. ACCESS_DENIED_FOR_ACCOUNT_TYPE = 25;
  68. // The developer does not have access to the metrics queried.
  69. METRIC_ACCESS_DENIED = 26;
  70. }
  71. }