legacy-libs/google-proto-files/google/ads/googleads/v0/services/payments_account_service.proto

   1 // Copyright 2018 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.v0.services;
  19
  20 import "google/ads/googleads/v0/resources/payments_account.proto";
  21 import "google/api/annotations.proto";
  22
  23 option csharp_namespace = "Google.Ads.GoogleAds.V0.Services";
  24 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/services;services";
  25 option java_multiple_files = true;
  26 option java_outer_classname = "PaymentsAccountServiceProto";
  27 option java_package = "com.google.ads.googleads.v0.services";
  28 option objc_class_prefix = "GAA";
  29 option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Services";
  30 option ruby_package = "Google::Ads::GoogleAds::V0::Services";
  31
  32 // Proto file describing the Payments account service.
  33
  34 // Service to provide Payments accounts that can be used to set up consolidated
  35 // billing.
  36 service PaymentsAccountService {
  37   // Returns all Payments accounts associated with all managers
  38   // between the login customer ID and specified serving customer in the
  39   // hierarchy, inclusive.
  40   rpc ListPaymentsAccounts(ListPaymentsAccountsRequest)
  41       returns (ListPaymentsAccountsResponse) {
  42     option (google.api.http) = {
  43       get: "/v0/customers/{customer_id=*}/paymentsAccounts"
  44     };
  45   }
  46 }
  47
  48 // Request message for fetching all accessible Payments accounts.
  49 message ListPaymentsAccountsRequest {
  50   // The ID of the customer to apply the PaymentsAccount list operation to.
  51   string customer_id = 1;
  52 }
  53
  54 // Response message for
  55 // [PaymentsAccountService.ListPaymentsAccounts][google.ads.googleads.v0.services.PaymentsAccountService.ListPaymentsAccounts].
  56 message ListPaymentsAccountsResponse {
  57   // The list of accessible Payments accounts.
  58   repeated google.ads.googleads.v0.resources.PaymentsAccount payments_accounts =
  59       1;
  60 }