google-ads-data_manager-v1 0.2.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/ads/data_manager/v1/marketing_data_insights_service/client.rb +494 -0
  3. data/lib/google/ads/data_manager/v1/marketing_data_insights_service/credentials.rb +47 -0
  4. data/lib/google/ads/data_manager/v1/marketing_data_insights_service/rest/client.rb +444 -0
  5. data/lib/google/ads/data_manager/v1/marketing_data_insights_service/rest/service_stub.rb +143 -0
  6. data/lib/google/ads/data_manager/v1/marketing_data_insights_service/rest.rb +53 -0
  7. data/lib/google/ads/data_manager/v1/marketing_data_insights_service.rb +56 -0
  8. data/lib/google/ads/data_manager/v1/partner_link_service/client.rb +739 -0
  9. data/lib/google/ads/data_manager/v1/partner_link_service/credentials.rb +48 -0
  10. data/lib/google/ads/data_manager/v1/partner_link_service/paths.rb +69 -0
  11. data/lib/google/ads/data_manager/v1/partner_link_service/rest/client.rb +675 -0
  12. data/lib/google/ads/data_manager/v1/partner_link_service/rest/service_stub.rb +265 -0
  13. data/lib/google/ads/data_manager/v1/partner_link_service/rest.rb +52 -0
  14. data/lib/google/ads/data_manager/v1/partner_link_service.rb +55 -0
  15. data/lib/google/ads/data_manager/v1/rest.rb +5 -0
  16. data/lib/google/ads/data_manager/v1/user_list_direct_license_service/client.rb +813 -0
  17. data/lib/google/ads/data_manager/v1/user_list_direct_license_service/credentials.rb +47 -0
  18. data/lib/google/ads/data_manager/v1/user_list_direct_license_service/paths.rb +69 -0
  19. data/lib/google/ads/data_manager/v1/user_list_direct_license_service/rest/client.rb +742 -0
  20. data/lib/google/ads/data_manager/v1/user_list_direct_license_service/rest/service_stub.rb +327 -0
  21. data/lib/google/ads/data_manager/v1/user_list_direct_license_service/rest.rb +56 -0
  22. data/lib/google/ads/data_manager/v1/user_list_direct_license_service.rb +59 -0
  23. data/lib/google/ads/data_manager/v1/user_list_global_license_service/client.rb +955 -0
  24. data/lib/google/ads/data_manager/v1/user_list_global_license_service/credentials.rb +47 -0
  25. data/lib/google/ads/data_manager/v1/user_list_global_license_service/paths.rb +69 -0
  26. data/lib/google/ads/data_manager/v1/user_list_global_license_service/rest/client.rb +877 -0
  27. data/lib/google/ads/data_manager/v1/user_list_global_license_service/rest/service_stub.rb +388 -0
  28. data/lib/google/ads/data_manager/v1/user_list_global_license_service/rest.rb +56 -0
  29. data/lib/google/ads/data_manager/v1/user_list_global_license_service.rb +59 -0
  30. data/lib/google/ads/data_manager/v1/user_list_service/client.rb +972 -0
  31. data/lib/google/ads/data_manager/v1/user_list_service/credentials.rb +47 -0
  32. data/lib/google/ads/data_manager/v1/user_list_service/paths.rb +69 -0
  33. data/lib/google/ads/data_manager/v1/user_list_service/rest/client.rb +894 -0
  34. data/lib/google/ads/data_manager/v1/user_list_service/rest/service_stub.rb +388 -0
  35. data/lib/google/ads/data_manager/v1/user_list_service/rest.rb +52 -0
  36. data/lib/google/ads/data_manager/v1/user_list_service.rb +55 -0
  37. data/lib/google/ads/data_manager/v1/version.rb +1 -1
  38. data/lib/google/ads/data_manager/v1.rb +5 -0
  39. data/lib/google/ads/datamanager/v1/age_range_pb.rb +21 -0
  40. data/lib/google/ads/datamanager/v1/audience_pb.rb +5 -26
  41. data/lib/google/ads/datamanager/v1/cart_data_pb.rb +4 -25
  42. data/lib/google/ads/datamanager/v1/consent_pb.rb +3 -24
  43. data/lib/google/ads/datamanager/v1/destination_pb.rb +4 -24
  44. data/lib/google/ads/datamanager/v1/device_info_pb.rb +3 -24
  45. data/lib/google/ads/datamanager/v1/encryption_info_pb.rb +3 -24
  46. data/lib/google/ads/datamanager/v1/error_pb.rb +3 -24
  47. data/lib/google/ads/datamanager/v1/event_pb.rb +4 -31
  48. data/lib/google/ads/datamanager/v1/experimental_field_pb.rb +3 -24
  49. data/lib/google/ads/datamanager/v1/gender_pb.rb +21 -0
  50. data/lib/google/ads/datamanager/v1/ingestion_service_pb.rb +3 -31
  51. data/lib/google/ads/datamanager/v1/insights_service_pb.rb +33 -0
  52. data/lib/google/ads/datamanager/v1/insights_service_services_pb.rb +62 -0
  53. data/lib/google/ads/datamanager/v1/item_parameter_pb.rb +3 -24
  54. data/lib/google/ads/datamanager/v1/match_rate_pb.rb +3 -24
  55. data/lib/google/ads/datamanager/v1/partner_link_service_pb.rb +32 -0
  56. data/lib/google/ads/datamanager/v1/partner_link_service_services_pb.rb +79 -0
  57. data/lib/google/ads/datamanager/v1/processing_errors_pb.rb +3 -24
  58. data/lib/google/ads/datamanager/v1/request_status_per_destination_pb.rb +7 -26
  59. data/lib/google/ads/datamanager/v1/terms_of_service_pb.rb +3 -24
  60. data/lib/google/ads/datamanager/v1/user_data_pb.rb +3 -24
  61. data/lib/google/ads/datamanager/v1/user_list_direct_license_pb.rb +28 -0
  62. data/lib/google/ads/datamanager/v1/user_list_direct_license_service_pb.rb +32 -0
  63. data/lib/google/ads/datamanager/v1/user_list_direct_license_service_services_pb.rb +63 -0
  64. data/lib/google/ads/datamanager/v1/user_list_global_license_pb.rb +30 -0
  65. data/lib/google/ads/datamanager/v1/user_list_global_license_service_pb.rb +34 -0
  66. data/lib/google/ads/datamanager/v1/user_list_global_license_service_services_pb.rb +67 -0
  67. data/lib/google/ads/datamanager/v1/user_list_global_license_type_pb.rb +21 -0
  68. data/lib/google/ads/datamanager/v1/user_list_license_client_account_type_pb.rb +21 -0
  69. data/lib/google/ads/datamanager/v1/user_list_license_metrics_pb.rb +23 -0
  70. data/lib/google/ads/datamanager/v1/user_list_license_pricing_pb.rb +26 -0
  71. data/lib/google/ads/datamanager/v1/user_list_license_status_pb.rb +21 -0
  72. data/lib/google/ads/datamanager/v1/user_list_pb.rb +43 -0
  73. data/lib/google/ads/datamanager/v1/user_list_service_pb.rb +34 -0
  74. data/lib/google/ads/datamanager/v1/user_list_service_services_pb.rb +118 -0
  75. data/lib/google/ads/datamanager/v1/user_properties_pb.rb +3 -24
  76. data/proto_docs/google/ads/datamanager/v1/age_range.rb +53 -0
  77. data/proto_docs/google/ads/datamanager/v1/audience.rb +42 -3
  78. data/proto_docs/google/ads/datamanager/v1/cart_data.rb +52 -0
  79. data/proto_docs/google/ads/datamanager/v1/destination.rb +3 -0
  80. data/proto_docs/google/ads/datamanager/v1/device_info.rb +31 -0
  81. data/proto_docs/google/ads/datamanager/v1/encryption_info.rb +6 -3
  82. data/proto_docs/google/ads/datamanager/v1/error.rb +212 -1
  83. data/proto_docs/google/ads/datamanager/v1/event.rb +47 -2
  84. data/proto_docs/google/ads/datamanager/v1/gender.rb +41 -0
  85. data/proto_docs/google/ads/datamanager/v1/insights_service.rb +133 -0
  86. data/proto_docs/google/ads/datamanager/v1/partner_link_service.rb +141 -0
  87. data/proto_docs/google/ads/datamanager/v1/processing_errors.rb +4 -1
  88. data/proto_docs/google/ads/datamanager/v1/request_status_per_destination.rb +121 -11
  89. data/proto_docs/google/ads/datamanager/v1/user_list.rb +403 -0
  90. data/proto_docs/google/ads/datamanager/v1/user_list_direct_license.rb +75 -0
  91. data/proto_docs/google/ads/datamanager/v1/user_list_direct_license_service.rb +134 -0
  92. data/proto_docs/google/ads/datamanager/v1/user_list_global_license.rb +114 -0
  93. data/proto_docs/google/ads/datamanager/v1/user_list_global_license_service.rb +204 -0
  94. data/proto_docs/google/ads/datamanager/v1/user_list_global_license_type.rb +41 -0
  95. data/proto_docs/google/ads/datamanager/v1/user_list_license_client_account_type.rb +44 -0
  96. data/proto_docs/google/ads/datamanager/v1/user_list_license_metrics.rb +55 -0
  97. data/proto_docs/google/ads/datamanager/v1/user_list_license_pricing.rb +108 -0
  98. data/proto_docs/google/ads/datamanager/v1/user_list_license_status.rb +38 -0
  99. data/proto_docs/google/ads/datamanager/v1/user_list_service.rb +151 -0
  100. data/proto_docs/google/api/client.rb +149 -29
  101. data/proto_docs/google/protobuf/empty.rb +34 -0
  102. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  103. metadata +73 -2
