// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.ads.admanager.v1;

import "google/ads/admanager/v1/user_messages.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";

option csharp_namespace = "Google.Ads.AdManager.V1";
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
option java_multiple_files = true;
option java_outer_classname = "UserServiceProto";
option java_package = "com.google.ads.admanager.v1";
option php_namespace = "Google\\Ads\\AdManager\\V1";
option ruby_package = "Google::Ads::AdManager::V1";

// Provides methods for handling User objects.
service UserService {
  option (google.api.default_host) = "admanager.googleapis.com";
  option (google.api.oauth_scopes) =
      "https://www.googleapis.com/auth/admanager,"
      "https://www.googleapis.com/auth/admanager.readonly";

  // Retrieves a `User` object.
  //
  // To get the current user, the resource name
  // `networks/{networkCode}/users/me` can be used.
  rpc GetUser(GetUserRequest) returns (User) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/users/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // Lists `User` objects.
  rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/users"
    };
    option (google.api.method_signature) = "parent";
  }

  // Creates a `User` object.
  rpc CreateUser(CreateUserRequest) returns (User) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/users"
      body: "user"
    };
    option (google.api.method_signature) = "parent,user";
  }

  // Creates `User` objects.
  rpc BatchCreateUsers(BatchCreateUsersRequest)
      returns (BatchCreateUsersResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/users:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Activates a list of `User` objects.
  rpc BatchActivateUsers(BatchActivateUsersRequest)
      returns (BatchActivateUsersResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/users:batchActivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Deactivates a list of `User` objects.
  rpc BatchDeactivateUsers(BatchDeactivateUsersRequest)
      returns (BatchDeactivateUsersResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/users:batchDeactivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Updates a `User` object.
  rpc UpdateUser(UpdateUserRequest) returns (User) {
    option (google.api.http) = {
      patch: "/v1/{user.name=networks/*/users/*}"
      body: "user"
    };
    option (google.api.method_signature) = "user,update_mask";
  }

  // Batch updates `User` objects.
  rpc BatchUpdateUsers(BatchUpdateUsersRequest)
      returns (BatchUpdateUsersResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/users:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }
}

// Request object for GetUser method.
message GetUserRequest {
  // Required. The resource name of the User.
  // Format: `networks/{network_code}/users/{user_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = { type: "admanager.googleapis.com/User" }
  ];
}

// Request object for ListUsers method.
message ListUsersRequest {
  // Required. The parent, which owns this collection of Users.
  // Format: `networks/{network_code}`
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];

  // Optional. The maximum number of Users to return. The service may return
  // fewer than this value. If unspecified, at most 50 users will be returned.
  // The maximum value is 1000; values greater than 1000 will be coerced to
  // 1000.
  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];

  // Optional. A page token, received from a previous `ListUsers` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListUsers` must match
  // the call that provided the page token.
  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Expression to filter the response.
  //  See syntax details at
  //  https://developers.google.com/ad-manager/api/beta/filters
  //
  // **Filterable fields:**
  //
  // * `active`
  // * `displayName`
  // * `email`
  // * `externalId`
  // * `name`
  // * `role`
  // * `serviceAccount`
  // * `userId`
  string filter = 4 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Expression to specify sorting order.
  // See syntax details at
  // https://developers.google.com/ad-manager/api/beta/filters#order
  string order_by = 5 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Number of individual resources to skip while paginating.
  int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
}

// Response object for ListUsersRequest containing matching User resources.
message ListUsersResponse {
  // The User from the specified network.
  repeated User users = 1;

  // A token, which can be sent as `page_token` to retrieve the next page.
  // If this field is omitted, there are no subsequent pages.
  string next_page_token = 2;

  // Total number of Users.
  // If a filter was included in the request, this reflects the total number
  // after the filtering is applied.
  //
  // `total_size` won't be calculated in the response unless it has been
  // included in a response field mask. The response field mask can be provided
  // to the method by using the URL parameter `$fields` or `fields`, or by using
  // the HTTP/gRPC header `X-Goog-FieldMask`.
  //
  // For more information, see
  // https://developers.google.com/ad-manager/api/beta/field-masks
  int32 total_size = 3;
}

// Request object for `CreateUser` method.
message CreateUserRequest {
  // Required. The parent resource where this `User` will be created.
  // Format: `networks/{network_code}`
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];

  // Required. The `User` to create.
  User user = 2 [(google.api.field_behavior) = REQUIRED];
}

// Request object for `BatchCreateUsers` method.
message BatchCreateUsersRequest {
  // Required. The parent resource where `Users` will be created.
  // Format: `networks/{network_code}`
  // The parent field in the CreateUserRequest must match this
  // field.
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];

  // Required. The `User` objects to create.
  // A maximum of 100 objects can be created in a batch.
  repeated CreateUserRequest requests = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response object for `BatchCreateUsers` method.
message BatchCreateUsersResponse {
  // The `User` objects created.
  repeated User users = 1;
}

// Request object for `UpdateUser` method.
message UpdateUserRequest {
  // Required. The `User` to update.
  User user = 1 [(google.api.field_behavior) = REQUIRED];

  // Optional. The list of fields to update.
  google.protobuf.FieldMask update_mask = 2
      [(google.api.field_behavior) = OPTIONAL];
}

// Request object for `BatchUpdateUsers` method.
message BatchUpdateUsersRequest {
  // Required. The parent resource where `Users` will be updated.
  // Format: `networks/{network_code}`
  // The parent field in the UpdateUserRequest must match this
  // field.
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];

  // Required. The `User` objects to update.
  // A maximum of 100 objects can be updated in a batch.
  repeated UpdateUserRequest requests = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response object for `BatchUpdateUsers` method.
message BatchUpdateUsersResponse {
  // The `User` objects updated.
  repeated User users = 1;
}

// Request message for `BatchActivateUsers` method.
message BatchActivateUsersRequest {
  // Required. Format: `networks/{network_code}`
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];

  // Required. The resource names of the `User` objects to activate.
  repeated string names = 2 [(google.api.field_behavior) = REQUIRED];
}

// Response object for `BatchActivateUsers` method.
message BatchActivateUsersResponse {}

// Request message for `BatchDeactivateUsers` method.
message BatchDeactivateUsersRequest {
  // Required. Format: `networks/{network_code}`
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];

  // Required. The resource names of the `User` objects to deactivate.
  repeated string names = 2 [(google.api.field_behavior) = REQUIRED];
}

// Response object for `BatchDeactivateUsers` method.
message BatchDeactivateUsersResponse {}