// 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_rule_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/empty.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 = "AdRuleServiceProto";
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 `AdRule` objects.
service AdRuleService {
  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 `AdRule` object.
  rpc GetAdRule(GetAdRuleRequest) returns (AdRule) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/adRules/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // Lists `AdRule` objects.
  rpc ListAdRules(ListAdRulesRequest) returns (ListAdRulesResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/adRules"
    };
    option (google.api.method_signature) = "parent";
  }

  // Creates a `AdRule` object.
  rpc CreateAdRule(CreateAdRuleRequest) returns (AdRule) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/adRules"
      body: "ad_rule"
    };
    option (google.api.method_signature) = "parent,ad_rule";
  }

  // Batch creates `AdRule` objects.
  rpc BatchCreateAdRules(BatchCreateAdRulesRequest)
      returns (BatchCreateAdRulesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/adRules:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Updates a `AdRule` object.
  rpc UpdateAdRule(UpdateAdRuleRequest) returns (AdRule) {
    option (google.api.http) = {
      patch: "/v1/{ad_rule.name=networks/*/adRules/*}"
      body: "ad_rule"
    };
    option (google.api.method_signature) = "ad_rule,update_mask";
  }

  // Batch updates `AdRule` objects.
  rpc BatchUpdateAdRules(BatchUpdateAdRulesRequest)
      returns (BatchUpdateAdRulesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/adRules:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Activates a list of `AdRule` objects.
  rpc BatchActivateAdRules(BatchActivateAdRulesRequest)
      returns (BatchActivateAdRulesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/adRules:batchActivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Deactivates a list of `AdRule` objects.
  rpc BatchDeactivateAdRules(BatchDeactivateAdRulesRequest)
      returns (BatchDeactivateAdRulesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/adRules:batchDeactivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Deletes a list of `AdRule` objects.
  rpc BatchDeleteAdRules(BatchDeleteAdRulesRequest)
      returns (google.protobuf.Empty) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/adRules:batchDelete"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }
}

// Request object for `GetAdRule` method.
message GetAdRuleRequest {
  // Required. The resource name of the AdRule.
  // Format: `networks/{network_code}/adRules/{ad_rule_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/AdRule"
    }
  ];
}

// Request object for `ListAdRules` method.
message ListAdRulesRequest {
  // Required. The parent, which owns this collection of AdRules.
  // 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 `AdRules` to return. The service may return
  // fewer than this value. If unspecified, at most 50 `AdRules` 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 `ListAdRules` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListAdRules` 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`
  // * `priority`
  // * `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 `ListAdRulesRequest` containing matching `AdRule`
// objects.
message ListAdRulesResponse {
  // The `AdRule` objects from the specified network.
  repeated AdRule ad_rules = 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 `AdRule` 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 `CreateAdRule` method.
message CreateAdRuleRequest {
  // Required. The parent resource where this `AdRule` 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 `AdRule` to create.
  AdRule ad_rule = 2 [(google.api.field_behavior) = REQUIRED];
}

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

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

// Response object for `BatchCreateAdRules` method.
message BatchCreateAdRulesResponse {
  // The `AdRule` objects created.
  repeated AdRule ad_rules = 1;
}

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

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

// Response object for `BatchUpdateAdRules` method.
message BatchUpdateAdRulesResponse {
  // The `AdRule` objects updated.
  repeated AdRule ad_rules = 1;
}

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

  // Required. Resource names for the AdRule.
  // Format:
  // `networks/{network_code}/adRules/{ad_rule}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/AdRule"
    }
  ];
}

// Response object for `BatchActivateAdRules` method.
message BatchActivateAdRulesResponse {}

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

  // Required. Resource names for the AdRule.
  // Format:
  // `networks/{network_code}/adRules/{ad_rule}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/AdRule"
    }
  ];
}

// Response object for `BatchDeactivateAdRules` method.
message BatchDeactivateAdRulesResponse {}

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

  // Required. Resource names for the AdRule.
  // Format:
  // `networks/{network_code}/adRules/{ad_rule}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/AdRule"
    }
  ];
}