legacy-libs/google-proto-files/google/ads/googleads/v1/services/user_list_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/user_list.proto";
  21 import "google/api/annotations.proto";
  22 import "google/protobuf/field_mask.proto";
  23 import "google/protobuf/wrappers.proto";
  24 import "google/rpc/status.proto";
  25
  26 option csharp_namespace = "Google.Ads.GoogleAds.V1.Services";
  27 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/services;services";
  28 option java_multiple_files = true;
  29 option java_outer_classname = "UserListServiceProto";
  30 option java_package = "com.google.ads.googleads.v1.services";
  31 option objc_class_prefix = "GAA";
  32 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Services";
  33 option ruby_package = "Google::Ads::GoogleAds::V1::Services";
  34 // Proto file describing the User List service.
  35
  36 // Service to manage user lists.
  37 service UserListService {
  38   // Returns the requested user list.
  39   rpc GetUserList(GetUserListRequest) returns (google.ads.googleads.v1.resources.UserList) {
  40     option (google.api.http) = {
  41       get: "/v1/{resource_name=customers/*/userLists/*}"
  42     };
  43   }
  44
  45   // Creates or updates user lists. Operation statuses are returned.
  46   rpc MutateUserLists(MutateUserListsRequest) returns (MutateUserListsResponse) {
  47     option (google.api.http) = {
  48       post: "/v1/customers/{customer_id=*}/userLists:mutate"
  49       body: "*"
  50     };
  51   }
  52 }
  53
  54 // Request message for [UserListService.GetUserList][google.ads.googleads.v1.services.UserListService.GetUserList].
  55 message GetUserListRequest {
  56   // The resource name of the user list to fetch.
  57   string resource_name = 1;
  58 }
  59
  60 // Request message for [UserListService.MutateUserLists][google.ads.googleads.v1.services.UserListService.MutateUserLists].
  61 message MutateUserListsRequest {
  62   // The ID of the customer whose user lists are being modified.
  63   string customer_id = 1;
  64
  65   // The list of operations to perform on individual user lists.
  66   repeated UserListOperation operations = 2;
  67
  68   // If true, successful operations will be carried out and invalid
  69   // operations will return errors. If false, all operations will be carried
  70   // out in one transaction if and only if they are all valid.
  71   // Default is false.
  72   bool partial_failure = 3;
  73
  74   // If true, the request is validated but not executed. Only errors are
  75   // returned, not results.
  76   bool validate_only = 4;
  77 }
  78
  79 // A single operation (create, update) on a user list.
  80 message UserListOperation {
  81   // FieldMask that determines which resource fields are modified in an update.
  82   google.protobuf.FieldMask update_mask = 4;
  83
  84   // The mutate operation.
  85   oneof operation {
  86     // Create operation: No resource name is expected for the new user list.
  87     google.ads.googleads.v1.resources.UserList create = 1;
  88
  89     // Update operation: The user list is expected to have a valid resource
  90     // name.
  91     google.ads.googleads.v1.resources.UserList update = 2;
  92
  93     // Remove operation: A resource name for the removed user list is expected,
  94     // in this format:
  95     //
  96     // `customers/{customer_id}/userLists/{user_list_id}`
  97     string remove = 3;
  98   }
  99 }
 100
 101 // Response message for user list mutate.
 102 message MutateUserListsResponse {
 103   // Errors that pertain to operation failures in the partial failure mode.
 104   // Returned only when partial_failure = true and all errors occur inside the
 105   // operations. If any errors occur outside the operations (e.g. auth errors),
 106   // we return an RPC level error.
 107   google.rpc.Status partial_failure_error = 3;
 108
 109   // All results for the mutate.
 110   repeated MutateUserListResult results = 2;
 111 }
 112
 113 // The result for the user list mutate.
 114 message MutateUserListResult {
 115   // Returned for successful operations.
 116   string resource_name = 1;
 117 }