@@ -0,0 +1,108 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Ads
22
+ module DataManager
23
+ module V1
24
+ # A user list license pricing.
25
+ # @!attribute [r] pricing_id
26
+ # @return [::Integer]
27
+ # Output only. The ID of this pricing.
28
+ # @!attribute [rw] cost_micros
29
+ # @return [::Integer]
30
+ # Optional. The cost associated with the model, in micro units (10^-6), in
31
+ # the currency specified by the currency_code field. For example, 2000000
32
+ # means $2 if `currency_code` is `USD`.
33
+ # @!attribute [rw] currency_code
34
+ # @return [::String]
35
+ # Optional. The currency in which cost and max_cost is specified. Must be a
36
+ # three-letter currency code defined in ISO 4217.
37
+ # @!attribute [r] start_time
38
+ # @return [::Google::Protobuf::Timestamp]
39
+ # Output only. Start time of the pricing.
40
+ # @!attribute [rw] end_time
41
+ # @return [::Google::Protobuf::Timestamp]
42
+ # Optional. End time of the pricing.
43
+ # @!attribute [r] pricing_active
44
+ # @return [::Boolean]
45
+ # Output only. Whether this pricing is active.
46
+ # @!attribute [r] buyer_approval_state
47
+ # @return [::Google::Ads::DataManager::V1::UserListLicensePricing::UserListPricingBuyerApprovalState]
48
+ # Output only. The buyer approval state of this pricing.
49
+ #
50
+ # This field is read-only.
51
+ # @!attribute [rw] cost_type
52
+ # @return [::Google::Ads::DataManager::V1::UserListLicensePricing::UserListPricingCostType]
53
+ # Immutable. The cost type of this pricing.
54
+ #
55
+ # Can be set only in the `create` operation. Can't be updated for
56
+ # an existing license.
57
+ # @!attribute [rw] max_cost_micros
58
+ # @return [::Integer]
59
+ # Optional. The maximum CPM a commerce audience can be charged when the
60
+ # MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in
61
+ # the currency specified by the currency_code field. For example, 2000000
62
+ # means $2 if `currency_code` is `USD`.
63
+ #
64
+ # This is only relevant when cost_type is MEDIA_SHARE.
65
+ # When cost_type is not MEDIA_SHARE, and this field is set, a
66
+ # MAX_COST_NOT_ALLOWED error will be returned.
67
+ # If not set or set to`0`, there is no cap.
68
+ class UserListLicensePricing
69
+ include ::Google::Protobuf::MessageExts
70
+ extend ::Google::Protobuf::MessageExts::ClassMethods
71
+
72
+ # User list pricing buyer approval state.
73
+ module UserListPricingBuyerApprovalState
74
+ # UNSPECIFIED.
75
+ USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED = 0
76
+
77
+ # User list client has not yet accepted the pricing terms set by the user
78
+ # list owner.
79
+ PENDING = 1
80
+
81
+ # User list client has accepted the pricing terms set by the user list
82
+ # owner.
83
+ APPROVED = 2
84
+
85
+ # User list client has rejected the pricing terms set by the user list
86
+ # owner.
87
+ REJECTED = 3
88
+ end
89
+
90
+ # User list pricing cost type.
91
+ module UserListPricingCostType
92
+ # Unspecified.
93
+ USER_LIST_PRICING_COST_TYPE_UNSPECIFIED = 0
94
+
95
+ # Cost per click.
96
+ CPC = 1
97
+
98
+ # Cost per mille (thousand impressions).
99
+ CPM = 2
100
+
101
+ # Media share.
102
+ MEDIA_SHARE = 3
103
+ end
104
+ end
105
+ end
106
+ end
107
+ end
108
+ end
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Ads
22
+ module DataManager
23
+ module V1
24
+ # User list license status.
25
+ module UserListLicenseStatus
26
+ # Unknown.
27
+ USER_LIST_LICENSE_STATUS_UNSPECIFIED = 0
28
+
29
+ # Active status - user list is still being licensed.
30
+ USER_LIST_LICENSE_STATUS_ENABLED = 1
31
+
32
+ # Inactive status - user list is no longer being licensed.
33
+ USER_LIST_LICENSE_STATUS_DISABLED = 2
34
+ end
35
+ end
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,151 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Ads
22
+ module DataManager
23
+ module V1
24
+ # Request message for GetUserList.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Required. The resource name of the UserList to retrieve.
28
+ # Format:
29
+ # accountTypes/\\{account_type}/accounts/\\{account}/userLists/\\{user_list}
30
+ class GetUserListRequest
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Request message for ListUserLists.
36
+ # @!attribute [rw] parent
37
+ # @return [::String]
38
+ # Required. The parent account which owns this collection of user lists.
39
+ # Format: accountTypes/\\{account_type}/accounts/\\{account}
40
+ # @!attribute [rw] page_size
41
+ # @return [::Integer]
42
+ # Optional. The maximum number of user lists to return. The service may
43
+ # return fewer than this value. If unspecified, at most 50 user lists will be
44
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
45
+ # 1000.
46
+ # @!attribute [rw] page_token
47
+ # @return [::String]
48
+ # Optional. A page token, received from a previous `ListUserLists` call.
49
+ # Provide this to retrieve the subsequent page.
50
+ #
51
+ # When paginating, all other parameters provided to `ListUserLists` must
52
+ # match the call that provided the page token.
53
+ # @!attribute [rw] filter
54
+ # @return [::String]
55
+ # Optional. A [filter string](https://google.aip.dev/160). All fields need to
56
+ # be on the left hand side of each condition (for example: `display_name =
57
+ # "list 1"`). Fields must be specified using either all [camel
58
+ # case](https://en.wikipedia.org/wiki/Camel_case) or all [snake
59
+ # case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of
60
+ # camel case and snake case.
61
+ #
62
+ # Supported operations:
63
+ #
64
+ # - `AND`
65
+ # - `=`
66
+ # - `!=`
67
+ # - `>`
68
+ # - `>=`
69
+ # - `<`
70
+ # - `<=`
71
+ # - `:` (has)
72
+ #
73
+ # Supported fields:
74
+ #
75
+ # - `id`
76
+ # - `display_name`
77
+ # - `description`
78
+ # - `membership_status`
79
+ # - `integration_code`
80
+ # - `access_reason`
81
+ # - `ingested_user_list_info.upload_key_types`
82
+ class ListUserListsRequest
83
+ include ::Google::Protobuf::MessageExts
84
+ extend ::Google::Protobuf::MessageExts::ClassMethods
85
+ end
86
+
87
+ # Response message for ListUserLists.
88
+ # @!attribute [rw] user_lists
89
+ # @return [::Array<::Google::Ads::DataManager::V1::UserList>]
90
+ # The user lists from the specified account.
91
+ # @!attribute [rw] next_page_token
92
+ # @return [::String]
93
+ # A token, which can be sent as `page_token` to retrieve the next page.
94
+ # If this field is omitted, there are no subsequent pages.
95
+ class ListUserListsResponse
96
+ include ::Google::Protobuf::MessageExts
97
+ extend ::Google::Protobuf::MessageExts::ClassMethods
98
+ end
99
+
100
+ # Request message for CreateUserList.
101
+ # @!attribute [rw] parent
102
+ # @return [::String]
103
+ # Required. The parent account where this user list will be created.
104
+ # Format: accountTypes/\\{account_type}/accounts/\\{account}
105
+ # @!attribute [rw] user_list
106
+ # @return [::Google::Ads::DataManager::V1::UserList]
107
+ # Required. The user list to create.
108
+ # @!attribute [rw] validate_only
109
+ # @return [::Boolean]
110
+ # Optional. If true, the request is validated but not executed.
111
+ class CreateUserListRequest
112
+ include ::Google::Protobuf::MessageExts
113
+ extend ::Google::Protobuf::MessageExts::ClassMethods
114
+ end
115
+
116
+ # Request message for UpdateUserList.
117
+ # @!attribute [rw] user_list
118
+ # @return [::Google::Ads::DataManager::V1::UserList]
119
+ # Required. The user list to update.
120
+ #
121
+ # The user list's `name` field is used to identify the user list to update.
122
+ # Format:
123
+ # accountTypes/\\{account_type}/accounts/\\{account}/userLists/\\{user_list}
124
+ # @!attribute [rw] update_mask
125
+ # @return [::Google::Protobuf::FieldMask]
126
+ # Optional. The list of fields to update.
127
+ # @!attribute [rw] validate_only
128
+ # @return [::Boolean]
129
+ # Optional. If true, the request is validated but not executed.
130
+ class UpdateUserListRequest
131
+ include ::Google::Protobuf::MessageExts
132
+ extend ::Google::Protobuf::MessageExts::ClassMethods
133
+ end
134
+
135
+ # Request message for DeleteUserList.
136
+ # @!attribute [rw] name
137
+ # @return [::String]
138
+ # Required. The name of the user list to delete.
139
+ # Format:
140
+ # accountTypes/\\{account_type}/accounts/\\{account}/userLists/\\{user_list}
141
+ # @!attribute [rw] validate_only
142
+ # @return [::Boolean]
143
+ # Optional. If true, the request is validated but not executed.
144
+ class DeleteUserListRequest
145
+ include ::Google::Protobuf::MessageExts
146
+ extend ::Google::Protobuf::MessageExts::ClassMethods
147
+ end
148
+ end
149
+ end
150
+ end
151
+ end
@@ -31,6 +31,8 @@ module Google
31
31
  # @!attribute [rw] selective_gapic_generation
