// 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.


// Proto file describing the Ad Group service.
syntax = "proto3";

package google.ads.googleads.v0.services;

import "google/ads/googleads/v0/resources/ad_group.proto";
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";

option java_package = "com.google.ads.googleads.v0.services";
option java_outer_classname = "AdGroupServiceProto";
option java_multiple_files = true;

// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Services";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Services";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Services";

// Service to manage ad groups.
service AdGroupService {
  // Returns the requested ad group in full detail.
  rpc GetAdGroup(GetAdGroupRequest) returns (resources.AdGroup) {
    option (google.api.http) = {
      get: "/v0/{resource_name=customers/*/adGroups/*}"
    };
  }

  // Creates, updates, or removes ad groups. Operation statuses are returned.
  rpc MutateAdGroups(MutateAdGroupsRequest) returns (MutateAdGroupsResponse) {
    option (google.api.http) = {
      post: "/v0/customers/{customer_id=*}/adGroups:mutate"
      body: "*"
    };
  }
}

// Request message for [AdGroupService.GetAdGroup][].
message GetAdGroupRequest {
  // The resource name of the ad group to fetch.
  string resource_name = 1;
}

// Request message for [AdGroupService.MutateAdGroups][].
message MutateAdGroupsRequest {
  // The ID of the customer whose ad groups are being modified.
  string customer_id = 1;

  // The list of operations to perform on individual ad groups.
  repeated AdGroupOperation operations = 2;
}

// A single operation (create, update, remove) on an ad group.
message AdGroupOperation {
  // FieldMask that determines which resource fields are modified in an update.
  google.protobuf.FieldMask update_mask = 4;

  // The mutate operation.
  oneof operation {
    // Create operation: No resource name is expected for the new ad group.
    resources.AdGroup create = 1;

    // Update operation: The ad group is expected to have a valid resource name.
    resources.AdGroup update = 2;

    // Remove operation: A resource name for the removed ad group is expected,
    // in this format:
    //
    // `customers/{customer_id}/adGroups/{ad_group_id}`
    string remove = 3;
  }
}

// Response message for an ad group mutate.
message MutateAdGroupsResponse {
  // All results for the mutate.
  repeated MutateAdGroupResult results = 2;
}

// The result for the ad group mutate.
message MutateAdGroupResult {
  // Returned for successful operations.
  string resource_name = 1;
}
