google-ads-ad_manager-v1 0.a → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (208) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +154 -8
  5. data/lib/google/ads/ad_manager/v1/ad_unit_service/credentials.rb +44 -0
  6. data/lib/google/ads/ad_manager/v1/ad_unit_service/paths.rb +64 -0
  7. data/lib/google/ads/ad_manager/v1/ad_unit_service/rest/client.rb +644 -0
  8. data/lib/google/ads/ad_manager/v1/ad_unit_service/rest/service_stub.rb +264 -0
  9. data/lib/google/ads/ad_manager/v1/ad_unit_service/rest.rb +52 -0
  10. data/lib/google/ads/ad_manager/v1/ad_unit_service.rb +48 -0
  11. data/lib/google/ads/ad_manager/v1/company_service/credentials.rb +44 -0
  12. data/lib/google/ads/ad_manager/v1/company_service/paths.rb +64 -0
  13. data/lib/google/ads/ad_manager/v1/company_service/rest/client.rb +531 -0
  14. data/lib/google/ads/ad_manager/v1/company_service/rest/service_stub.rb +203 -0
  15. data/lib/google/ads/ad_manager/v1/company_service/rest.rb +52 -0
  16. data/lib/google/ads/ad_manager/v1/company_service.rb +48 -0
  17. data/lib/google/ads/ad_manager/v1/custom_field_service/credentials.rb +44 -0
  18. data/lib/google/ads/ad_manager/v1/custom_field_service/paths.rb +64 -0
  19. data/lib/google/ads/ad_manager/v1/custom_field_service/rest/client.rb +531 -0
  20. data/lib/google/ads/ad_manager/v1/custom_field_service/rest/service_stub.rb +203 -0
  21. data/lib/google/ads/ad_manager/v1/custom_field_service/rest.rb +52 -0
  22. data/lib/google/ads/ad_manager/v1/custom_field_service.rb +48 -0
  23. data/lib/google/ads/ad_manager/v1/custom_targeting_key_service/credentials.rb +44 -0
  24. data/lib/google/ads/ad_manager/v1/custom_targeting_key_service/paths.rb +64 -0
  25. data/lib/google/ads/ad_manager/v1/custom_targeting_key_service/rest/client.rb +532 -0
  26. data/lib/google/ads/ad_manager/v1/custom_targeting_key_service/rest/service_stub.rb +203 -0
  27. data/lib/google/ads/ad_manager/v1/custom_targeting_key_service/rest.rb +52 -0
  28. data/lib/google/ads/ad_manager/v1/custom_targeting_key_service.rb +48 -0
  29. data/lib/google/ads/ad_manager/v1/custom_targeting_value_service/credentials.rb +44 -0
  30. data/lib/google/ads/ad_manager/v1/custom_targeting_value_service/paths.rb +69 -0
  31. data/lib/google/ads/ad_manager/v1/custom_targeting_value_service/rest/client.rb +535 -0
  32. data/lib/google/ads/ad_manager/v1/custom_targeting_value_service/rest/service_stub.rb +203 -0
  33. data/lib/google/ads/ad_manager/v1/custom_targeting_value_service/rest.rb +52 -0
  34. data/lib/google/ads/ad_manager/v1/custom_targeting_value_service.rb +48 -0
  35. data/lib/google/ads/ad_manager/v1/entity_signals_mapping_service/credentials.rb +44 -0
  36. data/lib/google/ads/ad_manager/v1/entity_signals_mapping_service/paths.rb +64 -0
  37. data/lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/client.rb +894 -0
  38. data/lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest/service_stub.rb +451 -0
  39. data/lib/google/ads/ad_manager/v1/entity_signals_mapping_service/rest.rb +52 -0
  40. data/lib/google/ads/ad_manager/v1/entity_signals_mapping_service.rb +48 -0
  41. data/lib/google/ads/ad_manager/v1/network_service/credentials.rb +44 -0
  42. data/lib/google/ads/ad_manager/v1/network_service/paths.rb +47 -0
  43. data/lib/google/ads/ad_manager/v1/network_service/rest/client.rb +495 -0
  44. data/lib/google/ads/ad_manager/v1/network_service/rest/service_stub.rb +201 -0
  45. data/lib/google/ads/ad_manager/v1/network_service/rest.rb +52 -0
  46. data/lib/google/ads/ad_manager/v1/network_service.rb +48 -0
  47. data/lib/google/ads/ad_manager/v1/order_service/credentials.rb +44 -0
  48. data/lib/google/ads/ad_manager/v1/order_service/paths.rb +64 -0
  49. data/lib/google/ads/ad_manager/v1/order_service/rest/client.rb +541 -0
  50. data/lib/google/ads/ad_manager/v1/order_service/rest/service_stub.rb +203 -0
  51. data/lib/google/ads/ad_manager/v1/order_service/rest.rb +52 -0
  52. data/lib/google/ads/ad_manager/v1/order_service.rb +48 -0
  53. data/lib/google/ads/ad_manager/v1/placement_service/credentials.rb +44 -0
  54. data/lib/google/ads/ad_manager/v1/placement_service/paths.rb +64 -0
  55. data/lib/google/ads/ad_manager/v1/placement_service/rest/client.rb +531 -0
  56. data/lib/google/ads/ad_manager/v1/placement_service/rest/service_stub.rb +203 -0
  57. data/lib/google/ads/ad_manager/v1/placement_service/rest.rb +52 -0
  58. data/lib/google/ads/ad_manager/v1/placement_service.rb +48 -0
  59. data/lib/google/ads/ad_manager/v1/report_service/credentials.rb +44 -0
  60. data/lib/google/ads/ad_manager/v1/report_service/paths.rb +64 -0
  61. data/lib/google/ads/ad_manager/v1/report_service/rest/client.rb +923 -0
  62. data/lib/google/ads/ad_manager/v1/report_service/rest/operations.rb +914 -0
  63. data/lib/google/ads/ad_manager/v1/report_service/rest/service_stub.rb +450 -0
  64. data/lib/google/ads/ad_manager/v1/report_service/rest.rb +53 -0
  65. data/lib/google/ads/ad_manager/v1/report_service.rb +48 -0
  66. data/lib/google/ads/ad_manager/v1/rest.rb +49 -0
  67. data/lib/google/ads/ad_manager/v1/role_service/credentials.rb +44 -0
  68. data/lib/google/ads/ad_manager/v1/role_service/paths.rb +64 -0
  69. data/lib/google/ads/ad_manager/v1/role_service/rest/client.rb +530 -0
  70. data/lib/google/ads/ad_manager/v1/role_service/rest/service_stub.rb +203 -0
  71. data/lib/google/ads/ad_manager/v1/role_service/rest.rb +52 -0
  72. data/lib/google/ads/ad_manager/v1/role_service.rb +48 -0
  73. data/lib/google/ads/ad_manager/v1/taxonomy_category_service/credentials.rb +44 -0
  74. data/lib/google/ads/ad_manager/v1/taxonomy_category_service/paths.rb +64 -0
  75. data/lib/google/ads/ad_manager/v1/taxonomy_category_service/rest/client.rb +531 -0
  76. data/lib/google/ads/ad_manager/v1/taxonomy_category_service/rest/service_stub.rb +203 -0
  77. data/lib/google/ads/ad_manager/v1/taxonomy_category_service/rest.rb +52 -0
  78. data/lib/google/ads/ad_manager/v1/taxonomy_category_service.rb +48 -0
  79. data/lib/google/ads/ad_manager/v1/user_service/credentials.rb +44 -0
  80. data/lib/google/ads/ad_manager/v1/user_service/paths.rb +50 -0
  81. data/lib/google/ads/ad_manager/v1/user_service/rest/client.rb +421 -0
  82. data/lib/google/ads/ad_manager/v1/user_service/rest/service_stub.rb +142 -0
  83. data/lib/google/ads/ad_manager/v1/user_service/rest.rb +52 -0
  84. data/lib/google/ads/ad_manager/v1/user_service.rb +48 -0
  85. data/lib/google/ads/ad_manager/v1/version.rb +7 -2
  86. data/lib/google/ads/ad_manager/v1.rb +52 -0
  87. data/lib/google/ads/admanager/v1/ad_unit_enums_pb.rb +47 -0
  88. data/lib/google/ads/admanager/v1/ad_unit_messages_pb.rb +60 -0
  89. data/lib/google/ads/admanager/v1/ad_unit_service_pb.rb +53 -0
  90. data/lib/google/ads/admanager/v1/ad_unit_service_services_pb.rb +49 -0
  91. data/lib/google/ads/admanager/v1/admanager_error_pb.rb +45 -0
  92. data/lib/google/ads/admanager/v1/applied_label_pb.rb +45 -0
  93. data/lib/google/ads/admanager/v1/company_credit_status_enum_pb.rb +43 -0
  94. data/lib/google/ads/admanager/v1/company_messages_pb.rb +51 -0
  95. data/lib/google/ads/admanager/v1/company_service_pb.rb +51 -0
  96. data/lib/google/ads/admanager/v1/company_service_services_pb.rb +47 -0
  97. data/lib/google/ads/admanager/v1/company_type_enum_pb.rb +43 -0
  98. data/lib/google/ads/admanager/v1/contact_messages_pb.rb +45 -0
  99. data/lib/google/ads/admanager/v1/custom_field_enums_pb.rb +49 -0
  100. data/lib/google/ads/admanager/v1/custom_field_messages_pb.rb +47 -0
  101. data/lib/google/ads/admanager/v1/custom_field_service_pb.rb +51 -0
  102. data/lib/google/ads/admanager/v1/custom_field_service_services_pb.rb +47 -0
  103. data/lib/google/ads/admanager/v1/custom_field_value_pb.rb +46 -0
  104. data/lib/google/ads/admanager/v1/custom_targeting_key_enums_pb.rb +47 -0
  105. data/lib/google/ads/admanager/v1/custom_targeting_key_messages_pb.rb +46 -0
  106. data/lib/google/ads/admanager/v1/custom_targeting_key_service_pb.rb +51 -0
  107. data/lib/google/ads/admanager/v1/custom_targeting_key_service_services_pb.rb +47 -0
  108. data/lib/google/ads/admanager/v1/custom_targeting_value_enums_pb.rb +45 -0
  109. data/lib/google/ads/admanager/v1/custom_targeting_value_messages_pb.rb +46 -0
  110. data/lib/google/ads/admanager/v1/custom_targeting_value_service_pb.rb +51 -0
  111. data/lib/google/ads/admanager/v1/custom_targeting_value_service_services_pb.rb +47 -0
  112. data/lib/google/ads/admanager/v1/entity_signals_mapping_messages_pb.rb +45 -0
  113. data/lib/google/ads/admanager/v1/entity_signals_mapping_service_pb.rb +59 -0
  114. data/lib/google/ads/admanager/v1/entity_signals_mapping_service_services_pb.rb +55 -0
  115. data/lib/google/ads/admanager/v1/environment_type_enum_pb.rb +43 -0
  116. data/lib/google/ads/admanager/v1/frequency_cap_pb.rb +44 -0
  117. data/lib/google/ads/admanager/v1/label_messages_pb.rb +45 -0
  118. data/lib/google/ads/admanager/v1/network_messages_pb.rb +45 -0
  119. data/lib/google/ads/admanager/v1/network_service_pb.rb +51 -0
  120. data/lib/google/ads/admanager/v1/network_service_services_pb.rb +47 -0
  121. data/lib/google/ads/admanager/v1/order_enums_pb.rb +43 -0
  122. data/lib/google/ads/admanager/v1/order_messages_pb.rb +52 -0
  123. data/lib/google/ads/admanager/v1/order_service_pb.rb +51 -0
  124. data/lib/google/ads/admanager/v1/order_service_services_pb.rb +52 -0
  125. data/lib/google/ads/admanager/v1/placement_enums_pb.rb +43 -0
  126. data/lib/google/ads/admanager/v1/placement_messages_pb.rb +48 -0
  127. data/lib/google/ads/admanager/v1/placement_service_pb.rb +51 -0
  128. data/lib/google/ads/admanager/v1/placement_service_services_pb.rb +47 -0
  129. data/lib/google/ads/admanager/v1/report_service_pb.rb +97 -0
  130. data/lib/google/ads/admanager/v1/report_service_services_pb.rb +65 -0
  131. data/lib/google/ads/admanager/v1/role_enums_pb.rb +43 -0
  132. data/lib/google/ads/admanager/v1/role_messages_pb.rb +46 -0
  133. data/lib/google/ads/admanager/v1/role_service_pb.rb +51 -0
  134. data/lib/google/ads/admanager/v1/role_service_services_pb.rb +47 -0
  135. data/lib/google/ads/admanager/v1/size_pb.rb +45 -0
  136. data/lib/google/ads/admanager/v1/size_type_enum_pb.rb +43 -0
  137. data/lib/google/ads/admanager/v1/taxonomy_category_messages_pb.rb +46 -0
  138. data/lib/google/ads/admanager/v1/taxonomy_category_service_pb.rb +51 -0
  139. data/lib/google/ads/admanager/v1/taxonomy_category_service_services_pb.rb +47 -0
  140. data/lib/google/ads/admanager/v1/taxonomy_type_enum_pb.rb +43 -0
  141. data/lib/google/ads/admanager/v1/team_messages_pb.rb +45 -0
  142. data/lib/google/ads/admanager/v1/time_unit_enum_pb.rb +43 -0
  143. data/lib/google/ads/admanager/v1/user_messages_pb.rb +45 -0
  144. data/lib/google/ads/admanager/v1/user_service_pb.rb +48 -0
  145. data/lib/google/ads/admanager/v1/user_service_services_pb.rb +48 -0
  146. data/lib/google-ads-ad_manager-v1.rb +21 -0
  147. data/proto_docs/README.md +4 -0
  148. data/proto_docs/google/ads/admanager/v1/ad_unit_enums.rb +91 -0
  149. data/proto_docs/google/ads/admanager/v1/ad_unit_messages.rb +188 -0
  150. data/proto_docs/google/ads/admanager/v1/ad_unit_service.rb +160 -0
  151. data/proto_docs/google/ads/admanager/v1/admanager_error.rb +54 -0
  152. data/proto_docs/google/ads/admanager/v1/applied_label.rb +39 -0
  153. data/proto_docs/google/ads/admanager/v1/company_credit_status_enum.rb +101 -0
  154. data/proto_docs/google/ads/admanager/v1/company_messages.rb +101 -0
  155. data/proto_docs/google/ads/admanager/v1/company_service.rb +99 -0
  156. data/proto_docs/google/ads/admanager/v1/company_type_enum.rb +55 -0
  157. data/proto_docs/google/ads/admanager/v1/contact_messages.rb +43 -0
  158. data/proto_docs/google/ads/admanager/v1/custom_field_enums.rb +123 -0
  159. data/proto_docs/google/ads/admanager/v1/custom_field_messages.rb +78 -0
  160. data/proto_docs/google/ads/admanager/v1/custom_field_service.rb +99 -0
  161. data/proto_docs/google/ads/admanager/v1/custom_field_value.rb +58 -0
  162. data/proto_docs/google/ads/admanager/v1/custom_targeting_key_enums.rb +86 -0
  163. data/proto_docs/google/ads/admanager/v1/custom_targeting_key_messages.rb +59 -0
  164. data/proto_docs/google/ads/admanager/v1/custom_targeting_key_service.rb +100 -0
  165. data/proto_docs/google/ads/admanager/v1/custom_targeting_value_enums.rb +97 -0
  166. data/proto_docs/google/ads/admanager/v1/custom_targeting_value_messages.rb +54 -0
  167. data/proto_docs/google/ads/admanager/v1/custom_targeting_value_service.rb +103 -0
  168. data/proto_docs/google/ads/admanager/v1/entity_signals_mapping_messages.rb +53 -0
  169. data/proto_docs/google/ads/admanager/v1/entity_signals_mapping_service.rb +180 -0
  170. data/proto_docs/google/ads/admanager/v1/environment_type_enum.rb +45 -0
  171. data/proto_docs/google/ads/admanager/v1/frequency_cap.rb +41 -0
  172. data/proto_docs/google/ads/admanager/v1/label_messages.rb +36 -0
  173. data/proto_docs/google/ads/admanager/v1/network_messages.rb +67 -0
  174. data/proto_docs/google/ads/admanager/v1/network_service.rb +51 -0
  175. data/proto_docs/google/ads/admanager/v1/order_enums.rb +63 -0
  176. data/proto_docs/google/ads/admanager/v1/order_messages.rb +149 -0
  177. data/proto_docs/google/ads/admanager/v1/order_service.rb +99 -0
  178. data/proto_docs/google/ads/admanager/v1/placement_enums.rb +48 -0
  179. data/proto_docs/google/ads/admanager/v1/placement_messages.rb +62 -0
  180. data/proto_docs/google/ads/admanager/v1/placement_service.rb +99 -0
  181. data/proto_docs/google/ads/admanager/v1/report_service.rb +3476 -0
  182. data/proto_docs/google/ads/admanager/v1/role_enums.rb +45 -0
  183. data/proto_docs/google/ads/admanager/v1/role_messages.rb +51 -0
  184. data/proto_docs/google/ads/admanager/v1/role_service.rb +97 -0
  185. data/proto_docs/google/ads/admanager/v1/size.rb +48 -0
  186. data/proto_docs/google/ads/admanager/v1/size_type_enum.rb +66 -0
  187. data/proto_docs/google/ads/admanager/v1/taxonomy_category_messages.rb +59 -0
  188. data/proto_docs/google/ads/admanager/v1/taxonomy_category_service.rb +99 -0
  189. data/proto_docs/google/ads/admanager/v1/taxonomy_type_enum.rb +55 -0
  190. data/proto_docs/google/ads/admanager/v1/team_messages.rb +40 -0
  191. data/proto_docs/google/ads/admanager/v1/time_unit_enum.rb +63 -0
  192. data/proto_docs/google/ads/admanager/v1/user_messages.rb +69 -0
  193. data/proto_docs/google/ads/admanager/v1/user_service.rb +36 -0
  194. data/proto_docs/google/api/client.rb +459 -0
  195. data/proto_docs/google/api/field_behavior.rb +85 -0
  196. data/proto_docs/google/api/launch_stage.rb +71 -0
  197. data/proto_docs/google/api/resource.rb +227 -0
  198. data/proto_docs/google/longrunning/operations.rb +169 -0
  199. data/proto_docs/google/protobuf/any.rb +145 -0
  200. data/proto_docs/google/protobuf/duration.rb +98 -0
  201. data/proto_docs/google/protobuf/empty.rb +34 -0
  202. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  203. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  204. data/proto_docs/google/rpc/status.rb +48 -0
  205. data/proto_docs/google/type/date.rb +53 -0
  206. data/proto_docs/google/type/dayofweek.rb +49 -0
  207. data/proto_docs/google/type/timeofday.rb +45 -0
  208. metadata +248 -11
