// Copyright 2023 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.v15.services;

import "google/ads/googleads/v15/resources/customer_lifecycle_goal.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.GoogleAds.V15.Services";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v15/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerLifecycleGoalServiceProto";
option java_package = "com.google.ads.googleads.v15.services";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V15\\Services";
option ruby_package = "Google::Ads::GoogleAds::V15::Services";

// Service to configure customer lifecycle goals.
service CustomerLifecycleService {
  option (google.api.default_host) = "googleads.googleapis.com";
  option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";

  // Process the given customer lifecycle configurations.
  //
  // List of thrown errors:
  //   [AuthenticationError]()
  //   [AuthorizationError]()
  //   [CustomerLifecycleGoalConfigError]()
  //   [HeaderError]()
  //   [InternalError]()
  //   [QuotaError]()
  //   [RequestError]()
  rpc ConfigureCustomerLifecycleGoals(ConfigureCustomerLifecycleGoalsRequest)
      returns (ConfigureCustomerLifecycleGoalsResponse) {
    option (google.api.http) = {
      post: "/v15/customers/{customer_id=*}/customerLifecycleGoal:configureCustomerLifecycleGoals"
      body: "*"
    };
    option (google.api.method_signature) = "customer_id,operation";
  }
}

// Request message for
// [CustomerLifecycleService.configureCustomerLifecycleGoals][].
message ConfigureCustomerLifecycleGoalsRequest {
  // Required. The ID of the customer performing the upload.
  string customer_id = 1 [(google.api.field_behavior) = REQUIRED];

  // Required. The operation to perform customer lifecycle goal update.
  CustomerLifecycleGoalOperation operation = 2
      [(google.api.field_behavior) = REQUIRED];

  // Optional. If true, the request is validated but not executed. Only errors
  // are returned, not results.
  bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
}

// A single operation on a customer lifecycle goal.
message CustomerLifecycleGoalOperation {
  // Optional. FieldMask that determines which resource fields are modified in
  // an update.
  google.protobuf.FieldMask update_mask = 2
      [(google.api.field_behavior) = OPTIONAL];

  // The mutate operation.
  oneof operation {
    // Create operation: to create a new customer lifecycle goal or update an
    // existing customer lifecycle goal. When creating a new customer lifecycle
    // goal, all required fields needs to be set. Resource name and field mask
    // needs to be empty. When updating an existing customer lifecycle goal,
    // resource name and field mask need to be set. Partial update based on
    // field mask is supported when updating an existing customer lifecycle
    // goal.
    google.ads.googleads.v15.resources.CustomerLifecycleGoal create = 1;
  }
}

// Response message for
// [CustomerLifecycleService.configureCustomerLifecycleGoals][].
message ConfigureCustomerLifecycleGoalsResponse {
  // result for the customer lifecycle goal configuration.
  ConfigureCustomerLifecycleGoalsResult result = 1;
}

// The result for the customer lifecycle goal configuration.
message ConfigureCustomerLifecycleGoalsResult {
  // Returned for the successful operation.
  string resource_name = 1 [(google.api.resource_reference) = {
    type: "googleads.googleapis.com/CustomerLifecycleGoal"
  }];
}
