// Copyright 2019 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.v2.services;

import "google/ads/googleads/v2/resources/ad.proto";
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "google/api/client.proto";

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

// Proto file describing the  Ad service.

// Service to manage ads.
service AdService {
  option (google.api.default_host) = "googleads.googleapis.com";

  // Returns the requested ad in full detail.
  rpc GetAd(GetAdRequest) returns (google.ads.googleads.v2.resources.Ad) {
    option (google.api.http) = {
      get: "/v2/{resource_name=customers/*/ads/*}"
    };
  }

  // Updates ads. Operation statuses are returned.
  rpc MutateAds(MutateAdsRequest) returns (MutateAdsResponse) {
    option (google.api.http) = {
      post: "/v2/customers/{customer_id=*}/ads:mutate"
      body: "*"
    };
  }
}

// Request message for [AdService.GetAd][google.ads.googleads.v2.services.AdService.GetAd].
message GetAdRequest {
  // The resource name of the ad to fetch.
  string resource_name = 1;
}

// Request message for [AdService.MutateAds][google.ads.googleads.v2.services.AdService.MutateAds].
message MutateAdsRequest {
  // The ID of the customer whose ads are being modified.
  string customer_id = 1;

  // The list of operations to perform on individual ads.
  repeated AdOperation operations = 2;
}

// A single update operation on an ad.
message AdOperation {
  // FieldMask that determines which resource fields are modified in an update.
  google.protobuf.FieldMask update_mask = 2;

  // The mutate operation.
  oneof operation {
    // Update operation: The ad is expected to have a valid resource name
    // in this format:
    //
    // `customers/{customer_id}/ads/{ad_id}`
    google.ads.googleads.v2.resources.Ad update = 1;
  }
}

// Response message for an ad mutate.
message MutateAdsResponse {
  // All results for the mutate.
  repeated MutateAdResult results = 2;
}

// The result for the ad mutate.
message MutateAdResult {
  // The resource name returned for successful operations.
  string resource_name = 1;
}