blob: f90b792ac8f4c9235b2f7ae5eee7d552d5d8ad44 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
// 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.
//
syntax = "proto3";
package google.ads.googleads.v0.services;
import "google/ads/googleads/v0/resources/campaign_group.proto";
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Services";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignGroupServiceProto";
option java_package = "com.google.ads.googleads.v0.services";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Services";
// Proto file describing the Campaign group service.
// Service to manage campaign groups.
service CampaignGroupService {
// Returns the requested campaign group in full detail.
rpc GetCampaignGroup(GetCampaignGroupRequest) returns (google.ads.googleads.v0.resources.CampaignGroup) {
option (google.api.http) = {
get: "/v0/{resource_name=customers/*/campaignGroups/*}"
};
}
// Creates, updates, or removes campaign groups. Operation statuses are
// returned.
rpc MutateCampaignGroups(MutateCampaignGroupsRequest) returns (MutateCampaignGroupsResponse) {
option (google.api.http) = {
post: "/v0/customers/{customer_id=*}/campaignGroups:mutate"
body: "*"
};
}
}
// Request message for [CampaignGroupService.GetCampaignGroup][google.ads.googleads.v0.services.CampaignGroupService.GetCampaignGroup].
message GetCampaignGroupRequest {
// The resource name of the campaign group to fetch.
string resource_name = 1;
}
// Request message for [CampaignGroupService.MutateCampaignGroups][google.ads.googleads.v0.services.CampaignGroupService.MutateCampaignGroups].
message MutateCampaignGroupsRequest {
// The ID of the customer whose campaign groups are being modified.
string customer_id = 1;
// The list of operations to perform on individual campaign groups.
repeated CampaignGroupOperation operations = 2;
}
// A single operation (create, update, remove) on a campaign group.
message CampaignGroupOperation {
// 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
// group.
google.ads.googleads.v0.resources.CampaignGroup create = 1;
// Update operation: The campaign group is expected to have a valid
// resource name.
google.ads.googleads.v0.resources.CampaignGroup update = 2;
// Remove operation: A resource name for the removed campaign group is
// expected, in this format:
//
// `customers/{customer_id}/campaignGroups/{campaign_group_id}`
string remove = 3;
}
}
// Response message for campaign group mutate.
message MutateCampaignGroupsResponse {
// All results for the mutate.
repeated MutateCampaignGroupResult results = 2;
}
// The result for the campaign group mutate.
message MutateCampaignGroupResult {
// Returned for successful operations.
string resource_name = 1;
}
|
