// Copyright 2025 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/custom_field_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 = "CustomFieldServiceProto";
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 `CustomField` objects.
service CustomFieldService {
  option (google.api.default_host) = "admanager.googleapis.com";
  option (google.api.oauth_scopes) =
      "https://www.googleapis.com/auth/admanager";

  // API to retrieve a `CustomField` object.
  rpc GetCustomField(GetCustomFieldRequest) returns (CustomField) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/customFields/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // API to retrieve a list of `CustomField` objects.
  rpc ListCustomFields(ListCustomFieldsRequest)
      returns (ListCustomFieldsResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/customFields"
    };
    option (google.api.method_signature) = "parent";
  }

  // API to create a `CustomField` object.
  rpc CreateCustomField(CreateCustomFieldRequest) returns (CustomField) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/customFields"
      body: "custom_field"
    };
    option (google.api.method_signature) = "parent,custom_field";
  }

  // API to batch create `CustomField` objects.
  rpc BatchCreateCustomFields(BatchCreateCustomFieldsRequest)
      returns (BatchCreateCustomFieldsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/customFields:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // API to update a `CustomField` object.
  rpc UpdateCustomField(UpdateCustomFieldRequest) returns (CustomField) {
    option (google.api.http) = {
      patch: "/v1/{custom_field.name=networks/*/customFields/*}"
      body: "custom_field"
    };
    option (google.api.method_signature) = "custom_field,update_mask";
  }

  // API to batch update `CustomField` objects.
  rpc BatchUpdateCustomFields(BatchUpdateCustomFieldsRequest)
      returns (BatchUpdateCustomFieldsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/customFields:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Activates a list of `CustomField` objects.
  rpc BatchActivateCustomFields(BatchActivateCustomFieldsRequest)
      returns (BatchActivateCustomFieldsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/customFields:batchActivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Deactivates a list of `CustomField` objects.
  rpc BatchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest)
      returns (BatchDeactivateCustomFieldsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/customFields:batchDeactivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }
}

// Request object for `GetCustomField` method.
message GetCustomFieldRequest {
  // Required. The resource name of the CustomField.
  // Format: `networks/{network_code}/customFields/{custom_field_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/CustomField"
    }
  ];
}

// Request object for `ListCustomFields` method.
message ListCustomFieldsRequest {
  // Required. The parent, which owns this collection of CustomFields.
  // 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 `CustomFields` to return. The service may
  // return fewer than this value. If unspecified, at most 50 `CustomFields`
  // 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 `ListCustomFields` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListCustomFields` 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
  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 `ListCustomFieldsRequest` containing matching
// `CustomField` objects.
message ListCustomFieldsResponse {
  // The `CustomField` objects from the specified network.
  repeated CustomField custom_fields = 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 `CustomField` 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 `CreateCustomField` method.
message CreateCustomFieldRequest {
  // Required. The parent resource where this `CustomField` 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 `CustomField` to create.
  CustomField custom_field = 2 [(google.api.field_behavior) = REQUIRED];
}

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

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

// Response object for `BatchCreateCustomFields` method.
message BatchCreateCustomFieldsResponse {
  // The `CustomField` objects created.
  repeated CustomField custom_fields = 1;
}

// Request object for `UpdateCustomField` method.
message UpdateCustomFieldRequest {
  // Required. The `CustomField` to update.
  //
  // The `CustomField`'s `name` is used to identify the `CustomField` to update.
  CustomField custom_field = 1 [(google.api.field_behavior) = REQUIRED];

  // Required. The list of fields to update.
  google.protobuf.FieldMask update_mask = 2
      [(google.api.field_behavior) = REQUIRED];
}

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

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

// Response object for `BatchUpdateCustomFields` method.
message BatchUpdateCustomFieldsResponse {
  // The `CustomField` objects updated.
  repeated CustomField custom_fields = 1;
}

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

  // Required. The resource names of the `CustomField` objects to activate.
  // Format: `networks/{network_code}/customFields/{custom_field_id}`
  repeated string names = 3 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/CustomField"
    }
  ];
}

// Response object for `BatchActivateCustomFields` method.
message BatchActivateCustomFieldsResponse {}

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

  // Required. The resource names of the `CustomField` objects to deactivate.
  // Format: `networks/{network_code}/customFields/{custom_field_id}`
  repeated string names = 3 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/CustomField"
    }
  ];
}

// Response object for `BatchDeactivateCustomFields` method.
message BatchDeactivateCustomFieldsResponse {}