// 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/ad_spot_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 = "AdSpotServiceProto";
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 `AdSpot` objects.
service AdSpotService {
  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 an `AdSpot` object.
  rpc GetAdSpot(GetAdSpotRequest) returns (AdSpot) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/adSpots/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // Lists `AdSpot` objects.
  rpc ListAdSpots(ListAdSpotsRequest) returns (ListAdSpotsResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/adSpots"
    };
    option (google.api.method_signature) = "parent";
  }

  // Creates an `AdSpot` object.
  rpc CreateAdSpot(CreateAdSpotRequest) returns (AdSpot) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/adSpots"
      body: "ad_spot"
    };
    option (google.api.method_signature) = "parent,ad_spot";
  }

  // Batch creates `AdSpot` objects.
  rpc BatchCreateAdSpots(BatchCreateAdSpotsRequest)
      returns (BatchCreateAdSpotsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/adSpots:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Updates an `AdSpot` object.
  rpc UpdateAdSpot(UpdateAdSpotRequest) returns (AdSpot) {
    option (google.api.http) = {
      patch: "/v1/{ad_spot.name=networks/*/adSpots/*}"
      body: "ad_spot"
    };
    option (google.api.method_signature) = "ad_spot,update_mask";
  }

  // Batch updates `AdSpot` objects.
  rpc BatchUpdateAdSpots(BatchUpdateAdSpotsRequest)
      returns (BatchUpdateAdSpotsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/adSpots:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }
}

// Request object for `GetAdSpot` method.
message GetAdSpotRequest {
  // Required. The resource name of the AdSpot.
  // Format: `networks/{network_code}/adSpots/{ad_spot_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/AdSpot"
    }
  ];
}

// Request object for `ListAdSpots` method.
message ListAdSpotsRequest {
  // Required. The parent, which owns this collection of AdSpots.
  // 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 `AdSpots` to return. The service may return
  // fewer than this value. If unspecified, at most 50 `AdSpots` 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 `ListAdSpots` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListAdSpots` 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:**
  //
  // * `canonicalDisplayName`
  // * `customSpot`
  // * `displayName`
  // * `flexible`
  // * `name`
  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 `ListAdSpotsRequest` containing matching `AdSpot`
// objects.
message ListAdSpotsResponse {
  // The `AdSpot` objects from the specified network.
  repeated AdSpot ad_spots = 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 `AdSpot` objects.
  // 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 `CreateAdSpot` method.
message CreateAdSpotRequest {
  // Required. The parent resource where this `AdSpot` 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 `AdSpot` to create.
  AdSpot ad_spot = 2 [(google.api.field_behavior) = REQUIRED];
}

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

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

// Response object for `BatchCreateAdSpots` method.
message BatchCreateAdSpotsResponse {
  // The `AdSpot` objects created.
  repeated AdSpot ad_spots = 1;
}

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

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

// Response object for `BatchUpdateAdSpots` method.
message BatchUpdateAdSpotsResponse {
  // The `AdSpot` objects updated.
  repeated AdSpot ad_spots = 1;
}