// 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.googleads.v19.services;

import "google/ads/googleads/v19/enums/local_services_lead_credit_issuance_decision.proto";
import "google/ads/googleads/v19/enums/local_services_lead_survey_answer.proto";
import "google/ads/googleads/v19/enums/local_services_lead_survey_dissatisfied_reason.proto";
import "google/ads/googleads/v19/enums/local_services_lead_survey_satisfied_reason.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";

option csharp_namespace = "Google.Ads.GoogleAds.V19.Services";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v19/services;services";
option java_multiple_files = true;
option java_outer_classname = "LocalServicesLeadServiceProto";
option java_package = "com.google.ads.googleads.v19.services";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V19\\Services";
option ruby_package = "Google::Ads::GoogleAds::V19::Services";

// This service allows management of LocalServicesLead resources.
service LocalServicesLeadService {
  option (google.api.default_host) = "googleads.googleapis.com";
  option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";

  // RPC to append Local Services Lead Conversation resources to Local Services
  // Lead resources.
  rpc AppendLeadConversation(AppendLeadConversationRequest)
      returns (AppendLeadConversationResponse) {
    option (google.api.http) = {
      post: "/v19/customers/{customer_id=*}/localServices:appendLeadConversation"
      body: "*"
    };
    option (google.api.method_signature) = "customer_id,conversations";
  }

  // RPC to provide feedback on Local Services Lead resources.
  rpc ProvideLeadFeedback(ProvideLeadFeedbackRequest)
      returns (ProvideLeadFeedbackResponse) {
    option (google.api.http) = {
      post: "/v19/{resource_name=customers/*/localServicesLeads/*}:provideLeadFeedback"
      body: "*"
    };
  }
}

// Request message for
// [LocalServicesLeadService.AppendLeadConversation][google.ads.googleads.v19.services.LocalServicesLeadService.AppendLeadConversation].
message AppendLeadConversationRequest {
  // Required. The Id of the customer which owns the leads onto which the
  // conversations will be appended.
  string customer_id = 1 [(google.api.field_behavior) = REQUIRED];

  // Required. Conversations that are being appended.
  repeated Conversation conversations = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response message for
// [LocalServicesLeadService.AppendLeadConversation][google.ads.googleads.v19.services.LocalServicesLeadService.AppendLeadConversation].
message AppendLeadConversationResponse {
  // Required. List of append conversation operation results.
  repeated ConversationOrError responses = 1
      [(google.api.field_behavior) = REQUIRED];
}

// Details of the conversation that needs to be appended.
message Conversation {
  // Required. The resource name of the local services lead that the
  // conversation should be applied to.
  string local_services_lead = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "googleads.googleapis.com/LocalServicesLead"
    }
  ];

  // Required. Text message that user wanted to append to lead.
  string text = 2 [(google.api.field_behavior) = REQUIRED];
}

// Result of the append conversation operation.
message ConversationOrError {
  // Append operation response
  oneof append_lead_conversation_response {
    // The resource name of the appended local services lead conversation.
    string local_services_lead_conversation = 1;

    // Failure status when the request could not be processed.
    google.rpc.Status partial_failure_error = 2;
  }
}

// Details about various factors for being satisfied with the lead.
message SurveySatisfied {
  // Required. Provider's reason for being satisfied with the lead.
  google.ads.googleads.v19.enums.LocalServicesLeadSurveySatisfiedReasonEnum
      .SurveySatisfiedReason survey_satisfied_reason = 1
      [(google.api.field_behavior) = REQUIRED];

  // Optional. Provider's free form comments. This field is required when
  // OTHER_SATISFIED_REASON is selected as the reason.
  string other_reason_comment = 2 [(google.api.field_behavior) = OPTIONAL];
}

// Details about various factors for not being satisfied with the lead.
message SurveyDissatisfied {
  // Required. Provider's reason for not being satisfied with the lead.
  google.ads.googleads.v19.enums.LocalServicesLeadSurveyDissatisfiedReasonEnum
      .SurveyDissatisfiedReason survey_dissatisfied_reason = 1
      [(google.api.field_behavior) = REQUIRED];

  // Optional. Provider's free form comments. This field is required when
  // OTHER_DISSATISFIED_REASON is selected as the reason.
  string other_reason_comment = 2 [(google.api.field_behavior) = OPTIONAL];
}

// Request message for
// [LocalServicesLeadService.ProvideLeadFeedback][google.ads.googleads.v19.services.LocalServicesLeadService.ProvideLeadFeedback].
message ProvideLeadFeedbackRequest {
  // Required. The resource name of the local services lead that for which the
  // feedback is being provided.
  string resource_name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "googleads.googleapis.com/LocalServicesLead"
    }
  ];

  // Required. Survey answer for Local Services Ads Lead.
  google.ads.googleads.v19.enums.LocalServicesLeadSurveyAnswerEnum.SurveyAnswer
      survey_answer = 2 [(google.api.field_behavior) = REQUIRED];

  // Details about various factors for being satisfied or dissatisfied with the
  // lead.
  oneof survey_details {
    // Details about various factors for being satisfied with the lead.
    SurveySatisfied survey_satisfied = 3;

    // Details about various factors for not being satisfied with the lead.
    SurveyDissatisfied survey_dissatisfied = 4;
  }
}

// Response message for
// [LocalServicesLeadService.ProvideLeadFeedback][google.ads.googleads.v19.services.LocalServicesLeadService.ProvideLeadFeedback].
message ProvideLeadFeedbackResponse {
  // Required. Decision of bonus credit issued or rejected. If a bonus credit is
  // issued, it will be available for use in about two months.
  google.ads.googleads.v19.enums.LocalServicesLeadCreditIssuanceDecisionEnum
      .CreditIssuanceDecision credit_issuance_decision = 1
      [(google.api.field_behavior) = REQUIRED];
}