32
32
  # @return [::Google::Api::SelectiveGapicGeneration]
33
33
  # Configuration for which RPCs should be generated in the GAPIC client.
34
+ #
35
+ # Note: This field should not be used in most cases.
34
36
  class CommonLanguageSettings
35
37
  include ::Google::Protobuf::MessageExts
36
38
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -141,9 +143,10 @@ module Google
141
143
  #
142
144
  # Example of a YAML configuration::
143
145
  #
144
- # publishing:
145
- # java_settings:
146
- # library_package: com.google.cloud.pubsub.v1
146
+ # publishing:
147
+ # library_settings:
148
+ # java_settings:
149
+ # library_package: com.google.cloud.pubsub.v1
147
150
  # @!attribute [rw] service_class_names
148
151
  # @return [::Google::Protobuf::Map{::String => ::String}]
149
152
  # Configure the Java class name to use instead of the service's for its
@@ -155,11 +158,11 @@ module Google
155
158
  #
156
159
  # Example of a YAML configuration::
157
160
  #
158
- # publishing:
159
- # java_settings:
160
- # service_class_names:
161
- # - google.pubsub.v1.Publisher: TopicAdmin
162
- # - google.pubsub.v1.Subscriber: SubscriptionAdmin
161
+ # publishing:
162
+ # java_settings:
163
+ # service_class_names:
164
+ # - google.pubsub.v1.Publisher: TopicAdmin
165
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
163
166
  # @!attribute [rw] common
