// 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/dai_encoding_profile_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 = "DaiEncodingProfileServiceProto";
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 `DaiEncodingProfile` objects.
service DaiEncodingProfileService {
  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 `DaiEncodingProfile` object.
  rpc GetDaiEncodingProfile(GetDaiEncodingProfileRequest)
      returns (DaiEncodingProfile) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/daiEncodingProfiles/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // Lists `DaiEncodingProfile` objects.
  rpc ListDaiEncodingProfiles(ListDaiEncodingProfilesRequest)
      returns (ListDaiEncodingProfilesResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/daiEncodingProfiles"
    };
    option (google.api.method_signature) = "parent";
  }

  // Creates a `DaiEncodingProfile` object.
  rpc CreateDaiEncodingProfile(CreateDaiEncodingProfileRequest)
      returns (DaiEncodingProfile) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/daiEncodingProfiles"
      body: "dai_encoding_profile"
    };
    option (google.api.method_signature) = "parent,dai_encoding_profile";
  }

  // Batch creates `DaiEncodingProfile` objects.
  rpc BatchCreateDaiEncodingProfiles(BatchCreateDaiEncodingProfilesRequest)
      returns (BatchCreateDaiEncodingProfilesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/daiEncodingProfiles:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Updates a `DaiEncodingProfile` object.
  rpc UpdateDaiEncodingProfile(UpdateDaiEncodingProfileRequest)
      returns (DaiEncodingProfile) {
    option (google.api.http) = {
      patch: "/v1/{dai_encoding_profile.name=networks/*/daiEncodingProfiles/*}"
      body: "dai_encoding_profile"
    };
    option (google.api.method_signature) = "dai_encoding_profile,update_mask";
  }

  // Batch updates `DaiEncodingProfile` objects.
  rpc BatchUpdateDaiEncodingProfiles(BatchUpdateDaiEncodingProfilesRequest)
      returns (BatchUpdateDaiEncodingProfilesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/daiEncodingProfiles:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Activates a list of `DaiEncodingProfile` objects.
  rpc BatchActivateDaiEncodingProfiles(BatchActivateDaiEncodingProfilesRequest)
      returns (BatchActivateDaiEncodingProfilesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/daiEncodingProfiles:batchActivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Archives a list of `DaiEncodingProfile` objects.
  rpc BatchArchiveDaiEncodingProfiles(BatchArchiveDaiEncodingProfilesRequest)
      returns (BatchArchiveDaiEncodingProfilesResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/daiEncodingProfiles:batchArchive"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }
}

// Request object for `GetDaiEncodingProfile` method.
message GetDaiEncodingProfileRequest {
  // Required. The resource name of the DaiEncodingProfile.
  // Format:
  // `networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/DaiEncodingProfile"
    }
  ];
}

// Request object for `ListDaiEncodingProfiles` method.
message ListDaiEncodingProfilesRequest {
  // Required. The parent, which owns this collection of DaiEncodingProfiles.
  // 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 `DaiEncodingProfiles` to return. The
  // service may return fewer than this value. If unspecified, at most 50
  // `DaiEncodingProfiles` will be returned. The maximum value is 1000; values
  // above 1000 will be coerced to 1000.
  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];

  // Optional. A page token, received from a previous `ListDaiEncodingProfiles`
  // call. Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListDaiEncodingProfiles`
  // 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:**
  //
  // * `containerType`
  // * `displayName`
  // * `name`
  // * `status`
  // * `variantType`
  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 `ListDaiEncodingProfilesRequest` containing matching
// `DaiEncodingProfile` objects.
message ListDaiEncodingProfilesResponse {
  // The `DaiEncodingProfile` objects from the specified network.
  repeated DaiEncodingProfile dai_encoding_profiles = 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 `DaiEncodingProfile` objects.
  // If a filter was included in the request, this reflects the total number
  // after the filtering is applied.
  //
  // `total_size` will not 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 `CreateDaiEncodingProfile` method.
message CreateDaiEncodingProfileRequest {
  // Required. The parent resource where this `DaiEncodingProfile` 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 `DaiEncodingProfile` to create.
  DaiEncodingProfile dai_encoding_profile = 2
      [(google.api.field_behavior) = REQUIRED];
}

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

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

// Response object for `BatchCreateDaiEncodingProfiles` method.
message BatchCreateDaiEncodingProfilesResponse {
  // The `DaiEncodingProfile` objects created.
  repeated DaiEncodingProfile dai_encoding_profiles = 1;
}

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

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

// Response object for `BatchUpdateDaiEncodingProfiles` method.
message BatchUpdateDaiEncodingProfilesResponse {
  // The `DaiEncodingProfile` objects updated.
  repeated DaiEncodingProfile dai_encoding_profiles = 1;
}

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

  // Required. The `DaiEncodingProfile` objects to activate.
  // A maximum of 100 objects can be activated in a batch.
  repeated ActivateDaiEncodingProfileRequest requests = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response object for `BatchActivateDaiEncodingProfiles` method.
message BatchActivateDaiEncodingProfilesResponse {}

// Request object for `ActivateDaiEncodingProfile` method.
message ActivateDaiEncodingProfileRequest {
  // Required. The resource name of the DaiEncodingProfile to activate.
  // Format:
  // `networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/DaiEncodingProfile"
    }
  ];
}

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

  // Required. The `DaiEncodingProfile` objects to archive.
  // A maximum of 100 objects can be archived in a batch.
  repeated ArchiveDaiEncodingProfileRequest requests = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response object for `BatchArchiveDaiEncodingProfiles` method.
message BatchArchiveDaiEncodingProfilesResponse {}

// Request object for `ArchiveDaiEncodingProfile` method.
message ArchiveDaiEncodingProfileRequest {
  // Required. The resource name of the DaiEncodingProfile to archive.
  // Format:
  // `networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/DaiEncodingProfile"
    }
  ];
}
