// 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/live_stream_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 = "LiveStreamServiceProto";
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 `LiveStream` objects.
service LiveStreamService {
  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 `LiveStream` object.
  rpc GetLiveStream(GetLiveStreamRequest) returns (LiveStream) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/liveStreams/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // Lists `LiveStream` objects.
  rpc ListLiveStreams(ListLiveStreamsRequest)
      returns (ListLiveStreamsResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/liveStreams"
    };
    option (google.api.method_signature) = "parent";
  }

  // Creates a `LiveStream` object.
  rpc CreateLiveStream(CreateLiveStreamRequest) returns (LiveStream) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/liveStreams"
      body: "live_stream"
    };
    option (google.api.method_signature) = "parent,live_stream";
  }

  // Batch creates `LiveStream` objects.
  rpc BatchCreateLiveStreams(BatchCreateLiveStreamsRequest)
      returns (BatchCreateLiveStreamsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/liveStreams:batchCreate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Updates a `LiveStream` object.
  rpc UpdateLiveStream(UpdateLiveStreamRequest) returns (LiveStream) {
    option (google.api.http) = {
      patch: "/v1/{live_stream.name=networks/*/liveStreams/*}"
      body: "live_stream"
    };
    option (google.api.method_signature) = "live_stream,update_mask";
  }

  // Batch updates `LiveStream` objects.
  rpc BatchUpdateLiveStreams(BatchUpdateLiveStreamsRequest)
      returns (BatchUpdateLiveStreamsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/liveStreams:batchUpdate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,requests";
  }

  // Batch activates `LiveStream` objects.
  rpc BatchActivateLiveStreams(BatchActivateLiveStreamsRequest)
      returns (BatchActivateLiveStreamsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/liveStreams:batchActivate"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Batch pauses `LiveStream` objects.
  rpc BatchPauseLiveStreams(BatchPauseLiveStreamsRequest)
      returns (BatchPauseLiveStreamsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/liveStreams:batchPause"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Batch archives `LiveStream` objects.
  rpc BatchArchiveLiveStreams(BatchArchiveLiveStreamsRequest)
      returns (BatchArchiveLiveStreamsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/liveStreams:batchArchive"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Batch pauses ads on `LiveStream` objects.
  rpc BatchPauseAdsLiveStreams(BatchPauseAdsLiveStreamsRequest)
      returns (BatchPauseAdsLiveStreamsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/liveStreams:batchPauseAds"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }

  // Batch refreshes master playlists on `LiveStream` objects.
  rpc BatchRefreshMasterPlaylists(BatchRefreshMasterPlaylistsRequest)
      returns (BatchRefreshMasterPlaylistsResponse) {
    option (google.api.http) = {
      post: "/v1/{parent=networks/*}/liveStreams:batchRefreshMasterPlaylists"
      body: "*"
    };
    option (google.api.method_signature) = "parent,names";
  }
}

// Request object for `GetLiveStream` method.
message GetLiveStreamRequest {
  // Required. The resource name of the LiveStream.
  // Format: `networks/{network_code}/liveStreams/{live_stream_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/LiveStream"
    }
  ];
}

// Request object for `ListLiveStreams` method.
message ListLiveStreamsRequest {
  // Required. The parent, which owns this collection of LiveStreams.
  // 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 `LiveStreams` to return. The service may
  // return fewer than this value. If unspecified, at most 50 `LiveStreams` 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 `ListLiveStreams` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListLiveStreams` 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:**
  //
  // * `assetKey`
  // * `createTime`
  // * `customAssetKey`
  // * `daiAuthenticationKeys`
  // * `daiEncodingProfiles`
  // * `displayName`
  // * `dynamicAdInsertionType`
  // * `effectiveAssetKey`
  // * `endTime`
  // * `segmentUrlAuthenticationKeys`
  // * `slate`
  // * `sourceContentConfigurations`
  // * `startTime`
  // * `status`
  // * `streamingFormat`
  // * `updateTime`
  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 `ListLiveStreamsRequest` containing matching `LiveStream`
// objects.
message ListLiveStreamsResponse {
  // The `LiveStream` objects from the specified network.
  repeated LiveStream live_streams = 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 `LiveStream` 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 `CreateLiveStream` method.
message CreateLiveStreamRequest {
  // Required. The parent resource where this `LiveStream` 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 `LiveStream` to create.
  LiveStream live_stream = 2 [(google.api.field_behavior) = REQUIRED];
}

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

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

// Response object for `BatchCreateLiveStreams` method.
message BatchCreateLiveStreamsResponse {
  // The `LiveStream` objects created.
  repeated LiveStream live_streams = 1;
}

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

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

// Response object for `BatchUpdateLiveStreams` method.
message BatchUpdateLiveStreamsResponse {
  // The `LiveStream` objects updated.
  repeated LiveStream live_streams = 1;
}

// Request object for `BatchActivateLiveStreams` method.
message BatchActivateLiveStreamsRequest {
  // 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 `LiveStream`s to activate.
  // Format: `networks/{network_code}/liveStreams/{live_stream_id}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/LiveStream"
    }
  ];
}

// Response object for `BatchActivateLiveStreams` method.
message BatchActivateLiveStreamsResponse {}

// Request object for `BatchPauseLiveStreams` method.
message BatchPauseLiveStreamsRequest {
  // 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 `LiveStream`s to pause.
  // Format: `networks/{network_code}/liveStreams/{live_stream_id}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/LiveStream"
    }
  ];
}

// Response object for `BatchPauseLiveStreams` method.
message BatchPauseLiveStreamsResponse {}

// Request object for `BatchArchiveLiveStreams` method.
message BatchArchiveLiveStreamsRequest {
  // 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 `LiveStream`s to archive.
  // Format: `networks/{network_code}/liveStreams/{live_stream_id}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/LiveStream"
    }
  ];
}

// Response object for `BatchArchiveLiveStreams` method.
message BatchArchiveLiveStreamsResponse {}

// Request object for `BatchPauseAdsLiveStreams` method.
message BatchPauseAdsLiveStreamsRequest {
  // 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 `LiveStream`s to pause ads on.
  // Format: `networks/{network_code}/liveStreams/{live_stream_id}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/LiveStream"
    }
  ];
}

// Response object for `BatchPauseAdsLiveStreams` method.
message BatchPauseAdsLiveStreamsResponse {}

// Request object for `BatchRefreshMasterPlaylists` method.
message BatchRefreshMasterPlaylistsRequest {
  // 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 `LiveStream`s to refresh master
  // playlists on. Format:
  // `networks/{network_code}/liveStreams/{live_stream_id}`
  repeated string names = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/LiveStream"
    }
  ];
}

// Response object for `BatchRefreshMasterPlaylists` method.
message BatchRefreshMasterPlaylistsResponse {}