164
167
  # @return [::Google::Api::CommonLanguageSettings]
165
168
  # Some settings.
@@ -190,6 +193,20 @@ module Google
190
193
  # @!attribute [rw] common
191
194
  # @return [::Google::Api::CommonLanguageSettings]
192
195
  # Some settings.
196
+ # @!attribute [rw] library_package
197
+ # @return [::String]
198
+ # The package name to use in Php. Clobbers the php_namespace option
199
+ # set in the protobuf. This should be used **only** by APIs
200
+ # who have already set the language_settings.php.package_name" field
201
+ # in gapic.yaml. API teams should use the protobuf php_namespace option
202
+ # where possible.
203
+ #
204
+ # Example of a YAML configuration::
205
+ #
206
+ # publishing:
207
+ # library_settings:
208
+ # php_settings:
209
+ # library_package: Google\Cloud\PubSub\V1
193
210
  class PhpSettings
194
211
  include ::Google::Protobuf::MessageExts
195
212
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -318,10 +335,12 @@ module Google
318
335
  # service names and values are the name to be used for the service client
319
336
  # and call options.
320
337
  #
321
- # publishing:
322
- # go_settings:
323
- # renamed_services:
324
- # Publisher: TopicAdmin
338
+ # Example:
339
+ #
340
+ # publishing:
341
+ # go_settings:
342
+ # renamed_services:
343
+ # Publisher: TopicAdmin
325
344
  class GoSettings
