// 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/targeting_preset_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 = "TargetingPresetServiceProto";
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 `TargetingPreset` objects.
service TargetingPresetService {
  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 `TargetingPreset` object.
  // Note: Deactivated targeting presets are "logically deleted" (filtered out)
  // by the get logic in the manager layer, so they will not be returned by the
  // `GetTargetingPreset` RPC.
  rpc GetTargetingPreset(GetTargetingPresetRequest) returns (TargetingPreset) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/targetingPresets/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // Lists `TargetingPreset` objects.
  rpc ListTargetingPresets(ListTargetingPresetsRequest)
      returns (ListTargetingPresetsResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/targetingPresets"
    };
    option (google.api.method_signature) = "parent";
  }

  // Creates a `TargetingPreset` object.
  rpc CreateTargetingPreset(CreateTargetingPresetRequest)
      returns (TargetingPreset) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/targetingPresets"
      body: "targeting_preset"
    };
    option (google.api.method_signature) = "parent,targeting_preset";
  }

  // Creates `TargetingPreset` objects.
  rpc BatchCreateTargetingPresets(BatchCreateTargetingPresetsRequest)
      returns (BatchCreateTargetingPresetsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/targetingPresets:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Updates a `TargetingPreset` object.
  rpc UpdateTargetingPreset(UpdateTargetingPresetRequest)
      returns (TargetingPreset) {
    option (google.api.http) = {
      patch: "/v1/{targeting_preset.name=networks/*/targetingPresets/*}"
      body: "targeting_preset"
    };
    option (google.api.method_signature) = "targeting_preset,update_mask";
  }

  // Batch updates `TargetingPreset` objects.
  rpc BatchUpdateTargetingPresets(BatchUpdateTargetingPresetsRequest)
      returns (BatchUpdateTargetingPresetsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/targetingPresets:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Batch deactivates `TargetingPreset` objects.
  rpc BatchDeactivateTargetingPresets(BatchDeactivateTargetingPresetsRequest)
      returns (BatchDeactivateTargetingPresetsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/targetingPreset:batchDeactivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }
}

// Request object for `GetTargetingPreset` method.
message GetTargetingPresetRequest {
  // Required. The resource name of the TargetingPreset.
  // Format: `networks/{network_code}/targetingPresets/{targeting_preset_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/TargetingPreset"
    }
  ];
}

// Request object for `ListTargetingPresets` method.
message ListTargetingPresetsRequest {
  // Required. The parent, which owns this collection of TargetingPresets.
  // 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 `TargetingPresets` to return. The service
  // may return fewer than this value. If unspecified, at most 50
  // `TargetingPresets` 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 `ListTargetingPresets`
  // call. Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListTargetingPresets`
  // 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:**
  //
  // * `displayName`
  // * `name`
  // * `status`
  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 `ListTargetingPresetsRequest` containing matching
// `TargetingPreset` objects.
message ListTargetingPresetsResponse {
  // The `TargetingPreset` objects from the specified network.
  repeated TargetingPreset targeting_presets = 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 `TargetingPreset` 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 `CreateTargetingPreset` method.
message CreateTargetingPresetRequest {
  // Required. The parent resource where this `TargetingPreset` 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 `TargetingPreset` to create.
  TargetingPreset targeting_preset = 2 [(google.api.field_behavior) = REQUIRED];
}

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

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

// Response object for `BatchCreateTargetingPresets` method.
message BatchCreateTargetingPresetsResponse {
  // The `TargetingPreset` objects created.
  repeated TargetingPreset targeting_presets = 1;
}

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

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

// Response object for `BatchUpdateTargetingPresets` method.
message BatchUpdateTargetingPresetsResponse {
  // The `TargetingPreset` objects updated.
  repeated TargetingPreset targeting_presets = 1;
}

// Request object for `DeactivateTargetingPreset` method.
message DeactivateTargetingPresetRequest {
  // Required. Resource name for the TargetingPreset.
  // Format: `networks/{network_code}/targetingPreset/{targeting_preset_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/TargetingPreset"
    }
  ];

  // Required. TargetingPreset ID to deactivate.
  int64 targeting_preset_id = 2 [(google.api.field_behavior) = REQUIRED];
}

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

  // Required. The `TargetingPreset` objects to deactivate.
  repeated DeactivateTargetingPresetRequest requests = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response message for `DeactivateTargetingPresets` method.
message BatchDeactivateTargetingPresetsResponse {
  // The number of objects that were deactivated as a result of performing the
  // action.
  int64 change_count = 1;
}