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

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

// Proto file describing the MerchantCenterLink service.

// This service allows management of links between Google Ads and Google
// Merchant Center.
service MerchantCenterLinkService {
  option (google.api.default_host) = "googleads.googleapis.com";
  option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";

  // Returns Merchant Center links available for this customer.
  //
  // List of thrown errors:
  //   [AuthenticationError]()
  //   [AuthorizationError]()
  //   [HeaderError]()
  //   [InternalError]()
  //   [QuotaError]()
  //   [RequestError]()
  rpc ListMerchantCenterLinks(ListMerchantCenterLinksRequest)
      returns (ListMerchantCenterLinksResponse) {
    option (google.api.http) = {
      get: "/v13/customers/{customer_id=*}/merchantCenterLinks"
    };
    option (google.api.method_signature) = "customer_id";
  }

  // Returns the Merchant Center link in full detail.
  //
  // List of thrown errors:
  //   [AuthenticationError]()
  //   [AuthorizationError]()
  //   [HeaderError]()
  //   [InternalError]()
  //   [QuotaError]()
  //   [RequestError]()
  rpc GetMerchantCenterLink(GetMerchantCenterLinkRequest)
      returns (google.ads.googleads.v13.resources.MerchantCenterLink) {
    option (google.api.http) = {
      get: "/v13/{resource_name=customers/*/merchantCenterLinks/*}"
    };
    option (google.api.method_signature) = "resource_name";
  }

  // Updates status or removes a Merchant Center link.
  //
  // List of thrown errors:
  //   [AuthenticationError]()
  //   [AuthorizationError]()
  //   [FieldMaskError]()
  //   [HeaderError]()
  //   [InternalError]()
  //   [QuotaError]()
  //   [RequestError]()
  rpc MutateMerchantCenterLink(MutateMerchantCenterLinkRequest)
      returns (MutateMerchantCenterLinkResponse) {
    option (google.api.http) = {
      post: "/v13/customers/{customer_id=*}/merchantCenterLinks:mutate"
      body: "*"
    };
    option (google.api.method_signature) = "customer_id,operation";
  }
}

// Request message for
// [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v13.services.MerchantCenterLinkService.ListMerchantCenterLinks].
message ListMerchantCenterLinksRequest {
  // Required. The ID of the customer onto which to apply the Merchant Center
  // link list operation.
  string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
}

// Response message for
// [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v13.services.MerchantCenterLinkService.ListMerchantCenterLinks].
message ListMerchantCenterLinksResponse {
  // Merchant Center links available for the requested customer
  repeated google.ads.googleads.v13.resources.MerchantCenterLink
      merchant_center_links = 1;
}

// Request message for
// [MerchantCenterLinkService.GetMerchantCenterLink][google.ads.googleads.v13.services.MerchantCenterLinkService.GetMerchantCenterLink].
message GetMerchantCenterLinkRequest {
  // Required. Resource name of the Merchant Center link.
  string resource_name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "googleads.googleapis.com/MerchantCenterLink"
    }
  ];
}

// Request message for
// [MerchantCenterLinkService.MutateMerchantCenterLink][google.ads.googleads.v13.services.MerchantCenterLinkService.MutateMerchantCenterLink].
message MutateMerchantCenterLinkRequest {
  // Required. The ID of the customer being modified.
  string customer_id = 1 [(google.api.field_behavior) = REQUIRED];

  // Required. The operation to perform on the link
  MerchantCenterLinkOperation operation = 2
      [(google.api.field_behavior) = REQUIRED];

  // If true, the request is validated but not executed. Only errors are
  // returned, not results.
  bool validate_only = 3;
}

// A single update on a Merchant Center link.
message MerchantCenterLinkOperation {
  // FieldMask that determines which resource fields are modified in an update.
  google.protobuf.FieldMask update_mask = 3;

  // The operation to perform
  oneof operation {
    // Update operation: The merchant center link is expected to have a valid
    // resource name.
    google.ads.googleads.v13.resources.MerchantCenterLink update = 1;

    // Remove operation: A resource name for the removed merchant center link is
    // expected, in this format:
    //
    // `customers/{customer_id}/merchantCenterLinks/{merchant_center_id}`
    string remove = 2 [(google.api.resource_reference) = {
      type: "googleads.googleapis.com/MerchantCenterLink"
    }];
  }
}

// Response message for Merchant Center link mutate.
message MutateMerchantCenterLinkResponse {
  // Result for the mutate.
  MutateMerchantCenterLinkResult result = 2;
}

// The result for the Merchant Center link mutate.
message MutateMerchantCenterLinkResult {
  // Returned for successful operations.
  string resource_name = 1 [(google.api.resource_reference) = {
    type: "googleads.googleapis.com/MerchantCenterLink"
  }];
}