326
345
  include ::Google::Protobuf::MessageExts
327
346
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -344,10 +363,10 @@ module Google
344
363
  #
345
364
  # Example:
346
365
  #
347
- # publishing:
348
- # method_settings:
349
- # - selector: google.storage.control.v2.StorageControl.CreateFolder
350
- # # method settings for CreateFolder...
366
+ # publishing:
367
+ # method_settings:
368
+ # - selector: google.storage.control.v2.StorageControl.CreateFolder
369
+ # # method settings for CreateFolder...
351
370
  # @!attribute [rw] long_running
352
371
  # @return [::Google::Api::MethodSettings::LongRunning]
353
372
  # Describes settings to use for long-running operations when generating
@@ -356,14 +375,14 @@ module Google
356
375
  #
357
376
  # Example of a YAML configuration::
358
377
  #
359
- # publishing:
360
- # method_settings:
361
- # - selector: google.cloud.speech.v2.Speech.BatchRecognize
362
- # long_running:
363
- # initial_poll_delay: 60s # 1 minute
364
- # poll_delay_multiplier: 1.5
365
- # max_poll_delay: 360s # 6 minutes
366
- # total_poll_timeout: 54000s # 90 minutes
378
+ # publishing:
379
+ # method_settings:
380
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
381
+ # long_running:
382
+ # initial_poll_delay: 60s # 1 minute
383
+ # poll_delay_multiplier: 1.5
384
+ # max_poll_delay: 360s # 6 minutes
385
+ # total_poll_timeout: 54000s # 90 minutes
367
386
  # @!attribute [rw] auto_populated_fields
