// 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/network_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 = "NetworkServiceProto";
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 `Network` objects.
service NetworkService {
  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 `Network` object.
  rpc GetNetwork(GetNetworkRequest) returns (Network) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // Retrieves all the networks the current user has access to.
  rpc ListNetworks(ListNetworksRequest) returns (ListNetworksResponse) {
    option (google.api.http) = {
      get: "/v1/networks"
    };
  }

  // Updates a `Network` object. Currently, only the network display name can be
  // updated.
  rpc UpdateNetwork(UpdateNetworkRequest) returns (Network) {
    option (google.api.http) = {
      patch: "/v1/{network.name=networks/*}"
      body: "network"
    };
    option (google.api.method_signature) = "network,update_mask";
  }

  // Provisions a test network associated with the current user. Only one test
  // network can be provisioned per user.
  //
  // Before the test network can be used, you must complete setup in the Ad
  // Manager UI. If the test network's owner is a service account, you must add
  // a non-service account user by calling UserService.CreateUser.
  //
  // Test networks are limited in the following ways:
  //
  //   * Test networks have a maximum of 10,000 objects per entity type.
  //   * Test networks cannot serve ads.
  //   * Reports on serving data have zero rows.
  //   * Forecast service results contain mock data.
  //   * Test networks do not have Ad Manager 360 or premium features enabled.
  rpc ProvisionTestNetwork(ProvisionTestNetworkRequest) returns (Network) {
    option (google.api.http) = {
      post: "/v1/networks:provisionTestNetwork"
      body: "*"
    };
  }

  // Returns the
  // [DefaultThirdPartyDataDeclaration][google.ads.admanager.v1.DefaultThirdPartyDataDeclaration]
  // for this network.
  rpc GetDefaultThirdPartyDataDeclaration(
      GetDefaultThirdPartyDataDeclarationRequest)
      returns (DefaultThirdPartyDataDeclaration) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/defaultThirdPartyDataDeclaration}"
    };
    option (google.api.method_signature) = "name";
  }
}

// Request for the `UpdateNetwork` method.
message UpdateNetworkRequest {
  // Required. The `Network` to update.
  //
  // The `Network`'s `name` is used to identify the `Network` to update.
  Network network = 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 to get Network
message GetNetworkRequest {
  // Required. Resource name of Network.
  // Format: networks/{network_code}
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Network"
    }
  ];
}

// Request object for `ListNetworks` method.
message ListNetworksRequest {
  // Optional. The maximum number of `Network`s to return. The service may
  // return fewer than this value. If unspecified, at most 50 `Network`s will be
  // returned. The maximum value is 1000; values greater than 1000 will be
  // coerced to 1000.
  int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];

  // Optional. A page token, received from a previous `ListNetworks` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListNetworks` must match
  // the call that provided the page token.
  string page_token = 4 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Number of individual resources to skip while paginating.
  int32 skip = 5 [(google.api.field_behavior) = OPTIONAL];
}

// Response object for `ListNetworks` method.
message ListNetworksResponse {
  // The `Network`s a user has access to.
  repeated Network networks = 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 `Network`s.
  //
  // `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 for the `ProvisionTestNetwork` method.
message ProvisionTestNetworkRequest {}

// Request for the `GetDefaultThirdPartyDataDeclaration` method.
message GetDefaultThirdPartyDataDeclarationRequest {
  // Required. Resource name of DefaultThirdPartyDataDeclaration.
  // Format: networks/{network_code}/defaultThirdPartyDataDeclaration
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/DefaultThirdPartyDataDeclaration"
    }
  ];
}