kpt-grpc-demo/google/ads/googleads/v10/services/conversion_goal_campaign_config_service.proto

// Copyright 2022 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.v10.services;

import "google/ads/googleads/v10/enums/response_content_type.proto";
import "google/ads/googleads/v10/resources/conversion_goal_campaign_config.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.V10.Services";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
option java_multiple_files = true;
option java_outer_classname = "ConversionGoalCampaignConfigServiceProto";
option java_package = "com.google.ads.googleads.v10.services";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
option ruby_package = "Google::Ads::GoogleAds::V10::Services";

// Proto file describing the ConversionGoalCampaignConfig service.

// Service to manage conversion goal campaign config.
service ConversionGoalCampaignConfigService {
  option (google.api.default_host) = "googleads.googleapis.com";
  option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";

  // Creates, updates or removes conversion goal campaign config. Operation
  // statuses are returned.
  rpc MutateConversionGoalCampaignConfigs(MutateConversionGoalCampaignConfigsRequest) returns (MutateConversionGoalCampaignConfigsResponse) {
    option (google.api.http) = {
      post: "/v10/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate"
      body: "*"
    };
    option (google.api.method_signature) = "customer_id,operations";
  }
}

// Request message for
// [ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfig][].
message MutateConversionGoalCampaignConfigsRequest {
  // Required. The ID of the customer whose custom conversion goals are being modified.
  string customer_id = 1 [(google.api.field_behavior) = REQUIRED];

  // Required. The list of operations to perform on individual conversion goal campaign
  // config.
  repeated ConversionGoalCampaignConfigOperation operations = 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;

  // The response content type setting. Determines whether the mutable resource
  // or just the resource name should be returned post mutation.
  google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4;
}

// A single operation (update) on a conversion goal campaign config.
message ConversionGoalCampaignConfigOperation {
  // 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 conversion goal campaign config is expected to have
    // a valid resource name.
    google.ads.googleads.v10.resources.ConversionGoalCampaignConfig update = 1;
  }
}

// Response message for a conversion goal campaign config mutate.
message MutateConversionGoalCampaignConfigsResponse {
  // All results for the mutate.
  repeated MutateConversionGoalCampaignConfigResult results = 1;
}

// The result for the conversion goal campaign config mutate.
message MutateConversionGoalCampaignConfigResult {
  // Returned for successful operations.
  string resource_name = 1 [(google.api.resource_reference) = {
                              type: "googleads.googleapis.com/ConversionGoalCampaignConfig"
                            }];

  // The mutated ConversionGoalCampaignConfig with only mutable fields after
  // mutate. The field will only be returned when response_content_type is set
  // to "MUTABLE_RESOURCE".
  google.ads.googleads.v10.resources.ConversionGoalCampaignConfig conversion_goal_campaign_config = 2;
}