368
387
  # @return [::Array<::String>]
369
388
  # List of top-level fields of the request message, that should be
@@ -372,11 +391,24 @@ module Google
372
391
  #
373
392
  # Example of a YAML configuration:
374
393
  #
375
- # publishing:
376
- # method_settings:
377
- # - selector: google.example.v1.ExampleService.CreateExample
378
- # auto_populated_fields:
379
- # - request_id
394
+ # publishing:
395
+ # method_settings:
396
+ # - selector: google.example.v1.ExampleService.CreateExample
397
+ # auto_populated_fields:
398
+ # - request_id
399
+ # @!attribute [rw] batching
400
+ # @return [::Google::Api::BatchingConfigProto]
401
+ # Batching configuration for an API method in client libraries.
402
+ #
403
+ # Example of a YAML configuration:
404
+ #
405
+ # publishing:
406
+ # method_settings:
407
+ # - selector: google.example.v1.ExampleService.BatchCreateExample
408
+ # batching:
409
+ # element_count_threshold: 1000
410
+ # request_byte_threshold: 100000000
411
+ # delay_threshold_millis: 10
380
412
  class MethodSettings
381
413
  include ::Google::Protobuf::MessageExts
382
414
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -411,6 +443,8 @@ module Google
411
443
 
412
444
  # This message is used to configure the generation of a subset of the RPCs in
413
445
  # a service for client libraries.
446
+ #
447
+ # Note: This feature should not be used in most cases.
414
448
  # @!attribute [rw] methods
415
449
  # @return [::Array<::String>]
416
450
  # An allowlist of the fully qualified names of RPCs that should be included
@@ -428,6 +462,77 @@ module Google
428
462
  extend ::Google::Protobuf::MessageExts::ClassMethods
429
463
  end
430
464
 
