// Copyright 2020 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.v5.services;

import "google/ads/googleads/v5/resources/feed_item_target.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";

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

// Proto file describing the FeedItemTarget service.

// Service to manage feed item targets.
service FeedItemTargetService {
  option (google.api.default_host) = "googleads.googleapis.com";

  // Returns the requested feed item targets in full detail.
  rpc GetFeedItemTarget(GetFeedItemTargetRequest) returns (google.ads.googleads.v5.resources.FeedItemTarget) {
    option (google.api.http) = {
      get: "/v5/{resource_name=customers/*/feedItemTargets/*}"
    };
    option (google.api.method_signature) = "resource_name";
  }

  // Creates or removes feed item targets. Operation statuses are returned.
  rpc MutateFeedItemTargets(MutateFeedItemTargetsRequest) returns (MutateFeedItemTargetsResponse) {
    option (google.api.http) = {
      post: "/v5/customers/{customer_id=*}/feedItemTargets:mutate"
      body: "*"
    };
    option (google.api.method_signature) = "customer_id,operations";
  }
}

// Request message for [FeedItemTargetService.GetFeedItemTarget][google.ads.googleads.v5.services.FeedItemTargetService.GetFeedItemTarget].
message GetFeedItemTargetRequest {
  // Required. The resource name of the feed item targets to fetch.
  string resource_name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "googleads.googleapis.com/FeedItemTarget"
    }
  ];
}

// Request message for [FeedItemTargetService.MutateFeedItemTargets][google.ads.googleads.v5.services.FeedItemTargetService.MutateFeedItemTargets].
message MutateFeedItemTargetsRequest {
  // Required. The ID of the customer whose feed item targets are being modified.
  string customer_id = 1 [(google.api.field_behavior) = REQUIRED];

  // Required. The list of operations to perform on individual feed item targets.
  repeated FeedItemTargetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
}

// A single operation (create, remove) on an feed item target.
message FeedItemTargetOperation {
  // The mutate operation.
  oneof operation {
    // Create operation: No resource name is expected for the new feed item
    // target.
    google.ads.googleads.v5.resources.FeedItemTarget create = 1;

    // Remove operation: A resource name for the removed feed item target is
    // expected, in this format:
    //
    // `customers/{customer_id}/feedItemTargets/{feed_id}~{feed_item_id}~{feed_item_target_type}~{feed_item_target_id}`
    string remove = 2;
  }
}

// Response message for an feed item target mutate.
message MutateFeedItemTargetsResponse {
  // All results for the mutate.
  repeated MutateFeedItemTargetResult results = 2;
}

// The result for the feed item target mutate.
message MutateFeedItemTargetResult {
  // Returned for successful operations.
  string resource_name = 1;
}
