// Copyright 2018 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.v0.services;

import "google/ads/googleads/v0/resources/campaign_shared_set.proto";
import "google/api/annotations.proto";

option csharp_namespace = "Google.Ads.GoogleAds.V0.Services";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignSharedSetServiceProto";
option java_package = "com.google.ads.googleads.v0.services";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Services";
// Proto file describing the Campaign Shared Set service.

// Service to manage campaign shared sets.
service CampaignSharedSetService {
  // Returns the requested campaign shared set in full detail.
  rpc GetCampaignSharedSet(GetCampaignSharedSetRequest) returns (google.ads.googleads.v0.resources.CampaignSharedSet) {
    option (google.api.http) = {
      get: "/v0/{resource_name=customers/*/campaignSharedSets/*}"
    };
  }

  // Creates or removes campaign shared sets. Operation statuses are returned.
  rpc MutateCampaignSharedSets(MutateCampaignSharedSetsRequest) returns (MutateCampaignSharedSetsResponse) {
    option (google.api.http) = {
      post: "/v0/customers/{customer_id=*}/campaignSharedSets:mutate"
      body: "*"
    };
  }
}

// Request message for [CampaignSharedSetService.GetCampaignSharedSet][google.ads.googleads.v0.services.CampaignSharedSetService.GetCampaignSharedSet].
message GetCampaignSharedSetRequest {
  // The resource name of the campaign shared set to fetch.
  string resource_name = 1;
}

// Request message for [CampaignSharedSetService.MutateCampaignSharedSets][google.ads.googleads.v0.services.CampaignSharedSetService.MutateCampaignSharedSets].
message MutateCampaignSharedSetsRequest {
  // The ID of the customer whose campaign shared sets are being modified.
  string customer_id = 1;

  // The list of operations to perform on individual campaign shared sets.
  repeated CampaignSharedSetOperation operations = 2;
}

// A single operation (create, remove) on an campaign shared set.
message CampaignSharedSetOperation {
  // The mutate operation.
  oneof operation {
    // Create operation: No resource name is expected for the new campaign
    // shared set.
    google.ads.googleads.v0.resources.CampaignSharedSet create = 1;

    // Remove operation: A resource name for the removed campaign shared set is
    // expected, in this format:
    //
    //
    // `customers/{customer_id}/campaignSharedSets/{campaign_id}_{shared_set_id}`
    string remove = 3;
  }
}

// Response message for a campaign shared set mutate.
message MutateCampaignSharedSetsResponse {
  // All results for the mutate.
  repeated MutateCampaignSharedSetResult results = 2;
}

// The result for the campaign shared set mutate.
message MutateCampaignSharedSetResult {
  // Returned for successful operations.
  string resource_name = 1;
}