465
+ # `BatchingConfigProto` defines the batching configuration for an API method.
466
+ # @!attribute [rw] thresholds
467
+ # @return [::Google::Api::BatchingSettingsProto]
468
+ # The thresholds which trigger a batched request to be sent.
469
+ # @!attribute [rw] batch_descriptor
470
+ # @return [::Google::Api::BatchingDescriptorProto]
471
+ # The request and response fields used in batching.
472
+ class BatchingConfigProto
473
+ include ::Google::Protobuf::MessageExts
474
+ extend ::Google::Protobuf::MessageExts::ClassMethods
475
+ end
476
+
477
+ # `BatchingSettingsProto` specifies a set of batching thresholds, each of
478
+ # which acts as a trigger to send a batch of messages as a request. At least
479
+ # one threshold must be positive nonzero.
480
+ # @!attribute [rw] element_count_threshold
481
+ # @return [::Integer]
482
+ # The number of elements of a field collected into a batch which, if
483
+ # exceeded, causes the batch to be sent.
484
+ # @!attribute [rw] request_byte_threshold
485
+ # @return [::Integer]
486
+ # The aggregated size of the batched field which, if exceeded, causes the
487
+ # batch to be sent. This size is computed by aggregating the sizes of the
488
+ # request field to be batched, not of the entire request message.
489
+ # @!attribute [rw] delay_threshold
490
+ # @return [::Google::Protobuf::Duration]
491
+ # The duration after which a batch should be sent, starting from the addition
492
+ # of the first message to that batch.
493
+ # @!attribute [rw] element_count_limit
494
+ # @return [::Integer]
495
+ # The maximum number of elements collected in a batch that could be accepted
496
+ # by server.
497
+ # @!attribute [rw] request_byte_limit
498
+ # @return [::Integer]
499
+ # The maximum size of the request that could be accepted by server.
500
+ # @!attribute [rw] flow_control_element_limit
501
+ # @return [::Integer]
502
+ # The maximum number of elements allowed by flow control.
503
+ # @!attribute [rw] flow_control_byte_limit
504
+ # @return [::Integer]
505
+ # The maximum size of data allowed by flow control.
506
+ # @!attribute [rw] flow_control_limit_exceeded_behavior
507
+ # @return [::Google::Api::FlowControlLimitExceededBehaviorProto]
508
+ # The behavior to take when the flow control limit is exceeded.
509
+ class BatchingSettingsProto
510
+ include ::Google::Protobuf::MessageExts
511
+ extend ::Google::Protobuf::MessageExts::ClassMethods
512
+ end
513
+
514
+ # `BatchingDescriptorProto` specifies the fields of the request message to be
515
+ # used for batching, and, optionally, the fields of the response message to be
516
+ # used for demultiplexing.
517
+ # @!attribute [rw] batched_field
518
+ # @return [::String]
519
+ # The repeated field in the request message to be aggregated by batching.
520
+ # @!attribute [rw] discriminator_fields
521
+ # @return [::Array<::String>]
522
+ # A list of the fields in the request message. Two requests will be batched
523
+ # together only if the values of every field specified in
524
+ # `request_discriminator_fields` is equal between the two requests.
525
+ # @!attribute [rw] subresponse_field
526
+ # @return [::String]
527
+ # Optional. When present, indicates the field in the response message to be
528
+ # used to demultiplex the response into multiple response messages, in
529
+ # correspondence with the multiple request messages originally batched
530
+ # together.
531
+ class BatchingDescriptorProto
532
+ include ::Google::Protobuf::MessageExts
533
+ extend ::Google::Protobuf::MessageExts::ClassMethods
534
+ end
535
+
431
536
  # The organization for which the client libraries are being published.
432
537
  # Affects the url where generated docs are published, etc.
433
538
  module ClientLibraryOrganization
@@ -469,5 +574,20 @@ module Google
469
574
  # Publish the library to package managers like nuget.org and npmjs.com.
470
575
  PACKAGE_MANAGER = 20
471
576
  end
577
+
578
+ # The behavior to take when the flow control limit is exceeded.
579
+ module FlowControlLimitExceededBehaviorProto
580
+ # Default behavior, system-defined.
581
+ UNSET_BEHAVIOR = 0
582
+
583
+ # Stop operation, raise error.
584
+ THROW_EXCEPTION = 1
585
+
586
+ # Pause operation until limit clears.
587
+ BLOCK = 2
588
+
589
+ # Continue operation, disregard limit.
590
+ IGNORE = 3
591
+ end
472
592
  end
473
593
  end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Protobuf
22
+ # A generic empty message that you can re-use to avoid defining duplicated
23
+ # empty messages in your APIs. A typical example is to use it as the request
24
+ # or the response type of an API method. For instance:
25
+ #
26
+ # service Foo {
27
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
28
+ # }
29
+ class Empty
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
+ end
33
+ end
34
+ end