@@ -0,0 +1,48 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/ads/admanager/v1/user_service.proto for package 'Google.Ads.AdManager.V1'
3
+ # Original file comments:
4
+ # Copyright 2024 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/ads/admanager/v1/user_service_pb'
21
+
22
+ module Google
23
+ module Ads
24
+ module AdManager
25
+ module V1
26
+ module UserService
27
+ # Provides methods for handling User objects.
28
+ class Service
29
+
30
+ include ::GRPC::GenericService
31
+
32
+ self.marshal_class_method = :encode
33
+ self.unmarshal_class_method = :decode
34
+ self.service_name = 'google.ads.admanager.v1.UserService'
35
+
36
+ # API to retrieve a User object.
37
+ #
38
+ # To get the current user, the resource name
39
+ # `networks/{networkCode}/users/me` can be used.
40
+ rpc :GetUser, ::Google::Ads::AdManager::V1::GetUserRequest, ::Google::Ads::AdManager::V1::User
41
+ end
42
+
43
+ Stub = Service.rpc_stub_class
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/ads/ad_manager/v1"
@@ -0,0 +1,4 @@
1
+ # Google Ad Manager V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,91 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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 AdManager
23
+ module V1
24
+ # Wrapper message for
25
+ # {::Google::Ads::AdManager::V1::AdUnitStatusEnum::AdUnitStatus AdUnitStatus}
26
+ class AdUnitStatusEnum
27
+ include ::Google::Protobuf::MessageExts
28
+ extend ::Google::Protobuf::MessageExts::ClassMethods
29
+
30
+ # The status of an AdUnit.
31
+ module AdUnitStatus
32
+ # Default value. This value is unused.
33
+ AD_UNIT_STATUS_UNSPECIFIED = 0
34
+
35
+ # The ad unit is active, available for targeting, and serving.
36
+ ACTIVE = 1
37
+
38
+ # The ad unit will be visible in the UI, but ignored by serving.
39
+ INACTIVE = 2
40
+
41
+ # The ad unit will be hidden in the UI and ignored by serving.
42
+ ARCHIVED = 3
43
+ end
44
+ end
45
+
46
+ # Wrapper message for
47
+ # {::Google::Ads::AdManager::V1::SmartSizeModeEnum::SmartSizeMode SmartSizeMode}.
48
+ class SmartSizeModeEnum
49
+ include ::Google::Protobuf::MessageExts
50
+ extend ::Google::Protobuf::MessageExts::ClassMethods
51
+
52
+ # The smart size mode for this ad unit. This attribute is optional and
53
+ # defaults to SmartSizeMode.NONE for fixed sizes.
54
+ module SmartSizeMode
55
+ # Default value. This value is unused.
56
+ SMART_SIZE_MODE_UNSPECIFIED = 0
57
+
58
+ # Fixed size mode (default).
59
+ NONE = 1
60
+
61
+ # The height is fixed for the request, the width is a range.
62
+ SMART_BANNER = 2
63
+
64
+ # Height and width are ranges.
65
+ DYNAMIC_SIZE = 3
66
+ end
67
+ end
68
+
69
+ # Wrapper message for
70
+ # {::Google::Ads::AdManager::V1::TargetWindowEnum::TargetWindow TargetWindow}.
71
+ class TargetWindowEnum
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
+
75
+ # Corresponds to an HTML link's target attribute.
76
+ # See http://www.w3.org/TR/html401/present/frames.html#adef-target
77
+ module TargetWindow
78
+ # Default value. This value is unused.
79
+ TARGET_WINDOW_UNSPECIFIED = 0
80
+
81
+ # Specifies that the link should open in the full body of the page.
82
+ TOP = 1
83
+
84
+ # Specifies that the link should open in a new window.
85
+ BLANK = 2
86
+ end
87
+ end
88
+ end
89
+ end
90
+ end
91
+ end
@@ -0,0 +1,188 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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 AdManager
23
+ module V1
24
+ # The AdUnit resource.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Identifier. The resource name of the AdUnit.
28
+ # Format: `networks/{network_code}/adUnits/{ad_unit_id}`
29
+ # @!attribute [r] ad_unit_id
30
+ # @return [::Integer]
31
+ # Output only. AdUnit ID.
32
+ # @!attribute [rw] parent_ad_unit
33
+ # @return [::String]
34
+ # Required. Immutable. The AdUnit's parent. Every ad unit has a parent except
35
+ # for the root ad unit, which is created by Google. Format:
36
+ # "networks/\\{network_code}/adUnits/\\{ad_unit_id}"
37
+ # @!attribute [r] parent_path
38
+ # @return [::Array<::Google::Ads::AdManager::V1::AdUnitParent>]
39
+ # Output only. The path to this AdUnit in the ad unit hierarchy represented
40
+ # as a list from the root to this ad unit's parent. For root ad units, this
41
+ # list is empty.
42
+ # @!attribute [rw] display_name
43
+ # @return [::String]
44
+ # Required. The display name of the ad unit. Its maximum length is 255
45
+ # characters.
46
+ # @!attribute [rw] ad_unit_code
47
+ # @return [::String]
48
+ # Immutable. A string used to uniquely identify the ad unit for the purposes
49
+ # of serving the ad. This attribute is optional and can be set during ad unit
50
+ # creation. If it is not provided, it will be assigned by Google based on the
51
+ # ad unit ID.
52
+ # @!attribute [r] status
53
+ # @return [::Google::Ads::AdManager::V1::AdUnitStatusEnum::AdUnitStatus]
54
+ # Output only. The status of this ad unit. It defaults to ACTIVE.
55
+ # @!attribute [rw] applied_target_window
56
+ # @return [::Google::Ads::AdManager::V1::TargetWindowEnum::TargetWindow]
57
+ # Optional. The target window directly applied to this AdUnit.
58
+ # If this field is not set, this AdUnit uses the target window specified in
59
+ # effectiveTargetWindow.
60
+ # @!attribute [r] effective_target_window
61
+ # @return [::Google::Ads::AdManager::V1::TargetWindowEnum::TargetWindow]
62
+ # Output only. Non-empty default. The target window of this AdUnit. This
63
+ # value is inherited from ancestor AdUnits and defaults to TOP if no AdUnit
64
+ # in the hierarchy specifies it.
65
+ # @!attribute [rw] applied_teams
66
+ # @return [::Array<::String>]
67
+ # Optional. The resource names of Teams directly applied to this AdUnit.
68
+ # Format: "networks/\\{network_code}/teams/\\{team_id}"
69
+ # @!attribute [r] teams
70
+ # @return [::Array<::String>]
71
+ # Output only. The resource names of all Teams that this AdUnit is on as well
72
+ # as those inherited from parent AdUnits. Format:
73
+ # "networks/\\{network_code}/teams/\\{team_id}"
74
+ # @!attribute [rw] description
75
+ # @return [::String]
76
+ # Optional. A description of the ad unit. The maximum length is 65,535
77
+ # characters.
78
+ # @!attribute [rw] explicitly_targeted
79
+ # @return [::Boolean]
80
+ # Optional. If this field is set to true, then the AdUnit will not be
81
+ # implicitly targeted when its parent is. Traffickers must explicitly
82
+ # target such an AdUnit or else no line items will serve to it. This
83
+ # feature is only available for Ad Manager 360 accounts.
84
+ # @!attribute [r] has_children
85
+ # @return [::Boolean]
86
+ # Output only. This field is set to true if the ad unit has any children.
87
+ # @!attribute [r] update_time
88
+ # @return [::Google::Protobuf::Timestamp]
89
+ # Output only. The time this AdUnit was last modified.
90
+ # @!attribute [rw] ad_unit_sizes
91
+ # @return [::Array<::Google::Ads::AdManager::V1::AdUnitSize>]
92
+ # Optional. The sizes that can be served inside this ad unit.
93
+ # @!attribute [rw] external_set_top_box_channel_id
94
+ # @return [::String]
95
+ # Optional. Determines what set top box video on demand channel this ad unit
96
+ # corresponds to in an external set top box ad campaign system.
97
+ # @!attribute [rw] refresh_delay
98
+ # @return [::Google::Protobuf::Duration]
99
+ # Optional. The duration after which an Ad Unit will automatically refresh.
100
+ # This is only valid for ad units in mobile apps. If not set, the ad unit
101
+ # will not refresh.
102
+ # @!attribute [rw] applied_labels
103
+ # @return [::Array<::Google::Ads::AdManager::V1::AppliedLabel>]
104
+ # Optional. The set of labels applied directly to this ad unit.
105
+ # @!attribute [r] effective_applied_labels
106
+ # @return [::Array<::Google::Ads::AdManager::V1::AppliedLabel>]
107
+ # Output only. Contains the set of labels applied directly to the ad unit as
108
+ # well as those inherited from the parent ad units. If a label has been
109
+ # negated, only the negated label is returned. This field is readonly and is
110
+ # assigned by Google.
111
+ # @!attribute [rw] applied_label_frequency_caps
112
+ # @return [::Array<::Google::Ads::AdManager::V1::LabelFrequencyCap>]
113
+ # Optional. The set of label frequency caps applied directly to this ad unit.
114
+ # There is a limit of 10 label frequency caps per ad unit.
115
+ # @!attribute [r] effective_label_frequency_caps
116
+ # @return [::Array<::Google::Ads::AdManager::V1::LabelFrequencyCap>]
117
+ # Output only. The label frequency caps applied directly to the ad unit as
118
+ # well as those inherited from parent ad units.
119
+ # @!attribute [rw] smart_size_mode
120
+ # @return [::Google::Ads::AdManager::V1::SmartSizeModeEnum::SmartSizeMode]
121
+ # Optional. The smart size mode for this ad unit. This attribute is optional
122
+ # and defaults to SmartSizeMode.NONE for fixed sizes.
123
+ # @!attribute [rw] applied_adsense_enabled
124
+ # @return [::Boolean]
125
+ # Optional. The value of AdSense enabled directly applied to this ad unit.
126
+ # This attribute is optional and if not specified this ad unit will inherit
127
+ # the value of effectiveAdsenseEnabled from its ancestors.
128
+ # @!attribute [r] effective_adsense_enabled
129
+ # @return [::Boolean]
130
+ # Output only. Specifies whether or not the AdUnit is enabled for serving ads
131
+ # from the AdSense content network. This attribute defaults to the ad unit's
132
+ # parent or ancestor's setting if one has been set. If no ancestor of the ad
133
+ # unit has set appliedAdsenseEnabled, the attribute is defaulted to true.
134
+ class AdUnit
135
+ include ::Google::Protobuf::MessageExts
136
+ extend ::Google::Protobuf::MessageExts::ClassMethods
137
+ end
138
+
139
+ # Represents the size, environment, and companions of an ad in an ad unit.
140
+ # @!attribute [rw] size
141
+ # @return [::Google::Ads::AdManager::V1::Size]
142
+ # Required. The Size of the AdUnit.
143
+ # @!attribute [rw] environment_type
144
+ # @return [::Google::Ads::AdManager::V1::EnvironmentTypeEnum::EnvironmentType]
145
+ # Required. The EnvironmentType of the AdUnit
146
+ # @!attribute [rw] companions
147
+ # @return [::Array<::Google::Ads::AdManager::V1::Size>]
148
+ # The companions for this ad unit size. Companions are only valid if the
149
+ # environment is
150
+ # {::Google::Ads::AdManager::V1::EnvironmentTypeEnum::EnvironmentType VIDEO_PLAYER}.
151
+ class AdUnitSize
152
+ include ::Google::Protobuf::MessageExts
153
+ extend ::Google::Protobuf::MessageExts::ClassMethods
154
+ end
155
+
156
+ # The summary of a parent AdUnit.
157
+ # @!attribute [r] parent_ad_unit
158
+ # @return [::String]
159
+ # Output only. The parent of the current AdUnit
160
+ # Format: `networks/{network_code}/adUnits/{ad_unit_id}`
161
+ # @!attribute [r] display_name
162
+ # @return [::String]
163
+ # Output only. The display name of the parent AdUnit.
164
+ # @!attribute [r] ad_unit_code
165
+ # @return [::String]
166
+ # Output only. A string used to uniquely identify the ad unit for the
167
+ # purposes of serving the ad.
168
+ class AdUnitParent
169
+ include ::Google::Protobuf::MessageExts
170
+ extend ::Google::Protobuf::MessageExts::ClassMethods
171
+ end
172
+
173
+ # Frequency cap using a label.
174
+ # @!attribute [rw] label
175
+ # @return [::String]
176
+ # Required. The label to used for frequency capping.
177
+ # Format: "networks/\\{network_code}/labels/\\{label_id}"
178
+ # @!attribute [rw] frequency_cap
179
+ # @return [::Google::Ads::AdManager::V1::FrequencyCap]
180
+ # The frequency cap.
181
+ class LabelFrequencyCap
182
+ include ::Google::Protobuf::MessageExts
183
+ extend ::Google::Protobuf::MessageExts::ClassMethods
184
+ end
185
+ end
186
+ end
187
+ end
188
+ end
@@ -0,0 +1,160 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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 AdManager
23
+ module V1
24
+ # Request object for GetAdUnit method.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Required. The resource name of the AdUnit.
28
+ # Format: `networks/{network_code}/adUnits/{ad_unit_id}`
29
+ class GetAdUnitRequest
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
+ end
33
+
34
+ # Request object for ListAdUnits method.
35
+ # @!attribute [rw] parent
36
+ # @return [::String]
37
+ # Required. The parent, which owns this collection of AdUnits.
38
+ # Format: `networks/{network_code}`
39
+ # @!attribute [rw] page_size
40
+ # @return [::Integer]
41
+ # Optional. The maximum number of AdUnits to return. The service may return
42
+ # fewer than this value. If unspecified, at most 50 ad units will be
43
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
44
+ # 1000.
45
+ # @!attribute [rw] page_token
46
+ # @return [::String]
47
+ # Optional. A page token, received from a previous `ListAdUnits` call.
48
+ # Provide this to retrieve the subsequent page.
49
+ #
50
+ # When paginating, all other parameters provided to `ListAdUnits` must match
51
+ # the call that provided the page token.
52
+ # @!attribute [rw] filter
53
+ # @return [::String]
54
+ # Optional. Expression to filter the response.
55
+ # See syntax details at
56
+ # https://developers.google.com/ad-manager/api/beta/filters
57
+ # @!attribute [rw] order_by
58
+ # @return [::String]
59
+ # Optional. Expression to specify sorting order.
60
+ # See syntax details at
61
+ # https://developers.google.com/ad-manager/api/beta/filters#order
62
+ # @!attribute [rw] skip
63
+ # @return [::Integer]
64
+ # Optional. Number of individual resources to skip while paginating.
65
+ class ListAdUnitsRequest
66
+ include ::Google::Protobuf::MessageExts
67
+ extend ::Google::Protobuf::MessageExts::ClassMethods
68
+ end
69
+
70
+ # Response object for ListAdUnitsRequest containing matching AdUnit resources.
71
+ # @!attribute [rw] ad_units
72
+ # @return [::Array<::Google::Ads::AdManager::V1::AdUnit>]
73
+ # The AdUnit from the specified network.
74
+ # @!attribute [rw] next_page_token
75
+ # @return [::String]
76
+ # A token, which can be sent as `page_token` to retrieve the next page.
77
+ # If this field is omitted, there are no subsequent pages.
78
+ # @!attribute [rw] total_size
79
+ # @return [::Integer]
80
+ # Total number of AdUnits.
81
+ # If a filter was included in the request, this reflects the total number
82
+ # after the filtering is applied.
83
+ #
84
+ # `total_size` will not be calculated in the response unless it has been
85
+ # included in a response field mask. The response field mask can be provided
86
+ # to the method by using the URL parameter `$fields` or `fields`, or by using
87
+ # the HTTP/gRPC header `X-Goog-FieldMask`.
88
+ #
89
+ # For more information, see
90
+ # https://developers.google.com/ad-manager/api/beta/field-masks
91
+ class ListAdUnitsResponse
92
+ include ::Google::Protobuf::MessageExts
93
+ extend ::Google::Protobuf::MessageExts::ClassMethods
94
+ end
95
+
96
+ # Request object for ListAdUnitSizes method.
97
+ # @!attribute [rw] parent
98
+ # @return [::String]
99
+ # Required. The parent, which owns this collection of AdUnitSizes.
100
+ # Format: `networks/{network_code}`
101
+ # @!attribute [rw] page_size
102
+ # @return [::Integer]
103
+ # Optional. The maximum number of AdUnitSizes to return. The service may
104
+ # return fewer than this value. If unspecified, at most 50 ad unit sizes will
105
+ # be returned. The maximum value is 1000; values above 1000 will be coerced
106
+ # to 1000.
107
+ # @!attribute [rw] page_token
108
+ # @return [::String]
109
+ # Optional. A page token, received from a previous `ListAdUnitSizes` call.
110
+ # Provide this to retrieve the subsequent page.
111
+ #
112
+ # When paginating, all other parameters provided to `ListAdUnitSizes` must
113
+ # match the call that provided the page token.
114
+ # @!attribute [rw] filter
115
+ # @return [::String]
116
+ # Optional. Expression to filter the response.
117
+ # See syntax details at
118
+ # https://developers.google.com/ad-manager/api/beta/filters
119
+ # @!attribute [rw] order_by
120
+ # @return [::String]
121
+ # Optional. Expression to specify sorting order.
122
+ # See syntax details at
123
+ # https://developers.google.com/ad-manager/api/beta/filters#order
124
+ # @!attribute [rw] skip
125
+ # @return [::Integer]
126
+ # Optional. Number of individual resources to skip while paginating.
127
+ class ListAdUnitSizesRequest
128
+ include ::Google::Protobuf::MessageExts
129
+ extend ::Google::Protobuf::MessageExts::ClassMethods
130
+ end
131
+
132
+ # Response object for ListAdUnitSizesRequest containing matching AdUnitSizes.
133
+ # @!attribute [rw] ad_unit_sizes
134
+ # @return [::Array<::Google::Ads::AdManager::V1::AdUnitSize>]
135
+ # The AdUnitSizes from the specified network.
136
+ # @!attribute [rw] next_page_token
137
+ # @return [::String]
138
+ # A token, which can be sent as `page_token` to retrieve the next page.
139
+ # If this field is omitted, there are no subsequent pages.
140
+ # @!attribute [rw] total_size
141
+ # @return [::Integer]
142
+ # Total number of AdUnitSizes.
143
+ # If a filter was included in the request, this reflects the total number
144
+ # after the filtering is applied.
145
+ #
146
+ # `total_size` will not be calculated in the response unless it has been
147
+ # included in a response field mask. The response field mask can be provided
148
+ # to the method by using the URL parameter `$fields` or `fields`, or by using
149
+ # the HTTP/gRPC header `X-Goog-FieldMask`.
150
+ #
151
+ # For more information, see
152
+ # https://developers.google.com/ad-manager/api/beta/field-masks
153
+ class ListAdUnitSizesResponse
154
+ include ::Google::Protobuf::MessageExts
155
+ extend ::Google::Protobuf::MessageExts::ClassMethods
156
+ end
157
+ end
158
+ end
159
+ end
160
+ end
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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 AdManager
23
+ module V1
24
+ # / AdManagerError contains all the information required for processing a
25
+ # / particular error thrown by the AdManager API.
26
+ # /
27
+ # / At least one AdManagerError should be included in all error messages sent
28
+ # to / the client.
29
+ # @!attribute [rw] error_code
30
+ # @return [::String]
31
+ # The unique identifying string for this error.
32
+ # @!attribute [rw] message
33
+ # @return [::String]
34
+ # A publisher appropriate explanation of this error.
35
+ # @!attribute [rw] field_path
36
+ # @return [::String]
37
+ # The field path that triggered this error.
38
+ # @!attribute [rw] trigger
39
+ # @return [::String]
40
+ # The value that triggered this error.
41
+ # @!attribute [rw] stack_trace
42
+ # @return [::String]
43
+ # The stack trace that accompanies this error.
44
+ # @!attribute [rw] details
45
+ # @return [::Array<::Google::Protobuf::Any>]
46
+ # A list of messages that carry any additional error details.
47
+ class AdManagerError
48
+ include ::Google::Protobuf::MessageExts
49
+ extend ::Google::Protobuf::MessageExts::ClassMethods
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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 AdManager
23
+ module V1
24
+ # Represents a Label that can be applied to an entity.
25
+ # @!attribute [rw] label
26
+ # @return [::String]
27
+ # Required. The label to be applied.
28
+ # Format: "networks/\\{network_code}/labels/\\{label_id}"
29
+ # @!attribute [rw] negated
30
+ # @return [::Boolean]
31
+ # Specifies whether or not to negate the effects of the label.
32
+ class AppliedLabel
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
+ end
36
+ end
37
+ end
38
+ end
39
+ end