legacy-libs/google-proto-files/google/ads/googleads/v1/services/custom_interest_service.proto

   1 // Copyright 2019 Google LLC.
   2 //
   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
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   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.
  14 //
  15
  16 syntax = "proto3";
  17
  18 package google.ads.googleads.v1.services;
  19
  20 import "google/ads/googleads/v1/resources/custom_interest.proto";
  21 import "google/api/annotations.proto";
  22 import "google/protobuf/field_mask.proto";
  23 import "google/protobuf/wrappers.proto";
  24
  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 = "CustomInterestServiceProto";
  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";
  33 // Proto file describing the Custom Interest service.
  34
  35 // Service to manage custom interests.
  36 service CustomInterestService {
  37   // Returns the requested custom interest in full detail.
  38   rpc GetCustomInterest(GetCustomInterestRequest) returns (google.ads.googleads.v1.resources.CustomInterest) {
  39     option (google.api.http) = {
  40       get: "/v1/{resource_name=customers/*/customInterests/*}"
  41     };
  42   }
  43
  44   // Creates or updates custom interests. Operation statuses are returned.
  45   rpc MutateCustomInterests(MutateCustomInterestsRequest) returns (MutateCustomInterestsResponse) {
  46     option (google.api.http) = {
  47       post: "/v1/customers/{customer_id=*}/customInterests:mutate"
  48       body: "*"
  49     };
  50   }
  51 }
  52
  53 // Request message for [CustomInterestService.GetCustomInterest][google.ads.googleads.v1.services.CustomInterestService.GetCustomInterest].
  54 message GetCustomInterestRequest {
  55   // The resource name of the custom interest to fetch.
  56   string resource_name = 1;
  57 }
  58
  59 // Request message for [CustomInterestService.MutateCustomInterests][google.ads.googleads.v1.services.CustomInterestService.MutateCustomInterests].
  60 message MutateCustomInterestsRequest {
  61   // The ID of the customer whose custom interests are being modified.
  62   string customer_id = 1;
  63
  64   // The list of operations to perform on individual custom interests.
  65   repeated CustomInterestOperation operations = 2;
  66
  67   // If true, the request is validated but not executed. Only errors are
  68   // returned, not results.
  69   bool validate_only = 4;
  70 }
  71
  72 // A single operation (create, update) on a custom interest.
  73 message CustomInterestOperation {
  74   // FieldMask that determines which resource fields are modified in an update.
  75   google.protobuf.FieldMask update_mask = 4;
  76
  77   // The mutate operation.
  78   oneof operation {
  79     // Create operation: No resource name is expected for the new custom
  80     // interest.
  81     google.ads.googleads.v1.resources.CustomInterest create = 1;
  82
  83     // Update operation: The custom interest is expected to have a valid
  84     // resource name.
  85     google.ads.googleads.v1.resources.CustomInterest update = 2;
  86   }
  87 }
  88
  89 // Response message for custom interest mutate.
  90 message MutateCustomInterestsResponse {
  91   // All results for the mutate.
  92   repeated MutateCustomInterestResult results = 2;
  93 }
  94
  95 // The result for the custom interest mutate.
  96 message MutateCustomInterestResult {
  97   // Returned for successful operations.
  98   string resource_name = 1;
  99 }