Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
123 lines (103 sloc) 4.23 KB
// 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.v1.services;
import "google/ads/googleads/v1/resources/campaign.proto";
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/wrappers.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V1.Services";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignServiceProto";
option java_package = "com.google.ads.googleads.v1.services";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Services";
option ruby_package = "Google::Ads::GoogleAds::V1::Services";
// Proto file describing the Campaign service.
// Service to manage campaigns.
service CampaignService {
// Returns the requested campaign in full detail.
rpc GetCampaign(GetCampaignRequest)
returns (google.ads.googleads.v1.resources.Campaign) {
option (google.api.http) = {
get: "/v1/{resource_name=customers/*/campaigns/*}"
};
}
// Creates, updates, or removes campaigns. Operation statuses are returned.
rpc MutateCampaigns(MutateCampaignsRequest)
returns (MutateCampaignsResponse) {
option (google.api.http) = {
post: "/v1/customers/{customer_id=*}/campaigns:mutate"
body: "*"
};
}
}
// Request message for
// [CampaignService.GetCampaign][google.ads.googleads.v1.services.CampaignService.GetCampaign].
message GetCampaignRequest {
// The resource name of the campaign to fetch.
string resource_name = 1;
}
// Request message for
// [CampaignService.MutateCampaigns][google.ads.googleads.v1.services.CampaignService.MutateCampaigns].
message MutateCampaignsRequest {
// The ID of the customer whose campaigns are being modified.
string customer_id = 1;
// The list of operations to perform on individual campaigns.
repeated CampaignOperation operations = 2;
// 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 a campaign.
message CampaignOperation {
// 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 campaign.
google.ads.googleads.v1.resources.Campaign create = 1;
// Update operation: The campaign is expected to have a valid
// resource name.
google.ads.googleads.v1.resources.Campaign update = 2;
// Remove operation: A resource name for the removed campaign is
// expected, in this format:
//
// `customers/{customer_id}/campaigns/{campaign_id}`
string remove = 3;
}
}
// Response message for campaign mutate.
message MutateCampaignsResponse {
// 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 MutateCampaignResult results = 2;
}
// The result for the campaign mutate.
message MutateCampaignResult {
// Returned for successful operations.
string resource_name = 1;
}
You can’t perform that action at this time.