1 // Copyright 2019 Google LLC.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
18 package google.ads.googleads.v1.services;
20 import "google/ads/googleads/v1/resources/customer_client_link.proto";
21 import "google/api/annotations.proto";
22 import "google/protobuf/field_mask.proto";
23 import "google/protobuf/wrappers.proto";
25 option csharp_namespace = "Google.Ads.GoogleAds.V1.Services";
26 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/services;services";
27 option java_multiple_files = true;
28 option java_outer_classname = "CustomerClientLinkServiceProto";
29 option java_package = "com.google.ads.googleads.v1.services";
30 option objc_class_prefix = "GAA";
31 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Services";
32 option ruby_package = "Google::Ads::GoogleAds::V1::Services";
35 // Service to manage customer client links.
36 service CustomerClientLinkService {
37 // Returns the requested CustomerClientLink in full detail.
38 rpc GetCustomerClientLink(GetCustomerClientLinkRequest) returns (google.ads.googleads.v1.resources.CustomerClientLink) {
39 option (google.api.http) = {
40 get: "/v1/{resource_name=customers/*/customerClientLinks/*}"
44 // Creates or updates a customer client link. Operation statuses are returned.
45 rpc MutateCustomerClientLink(MutateCustomerClientLinkRequest) returns (MutateCustomerClientLinkResponse) {
46 option (google.api.http) = {
47 post: "/v1/customers/{customer_id=*}/customerClientLinks:mutate"
53 // Request message for [CustomerClientLinkService.GetCustomerClientLink][google.ads.googleads.v1.services.CustomerClientLinkService.GetCustomerClientLink].
54 message GetCustomerClientLinkRequest {
55 // The resource name of the customer client link to fetch.
56 string resource_name = 1;
59 // Request message for [CustomerClientLinkService.MutateCustomerClientLink][google.ads.googleads.v1.services.CustomerClientLinkService.MutateCustomerClientLink].
60 message MutateCustomerClientLinkRequest {
61 // The ID of the customer whose customer link are being modified.
62 string customer_id = 1;
64 // The operation to perform on the individual CustomerClientLink.
65 CustomerClientLinkOperation operation = 2;
68 // A single operation (create, update) on a CustomerClientLink.
69 message CustomerClientLinkOperation {
70 // FieldMask that determines which resource fields are modified in an update.
71 google.protobuf.FieldMask update_mask = 4;
73 // The mutate operation.
75 // Create operation: No resource name is expected for the new link.
76 google.ads.googleads.v1.resources.CustomerClientLink create = 1;
78 // Update operation: The link is expected to have a valid resource name.
79 google.ads.googleads.v1.resources.CustomerClientLink update = 2;
83 // Response message for a CustomerClientLink mutate.
84 message MutateCustomerClientLinkResponse {
85 // A result that identifies the resource affected by the mutate request.
86 MutateCustomerClientLinkResult result = 1;
89 // The result for a single customer client link mutate.
90 message MutateCustomerClientLinkResult {
91 // Returned for successful operations.
92 string resource_name = 1;