xref: /aosp_15_r20/external/googleapis/google/ads/googleads/v14/resources/payments_account.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 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
15syntax = "proto3";
16
17package google.ads.googleads.v14.resources;
18
19import "google/api/field_behavior.proto";
20import "google/api/resource.proto";
21
22option csharp_namespace = "Google.Ads.GoogleAds.V14.Resources";
23option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/resources;resources";
24option java_multiple_files = true;
25option java_outer_classname = "PaymentsAccountProto";
26option java_package = "com.google.ads.googleads.v14.resources";
27option objc_class_prefix = "GAA";
28option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Resources";
29option ruby_package = "Google::Ads::GoogleAds::V14::Resources";
30
31// Proto file describing the PaymentsAccount resource.
32
33// A payments account, which can be used to set up billing for an Ads customer.
34message PaymentsAccount {
35  option (google.api.resource) = {
36    type: "googleads.googleapis.com/PaymentsAccount"
37    pattern: "customers/{customer_id}/paymentsAccounts/{payments_account_id}"
38  };
39
40  // Output only. The resource name of the payments account.
41  // PaymentsAccount resource names have the form:
42  //
43  // `customers/{customer_id}/paymentsAccounts/{payments_account_id}`
44  string resource_name = 1 [
45    (google.api.field_behavior) = OUTPUT_ONLY,
46    (google.api.resource_reference) = {
47      type: "googleads.googleapis.com/PaymentsAccount"
48    }
49  ];
50
51  // Output only. A 16 digit ID used to identify a payments account.
52  optional string payments_account_id = 8
53      [(google.api.field_behavior) = OUTPUT_ONLY];
54
55  // Output only. The name of the payments account.
56  optional string name = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
57
58  // Output only. The currency code of the payments account.
59  // A subset of the currency codes derived from the ISO 4217 standard is
60  // supported.
61  optional string currency_code = 10
62      [(google.api.field_behavior) = OUTPUT_ONLY];
63
64  // Output only. A 12 digit ID used to identify the payments profile associated
65  // with the payments account.
66  optional string payments_profile_id = 11
67      [(google.api.field_behavior) = OUTPUT_ONLY];
68
69  // Output only. A secondary payments profile ID present in uncommon
70  // situations, for example, when a sequential liability agreement has been
71  // arranged.
72  optional string secondary_payments_profile_id = 12
73      [(google.api.field_behavior) = OUTPUT_ONLY];
74
75  // Output only. Paying manager of this payment account.
76  optional string paying_manager_customer = 13 [
77    (google.api.field_behavior) = OUTPUT_ONLY,
78    (google.api.resource_reference) = {
79      type: "googleads.googleapis.com/Customer"
80    }
81  ];
82}
83