private/google/ads/googleads/v4/services/ad_group_extension_setting_service.proto
// 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.v4.services;
import "google/ads/googleads/v4/resources/ad_group_extension_setting.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";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V4.Services";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v4/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupExtensionSettingServiceProto";
option java_package = "com.google.ads.googleads.v4.services";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V4\\Services";
option ruby_package = "Google::Ads::GoogleAds::V4::Services";
// Proto file describing the AdGroupExtensionSetting service.
// Service to manage ad group extension settings.
service AdGroupExtensionSettingService {
option (google.api.default_host) = "googleads.googleapis.com";
// Returns the requested ad group extension setting in full detail.
rpc GetAdGroupExtensionSetting(GetAdGroupExtensionSettingRequest) returns (google.ads.googleads.v4.resources.AdGroupExtensionSetting) {
option (google.api.http) = {
get: "/v4/{resource_name=customers/*/adGroupExtensionSettings/*}"
};
option (google.api.method_signature) = "resource_name";
}
// Creates, updates, or removes ad group extension settings. Operation
// statuses are returned.
rpc MutateAdGroupExtensionSettings(MutateAdGroupExtensionSettingsRequest) returns (MutateAdGroupExtensionSettingsResponse) {
option (google.api.http) = {
post: "/v4/customers/{customer_id=*}/adGroupExtensionSettings:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
// Request message for
// [AdGroupExtensionSettingService.GetAdGroupExtensionSetting][google.ads.googleads.v4.services.AdGroupExtensionSettingService.GetAdGroupExtensionSetting].
message GetAdGroupExtensionSettingRequest {
// Required. The resource name of the ad group extension setting to fetch.
string resource_name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "googleads.googleapis.com/AdGroupExtensionSetting"
}
];
}
// Request message for
// [AdGroupExtensionSettingService.MutateAdGroupExtensionSettings][google.ads.googleads.v4.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings].
message MutateAdGroupExtensionSettingsRequest {
// Required. The ID of the customer whose ad group extension settings are being
// modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual ad group extension
// settings.
repeated AdGroupExtensionSettingOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
// out in one transaction if and only if they are all valid.
// Default is false.
bool partial_failure = 3;
// If true, the request is validated but not executed. Only errors are
// returned, not results.
bool validate_only = 4;
}
// A single operation (create, update, remove) on an ad group extension setting.
message AdGroupExtensionSettingOperation {
// 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
// extension setting.
google.ads.googleads.v4.resources.AdGroupExtensionSetting create = 1;
// Update operation: The ad group extension setting is expected to have a
// valid resource name.
google.ads.googleads.v4.resources.AdGroupExtensionSetting update = 2;
// Remove operation: A resource name for the removed ad group extension
// setting is expected, in this format:
//
// `customers/{customer_id}/adGroupExtensionSettings/{ad_group_id}~{extension_type}`
string remove = 3;
}
}
// Response message for an ad group extension setting mutate.
message MutateAdGroupExtensionSettingsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
// operations. If any errors occur outside the operations (e.g. auth errors),
// we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
repeated MutateAdGroupExtensionSettingResult results = 2;
}
// The result for the ad group extension setting mutate.
message MutateAdGroupExtensionSettingResult {
// Returned for successful operations.
string resource_name = 1;
}