customer_user_access.proto 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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.resources;
  16. import "google/ads/googleads/v12/enums/access_role.proto";
  17. import "google/api/field_behavior.proto";
  18. import "google/api/resource.proto";
  19. option csharp_namespace = "Google.Ads.GoogleAds.V12.Resources";
  20. option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources";
  21. option java_multiple_files = true;
  22. option java_outer_classname = "CustomerUserAccessProto";
  23. option java_package = "com.google.ads.googleads.v12.resources";
  24. option objc_class_prefix = "GAA";
  25. option php_namespace = "Google\\Ads\\GoogleAds\\V12\\Resources";
  26. option ruby_package = "Google::Ads::GoogleAds::V12::Resources";
  27. // Proto file describing the CustomerUserAccess resource.
  28. // Represents the permission of a single user onto a single customer.
  29. message CustomerUserAccess {
  30. option (google.api.resource) = {
  31. type: "googleads.googleapis.com/CustomerUserAccess"
  32. pattern: "customers/{customer_id}/customerUserAccesses/{user_id}"
  33. };
  34. // Immutable. Name of the resource.
  35. // Resource names have the form:
  36. // `customers/{customer_id}/customerUserAccesses/{user_id}`
  37. string resource_name = 1 [
  38. (google.api.field_behavior) = IMMUTABLE,
  39. (google.api.resource_reference) = {
  40. type: "googleads.googleapis.com/CustomerUserAccess"
  41. }
  42. ];
  43. // Output only. User id of the user with the customer access.
  44. // Read only field
  45. int64 user_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  46. // Output only. Email address of the user.
  47. // Read only field
  48. optional string email_address = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
  49. // Access role of the user.
  50. google.ads.googleads.v12.enums.AccessRoleEnum.AccessRole access_role = 4;
  51. // Output only. The customer user access creation time.
  52. // Read only field
  53. // The format is "YYYY-MM-DD HH:MM:SS".
  54. // Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
  55. optional string access_creation_date_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
  56. // Output only. The email address of the inviter user.
  57. // Read only field
  58. optional string inviter_user_email_address = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
  59. }