// Copyright 2025 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/placement_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 = "PlacementServiceProto";
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 `Placement` objects.
service PlacementService {
  option (google.api.default_host) = "admanager.googleapis.com";
  option (google.api.oauth_scopes) =
      "https://www.googleapis.com/auth/admanager";

  // API to retrieve a `Placement` object.
  rpc GetPlacement(GetPlacementRequest) returns (Placement) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/placements/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // API to retrieve a list of `Placement` objects.
  rpc ListPlacements(ListPlacementsRequest) returns (ListPlacementsResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/placements"
    };
    option (google.api.method_signature) = "parent";
  }

  // API to create an `Placement` object.
  rpc CreatePlacement(CreatePlacementRequest) returns (Placement) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/placements"
      body: "placement"
    };
    option (google.api.method_signature) = "parent,placement";
  }

  // API to update an `Placement` object.
  rpc UpdatePlacement(UpdatePlacementRequest) returns (Placement) {
    option (google.api.http) = {
      patch: "/v1/{placement.name=networks/*/placements/*}"
      body: "placement"
    };
    option (google.api.method_signature) = "placement,update_mask";
  }

  // API to batch create `Placement` objects.
  rpc BatchCreatePlacements(BatchCreatePlacementsRequest)
      returns (BatchCreatePlacementsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/placements:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // API to batch update `Placement` objects.
  rpc BatchUpdatePlacements(BatchUpdatePlacementsRequest)
      returns (BatchUpdatePlacementsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/placements:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Activates a list of `Placement` objects.
  rpc BatchActivatePlacements(BatchActivatePlacementsRequest)
      returns (BatchActivatePlacementsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/placements:batchActivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Deactivates a list of `Placement` objects.
  rpc BatchDeactivatePlacements(BatchDeactivatePlacementsRequest)
      returns (BatchDeactivatePlacementsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/placements:batchDeactivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Archives a list of `Placement` objects.
  rpc BatchArchivePlacements(BatchArchivePlacementsRequest)
      returns (BatchArchivePlacementsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/placements:batchArchive"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }
}

// Request object for `GetPlacement` method.
message GetPlacementRequest {
  // Required. The resource name of the Placement.
  // Format: `networks/{network_code}/placements/{placement_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Placement"
    }
  ];
}

// Request object for `ListPlacements` method.
message ListPlacementsRequest {
  // Required. The parent, which owns this collection of Placements.
  // 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 `Placements` to return. The service may
  // return fewer than this value. If unspecified, at most 50 `Placements` 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 `ListPlacements` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListPlacements` 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
  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 `ListPlacementsRequest` containing matching `Placement`
// objects.
message ListPlacementsResponse {
  // The `Placement` objects from the specified network.
  repeated Placement placements = 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 `Placement` 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 `CreatePlacement` method.
message CreatePlacementRequest {
  // Required. The parent resource where this `Placement` 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 `Placement` to create.
  Placement placement = 2 [(google.api.field_behavior) = REQUIRED];
}

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

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

// Response object for `BatchCreatePlacements` method.
message BatchCreatePlacementsResponse {
  // The `Placement` objects created.
  repeated Placement placements = 1;
}

// Request object for `UpdatePlacement` method.
message UpdatePlacementRequest {
  // Required. The `Placement` to update.
  //
  // The `Placement`'s name is used to identify the `Placement` to
  // update. Format:
  // `networks/{network_code}/placements/{placement_id}`
  Placement placement = 1 [(google.api.field_behavior) = REQUIRED];

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

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

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

// Response object for `BatchUpdatePlacements` method.
message BatchUpdatePlacementsResponse {
  // The `Placement` objects updated.
  repeated Placement placements = 1;
}

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

  // Required. The names of the `Placement` objects to activate.
  // Format: `networks/{network_code}/placements/{placement_id}`
  repeated string names = 3 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Placement"
    }
  ];
}

// Response object for `BatchActivatePlacements` method.
message BatchActivatePlacementsResponse {}

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

  // Required. The names of the `Placement` objects to deactivate.
  // Format: `networks/{network_code}/placements/{placement_id}`
  repeated string names = 3 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Placement"
    }
  ];
}

// Response object for `BatchDeactivatePlacements` method.
message BatchDeactivatePlacementsResponse {}

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

  // Required. The names of the `Placement` objects to archive.
  // Format: `networks/{network_code}/placements/{placement_id}`
  repeated string names = 3 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Placement"
    }
  ];
}

// Response object for `BatchArchivePlacements` method.
message BatchArchivePlacementsResponse {}