// 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/child_publisher_messages.proto";
import "google/ads/admanager/v1/mcm_enums.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 = "ChildPublisherServiceProto";
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
// [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects.
service ChildPublisherService {
  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 [ChildPublisher][google.ads.admanager.v1.ChildPublisher]
  // object.
  rpc GetChildPublisher(GetChildPublisherRequest) returns (ChildPublisher) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/childPublishers/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // Lists [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects.
  rpc ListChildPublishers(ListChildPublishersRequest)
      returns (ListChildPublishersResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/childPublishers"
    };
    option (google.api.method_signature) = "parent";
  }

  // Creates a [ChildPublisher][google.ads.admanager.v1.ChildPublisher] object.
  rpc CreateChildPublisher(CreateChildPublisherRequest)
      returns (ChildPublisher) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/childPublishers"
      body: "child_publisher"
    };
    option (google.api.method_signature) = "parent,child_publisher";
  }

  // Creates [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects.
  rpc BatchCreateChildPublishers(BatchCreateChildPublishersRequest)
      returns (BatchCreateChildPublishersResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/childPublishers:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Updates a [ChildPublisher][google.ads.admanager.v1.ChildPublisher] object.
  rpc UpdateChildPublisher(UpdateChildPublisherRequest)
      returns (ChildPublisher) {
    option (google.api.http) = {
      patch: "/v1/{child_publisher.name=networks/*/childPublishers/*}"
      body: "child_publisher"
    };
    option (google.api.method_signature) = "child_publisher,update_mask";
  }

  // Batch updates [ChildPublisher][google.ads.admanager.v1.ChildPublisher]
  // objects.
  rpc BatchUpdateChildPublishers(BatchUpdateChildPublishersRequest)
      returns (BatchUpdateChildPublishersResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/childPublishers:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Batch resends invitation emails to
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s.
  //
  // Only expired and pending
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s can be sent
  // invitation emails. Rejected, withdrawn, and accepted
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s will be ignored.
  rpc BatchResendChildPublisherInvitationEmails(
      BatchResendChildPublisherInvitationEmailsRequest)
      returns (BatchResendChildPublisherInvitationEmailsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/childPublishers:batchResendInvitationEmails"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Batch renegotiates [ChildPublisher][google.ads.admanager.v1.ChildPublisher]
  // agreements (i.e., invite with updated terms).
  //
  // Only the agreements of rejected or withdrawn
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s can be
  // renegotiated. Expired, pending, and accepted
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s will be ignored.
  rpc BatchRenegotiateChildPublisherAgreements(
      BatchRenegotiateChildPublisherAgreementsRequest)
      returns (BatchRenegotiateChildPublisherAgreementsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/childPublishers:batchRenegotiateAgreements"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Batch rejects [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s.
  //
  // Only pending or active
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s can be rejected.
  // Expired, rejected, and withdrawn
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s will be ignored.
  //
  // This method is only intended to be called in response to a child user
  // rejecting an invitation and exists to support the rejection of
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s that are not yet
  // associated with an Ad Manager network.
  //
  // To sever the relationship from the parent publisher's side, use
  // `BatchWithdrawChildPublishers`.
  rpc BatchRejectChildPublishers(BatchRejectChildPublishersRequest)
      returns (BatchRejectChildPublishersResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/childPublishers:batchReject"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Batch withdraws [ChildPublishers][google.ads.admanager.v1.ChildPublisher].
  //
  // Only expired, pending, and accepted
  // [ChildPublishers][google.ads.admanager.v1.ChildPublisher] can be withdrawn.
  // Rejected or withdrawn
  // [ChildPublishers][google.ads.admanager.v1.ChildPublisher] will be ignored.
  rpc BatchWithdrawChildPublishers(BatchWithdrawChildPublishersRequest)
      returns (BatchWithdrawChildPublishersResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/childPublishers:batchWithdraw"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }
}

// Request object for `GetChildPublisher` method.
message GetChildPublisherRequest {
  // Required. The resource name of the
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]. Format:
  // `networks/{network_code}/childPublishers/{child_publisher_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/ChildPublisher"
    }
  ];
}

// Request object for `ListChildPublishers` method.
message ListChildPublishersRequest {
  // Required. The parent, which owns this collection of
  // [ChildPublishers][google.ads.admanager.v1.ChildPublisher]. 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
  // [ChildPublishers][google.ads.admanager.v1.ChildPublisher] to return. The
  // service may return fewer than this value. If unspecified, at most 50
  // [ChildPublishers][google.ads.admanager.v1.ChildPublisher] 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 `ListChildPublishers`
  // call. Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListChildPublishers`
  // 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:**
  //
  // * `accountStatus`
  // * `addressVerificationStatus`
  // * `approvalStatus`
  // * `approvedManageAccountRevenueShareMillipercent`
  // * `childNetwork`
  // * `delegationType`
  // * `displayName`
  // * `email`
  // * `identityVerificationStatus`
  // * `invitationStatus`
  // * `name`
  // * `parentRevenueShareMillipercent`
  // * `pendingOnboardingTasks`
  // * `readinessStatus`
  // * `sellerId`
  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 `ListChildPublishers` containing matching
// [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects.
message ListChildPublishersResponse {
  // The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects from
  // the specified network.
  repeated ChildPublisher child_publishers = 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 [ChildPublisher][google.ads.admanager.v1.ChildPublisher]
  // 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 `CreateChildPublisher` method.
message CreateChildPublisherRequest {
  // Required. The parent resource where this
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher] 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 [ChildPublisher][google.ads.admanager.v1.ChildPublisher] to
  // create.
  ChildPublisher child_publisher = 2 [(google.api.field_behavior) = REQUIRED];
}

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

  // Required. The [ChildPublisher][google.ads.admanager.v1.ChildPublisher]
  // objects to create. A maximum of 100 objects can be created in a batch.
  repeated CreateChildPublisherRequest requests = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response object for `BatchCreateChildPublishers` method.
message BatchCreateChildPublishersResponse {
  // The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects
  // created.
  repeated ChildPublisher child_publishers = 1;
}

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

  // Required. The [ChildPublisher][google.ads.admanager.v1.ChildPublisher]
  // objects to update. A maximum of 100 objects can be updated in a batch.
  repeated UpdateChildPublisherRequest requests = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response object for `BatchUpdateChildPublishers` method.
message BatchUpdateChildPublishersResponse {
  // The [ChildPublisher][google.ads.admanager.v1.ChildPublisher] objects
  // updated.
  repeated ChildPublisher child_publishers = 1;
}

// Request message to renegotiate a
// [ChildPublisher][google.ads.admanager.v1.ChildPublisher]'s agreement (i.e.,
// invite with updated terms).
message RenegotiateChildPublisherAgreementRequest {
  // Required. Resource name of the
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher] whose agreement is
  // being renegotiated. Format:
  // `networks/{network_code}/childPublisher/{child_publisher_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/ChildPublisher"
    }
  ];

  // Optional. The display name to set for the
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher] whose agreement is
  // being renegotiated.
  string display_name = 2 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The email address to set for the
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher] whose agreement is
  // being renegotiated.
  string email_address = 3 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The resource name of the Ad Manager network to set for the
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher] whose agreement is
  // being renegotiated.
  //
  // This field may not update the
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]'s Ad Manager
  // network if it is already associated with one.
  //
  // Format: `networks/{network_code}`
  string network = 4 [
    (google.api.field_behavior) = OPTIONAL,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];

  // Optional. The type of delegation to set for the
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher] whose agreement is
  // being renegotiated.
  DelegationTypeEnum.DelegationType delegation_type = 5
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. The revenue share to set that the parent publisher will receive
  // in millipercent (e.g., 15000 millipercent is %15) for the
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher] whose agreement is
  // being renegotiated.
  //
  // This field is only settable for Manage Account
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s of non-reseller
  // parent publishers. Otherwise, it is ignored and always 100%.
  int64 parent_revenue_share_millipercent = 6
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. The seller ID to set for the
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher] whose agreement is
  // being renegotiated.
  //
  // This field is only applicable to Manage Inventory
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s.
  string seller_id = 7 [(google.api.field_behavior) = OPTIONAL];
}

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

  // Required. The requests to renegotiate
  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher] agreements.
  repeated RenegotiateChildPublisherAgreementRequest requests = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response message for `BatchRenegotiateChildPublisherAgreements` method.
