// 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.googleads.v25.resources;

import "google/ads/googleads/v25/enums/lift_measurement_flight_status.proto";
import "google/ads/googleads/v25/enums/lift_metric_type.proto";
import "google/ads/googleads/v25/enums/survey_lift_flight_target_response_mode.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";

option csharp_namespace = "Google.Ads.GoogleAds.V25.Resources";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v25/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "LiftMeasurementFlightProto";
option java_package = "com.google.ads.googleads.v25.resources";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V25\\Resources";
option ruby_package = "Google::Ads::GoogleAds::V25::Resources";

// A brand lift measurement flight.
message LiftMeasurementFlight {
  option (google.api.resource) = {
    type: "googleads.googleapis.com/LiftMeasurementFlight"
    pattern: "customers/{customer_id}/liftMeasurementFlights/{lift_measurement_configuration_id}~{lift_measurement_flight_id}"
  };

  // Immutable. The resource name of the lift measurement flight.
  // Lift measurement flight resource names have the form:
  //
  // `customers/{customer_id}/liftMeasurementFlights/{lift_measurement_configuration_id}~{flight_id}`
  string resource_name = 1 [
    (google.api.field_behavior) = IMMUTABLE,
    (google.api.resource_reference) = {
      type: "googleads.googleapis.com/LiftMeasurementFlight"
    }
  ];

  // Output only. The lift measurement configuration ID.
  optional int64 lift_measurement_config_id = 2
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The lift measurement flight ID.
  optional int64 lift_measurement_flight_id = 3
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. Flight configuration specific to Survey Lift.
  optional LiftMeasurementFlightSurveyLiftInfo survey_lift_info = 4
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The name of the lift measurement flight.
  optional string name = 5 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The status of the lift measurement flight.
  google.ads.googleads.v25.enums.LiftMeasurementFlightStatusEnum
      .LiftMeasurementFlightStatus status = 8
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The lift type measured during this flight.
  google.ads.googleads.v25.enums.LiftMetricTypeEnum.LiftMetricType lift_type = 9
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. Data about survey lift measurement.
  optional LiftMeasurementFlightSurveyLiftMeasurement survey_lift_measurement =
      12 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The start date of the lift measurement flight in the
  // customer's time zone.
  //
  // Format: YYYY-MM-DD
  optional string start_date = 14 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The end date of the lift measurement flight in the customer's
  // time zone.
  //
  // Format: YYYY-MM-DD
  optional string end_date = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// Survey Lift specific flight configuration.
message LiftMeasurementFlightSurveyLiftInfo {
  // Output only. The target response mode that will be used to collect survey
  // responses.
  google.ads.googleads.v25.enums.SurveyLiftFlightTargetResponseModeEnum
      .SurveyLiftFlightTargetResponseMode target_response_mode = 1
      [(google.api.field_behavior) = OUTPUT_ONLY];
}

// Survey Lift measurement info.
message LiftMeasurementFlightSurveyLiftMeasurement {
  // Output only. The ratio of target survey responses that have been collected
  // so far. Expressed in micros: 0 = 0%, 1000000 = 100%.
  optional int64 response_collection_ratio_micros = 1
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The earliest date in which survey responses were recorded.
  optional string min_survey_response_date = 2
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The latest date in which survey responses were recorded.
  optional string max_survey_response_date = 3
      [(google.api.field_behavior) = OUTPUT_ONLY];
}