// 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/suggested_ad_unit_messages.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.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 = "SuggestedAdUnitServiceProto";
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 `SuggestedAdUnit` objects.
service SuggestedAdUnitService {
  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";

  // Get a `SuggestedAdUnit` object.
  rpc GetSuggestedAdUnit(GetSuggestedAdUnitRequest) returns (SuggestedAdUnit) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/suggestedAdUnits/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // Retrieve a list of `SuggestedAdUnit` objects.
  rpc ListSuggestedAdUnits(ListSuggestedAdUnitsRequest)
      returns (ListSuggestedAdUnitsResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/suggestedAdUnits"
    };
    option (google.api.method_signature) = "parent";
  }

  // Bulk approve `SuggestedAdUnit` objects.
  rpc BatchApproveSuggestedAdUnits(BatchApproveSuggestedAdUnitsRequest)
      returns (BatchApproveSuggestedAdUnitsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/suggestedAdUnits:batchApprove"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }
}

// Request object for `GetSuggestedAdUnit` method.
message GetSuggestedAdUnitRequest {
  // Required. The resource name of the `SuggestedAdUnit`.
  // Format: `networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/SuggestedAdUnit"
    }
  ];
}

// Request object for `ListSuggestedAdUnits` method.
message ListSuggestedAdUnitsRequest {
  // Required. The parent, which owns this collection of SuggestedAdUnits.
  // 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 `SuggestedAdUnits` to return. The service
  // may return fewer than this value. If unspecified, at most 50
  // `SuggestedAdUnits` 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 `ListSuggestedAdUnits`
  // call. Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListSuggestedAdUnits`
  // 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:**
  //
  // * `name`
  // * `newCodePath`
  // * `weeklyRequestCount`
  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 `ListSuggestedAdUnitsRequest` containing matching
// `SuggestedAdUnit` objects.
message ListSuggestedAdUnitsResponse {
  // The `SuggestedAdUnit` objects from the specified network.
  repeated SuggestedAdUnit suggested_ad_units = 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 `SuggestedAdUnit` 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 message for `BatchApproveSuggestedAdUnits` method.
message BatchApproveSuggestedAdUnitsRequest {
  // 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 `SuggestedAdUnit` objects to approve.
  // Format: `networks/{network_code}/suggestedAdUnits/{suggested_ad_unit_id}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/SuggestedAdUnit"
    }
  ];
}

// Response message for `BatchApproveSuggestedAdUnits` method.
message BatchApproveSuggestedAdUnitsResponse {
  // The resource names of the AdUnits that were created as part of the
  // approval. The order of the ad units in the response is not guaranteed to be
  // the same as the order of the suggestions in the request.
  repeated string created_ad_units = 1 [(google.api.resource_reference) = {
    type: "admanager.googleapis.com/AdUnit"
  }];
}