message BatchRenegotiateChildPublisherAgreementsResponse {}

// Request message for `BatchResendChildPublisherInvitationEmails` method.
message BatchResendChildPublisherInvitationEmailsRequest {
  // 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 of the
  // [ChildPublishers][google.ads.admanager.v1.ChildPublisher] that should be
  // resent invitation emails. Format:
  // `networks/{network_code}/childPublisher/{child_publisher_id}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/ChildPublisher"
    }
  ];
}

// Response message for `BatchResendChildPublisherInvitationEmails` method.
message BatchResendChildPublisherInvitationEmailsResponse {}

// Request message for `BatchWithdrawChildPublishers` method.
message BatchWithdrawChildPublishersRequest {
  // 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 of the
  // [ChildPublishers][google.ads.admanager.v1.ChildPublisher] to withdraw.
  // Format: `networks/{network_code}/childPublisher/{child_publisher_id}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/ChildPublisher"
    }
  ];
}

// Response message for `BatchWithdrawChildPublishers` method.
message BatchWithdrawChildPublishersResponse {}

// Request message for `BatchRejectChildPublishers` method.
message BatchRejectChildPublishersRequest {
  // 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 of the
  // [ChildPublishers][google.ads.admanager.v1.ChildPublisher] to reject.
  // Format: `networks/{network_code}/childPublisher/{child_publisher_id}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/ChildPublisher"
    }
  ];
}

// Response message for `BatchRejectChildPublishers` method.
message BatchRejectChildPublishersResponse {}