// 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/slate_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 = "SlateServiceProto";
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 `Slate` objects.
service SlateService {
  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 `Slate` object.
  rpc GetSlate(GetSlateRequest) returns (Slate) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/slates/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // Lists `Slate` objects.
  rpc ListSlates(ListSlatesRequest) returns (ListSlatesResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/slates"
    };
    option (google.api.method_signature) = "parent";
  }

  // Creates a `Slate` object.
  rpc CreateSlate(CreateSlateRequest) returns (Slate) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/slates"
      body: "slate"
    };
    option (google.api.method_signature) = "parent,slate";
  }

  // Batch creates `Slate` objects.
  rpc BatchCreateSlates(BatchCreateSlatesRequest)
      returns (BatchCreateSlatesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/slates:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Updates a `Slate` object.
  rpc UpdateSlate(UpdateSlateRequest) returns (Slate) {
    option (google.api.http) = {
      patch: "/v1/{slate.name=networks/*/slates/*}"
      body: "slate"
    };
    option (google.api.method_signature) = "slate,update_mask";
  }

  // Batch updates `Slate` objects.
  rpc BatchUpdateSlates(BatchUpdateSlatesRequest)
      returns (BatchUpdateSlatesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/slates:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Batch archives `Slate` objects.
  rpc BatchArchiveSlates(BatchArchiveSlatesRequest)
      returns (BatchArchiveSlatesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/slates:batchArchive"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Batch unarchives `Slate` objects.
  rpc BatchUnarchiveSlates(BatchUnarchiveSlatesRequest)
      returns (BatchUnarchiveSlatesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/slates:batchUnarchive"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }
}

// Request message for `GetSlate` method.
message GetSlateRequest {
  // Required. The resource name of the Slate to retrieve.
  // Format: `networks/{network_code}/slates/{slate_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = { type: "admanager.googleapis.com/Slate" }
  ];
}

// Request message for `ListSlates` method.
message ListSlatesRequest {
  // Required. The parent resource containing the Slates.
  // 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 `Slates` to return. The service may return
  // fewer than this value. If unspecified, at most 50 `Slates` will be
  // returned. The maximum value is 1000; values above 1000 will be coerced to
  // 1000.
  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];

  // Optional. A page token, received from a previous `ListSlates` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListSlates` 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://google.aip.dev/160
  //
  // **Filterable fields:**
  //
  // * `displayName`
  // * `name`
  // * `status`
  string filter = 4 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Expression to specify sorting order.
  // See syntax details at https://google.aip.dev/132#ordering
  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 message for `ListSlates` method.
message ListSlatesResponse {
  // The `Slate` objects from the specified network.
  repeated Slate slates = 1;

  // A token that 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 `Slate` objects.
  // If a filter was included in the request, this reflects the total number
  // after filtering.
  //
  // `total_size` will not be returned if `skip` is nonzero.
  int32 total_size = 3;
}

// Request object for `CreateSlate` method.
message CreateSlateRequest {
  // Required. The parent resource where this `Slate` 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 `Slate` to create.
  Slate slate = 2 [(google.api.field_behavior) = REQUIRED];
}

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

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

// Response object for `BatchCreateSlates` method.
message BatchCreateSlatesResponse {
  // The `Slate` objects created.
  repeated Slate slates = 1;
}

// Request object for `UpdateSlate` method.
message UpdateSlateRequest {
  // Required. The `Slate` to update.
  //
  // The `Slate`'s `name` is used to identify the `Slate` to update.
  Slate slate = 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 `BatchUpdateSlates` method.
message BatchUpdateSlatesRequest {
  // Required. The parent resource where `Slates` will be updated.
  // Format: `networks/{network_code}`
  // The parent field in the UpdateSlateRequest must match this
  // field.
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];

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

// Response object for `BatchUpdateSlates` method.
message BatchUpdateSlatesResponse {
  // The `Slate` objects updated.
  repeated Slate slates = 1;
}

// Request message for `BatchArchiveSlates` method.
message BatchArchiveSlatesRequest {
  // Required. The parent resource containing the slates.
  // 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 slates to archive.
  // Format: "networks/{network_code}/slates/{slate_id}"
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = { type: "admanager.googleapis.com/Slate" }
  ];
}

// Response message for `BatchArchiveSlates` method.
message BatchArchiveSlatesResponse {}

// Request message for `BatchUnarchiveSlates` method.
message BatchUnarchiveSlatesRequest {
  // Required. The parent resource containing the slates.
  // 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 slates to unarchive.
  // Format: "networks/{network_code}/slates/{slate_id}"
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = { type: "admanager.googleapis.com/Slate" }
  ];
}

// Response message for `BatchUnarchiveSlates` method.
message BatchUnarchiveSlatesResponse {}