// 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/application_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 = "ApplicationServiceProto";
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 `Application` objects.
service ApplicationService {
  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";

  // API to retrieve a `Application` object.
  rpc GetApplication(GetApplicationRequest) returns (Application) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/applications/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // API to retrieve a list of `Application` objects.
  rpc ListApplications(ListApplicationsRequest)
      returns (ListApplicationsResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/applications"
    };
    option (google.api.method_signature) = "parent";
  }

  // API to create a `Application` object.
  rpc CreateApplication(CreateApplicationRequest) returns (Application) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/applications"
      body: "application"
    };
    option (google.api.method_signature) = "parent,application";
  }

  // API to batch create `Application` objects.
  rpc BatchCreateApplications(BatchCreateApplicationsRequest)
      returns (BatchCreateApplicationsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/applications:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // API to update a `Application` object.
  rpc UpdateApplication(UpdateApplicationRequest) returns (Application) {
    option (google.api.http) = {
      patch: "/v1/{application.name=networks/*/applications/*}"
      body: "application"
    };
    option (google.api.method_signature) = "application,update_mask";
  }

  // API to batch update `Application` objects.
  rpc BatchUpdateApplications(BatchUpdateApplicationsRequest)
      returns (BatchUpdateApplicationsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/applications:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // / API to batch archive `Application` objects.
  rpc BatchArchiveApplications(BatchArchiveApplicationsRequest)
      returns (BatchArchiveApplicationsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/applications:batchArchive"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // / API to batch unarchive `Application` objects.
  rpc BatchUnarchiveApplications(BatchUnarchiveApplicationsRequest)
      returns (BatchUnarchiveApplicationsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/applications:batchUnarchive"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }
}

// Request object for `GetApplication` method.
message GetApplicationRequest {
  // Required. The resource name of the Application.
  // Format: `networks/{network_code}/applications/{application_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Application"
    }
  ];
}

// Request object for `ListApplications` method.
message ListApplicationsRequest {
  // Required. The parent, which owns this collection of Applications.
  // 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 `Applications` to return. The service may
  // return fewer than this value. If unspecified, at most 50 `Applications`
  // 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 `ListApplications` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListApplications` 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
  //
  // <b>Filterable fields:</b>
  // <ul style="list-style-type:none">
  //   <li><code>appStoreId</code></li>
  //   <li><code>appStores</code></li>
  //   <li><code>applicationCode</code></li>
  //   <li><code>approvalStatus</code></li>
  //   <li><code>archived</code></li>
  //   <li><code>displayName</code></li>
  //   <li><code>name</code></li>
  //   <li><code>platform</code></li>
  //   <li><code>webviewClaimingStatus</code></li>
  // </ul>
  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 `ListApplicationsRequest` containing matching
// `Application` objects.
message ListApplicationsResponse {
  // The `Application` objects from the specified network.
  repeated Application applications = 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 `Application` 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 `CreateApplication` method.
message CreateApplicationRequest {
  // Required. The parent resource where this `Application` 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 `Application` to create.
  Application application = 2 [(google.api.field_behavior) = REQUIRED];
}

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

  // Required. The `Application` objects to create.
  repeated CreateApplicationRequest requests = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response object for `BatchCreateApplications` method.
message BatchCreateApplicationsResponse {
  // The `Application` objects created.
  repeated Application applications = 1;
}

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

  // Required. The `Application` objects to update.
  repeated UpdateApplicationRequest requests = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response object for `BatchUpdateApplications` method.
message BatchUpdateApplicationsResponse {
  // The `Application` objects updated.
  repeated Application applications = 1;
}

// Request object for `BatchArchiveApplications` method.
message BatchArchiveApplicationsRequest {
  // Required. The parent resource shared by all `Applications` to archive.
  // Format: `networks/{network_code}`
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];

  // Required. The `Application` objects to archive.
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Application"
    }
  ];
}

// Response object for `BatchArchiveApplications` method.
message BatchArchiveApplicationsResponse {}

// Request object for `BatchUnarchiveApplications` method.
message BatchUnarchiveApplicationsRequest {
  // Required. The parent resource shared by all `Applications` to Unarchive.
  // Format: `networks/{network_code}`
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];

  // Required. The `Application` objects to unarchive.
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Application"
    }
  ];
}

// Response object for `BatchUnarchiveApplications` method.
message BatchUnarchiveApplicationsResponse {}