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,99 @@
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 `GetCustomField` method.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Required. The resource name of the CustomField.
28
+ # Format: `networks/{network_code}/customFields/{custom_field_id}`
29
+ class GetCustomFieldRequest
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
+ end
33
+
34
+ # Request object for `ListCustomFields` method.
35
+ # @!attribute [rw] parent
36
+ # @return [::String]
37
+ # Required. The parent, which owns this collection of CustomFields.
38
+ # Format: `networks/{network_code}`
39
+ # @!attribute [rw] page_size
40
+ # @return [::Integer]
41
+ # Optional. The maximum number of `CustomFields` to return. The service may
42
+ # return fewer than this value. If unspecified, at most 50 `CustomFields`
43
+ # will be returned. The maximum value is 1000; values above 1000 will be
44
+ # coerced to 1000.
45
+ # @!attribute [rw] page_token
46
+ # @return [::String]
47
+ # Optional. A page token, received from a previous `ListCustomFields` call.
48
+ # Provide this to retrieve the subsequent page.
49
+ #
50
+ # When paginating, all other parameters provided to `ListCustomFields` must
51
+ # match 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 ListCustomFieldsRequest
66
+ include ::Google::Protobuf::MessageExts
67
+ extend ::Google::Protobuf::MessageExts::ClassMethods
68
+ end
69
+
70
+ # Response object for `ListCustomFieldsRequest` containing matching
71
+ # `CustomField` objects.
72
+ # @!attribute [rw] custom_fields
73
+ # @return [::Array<::Google::Ads::AdManager::V1::CustomField>]
74
+ # The `CustomField` objects from the specified network.
75
+ # @!attribute [rw] next_page_token
76
+ # @return [::String]
77
+ # A token, which can be sent as `page_token` to retrieve the next page.
78
+ # If this field is omitted, there are no subsequent pages.
79
+ # @!attribute [rw] total_size
80
+ # @return [::Integer]
81
+ # Total number of `CustomField` objects.
82
+ # If a filter was included in the request, this reflects the total number
83
+ # after the filtering is applied.
84
+ #
85
+ # `total_size` will not be calculated in the response unless it has been
86
+ # included in a response field mask. The response field mask can be provided
87
+ # to the method by using the URL parameter `$fields` or `fields`, or by using
88
+ # the HTTP/gRPC header `X-Goog-FieldMask`.
89
+ #
90
+ # For more information, see
91
+ # https://developers.google.com/ad-manager/api/beta/field-masks
92
+ class ListCustomFieldsResponse
93
+ include ::Google::Protobuf::MessageExts
94
+ extend ::Google::Protobuf::MessageExts::ClassMethods
95
+ end
96
+ end
97
+ end
98
+ end
99
+ end
@@ -0,0 +1,58 @@
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
+ # A value for a CustomField on a resource.
25
+ # @!attribute [rw] custom_field
26
+ # @return [::String]
27
+ # Required. The custom field for which this is a value.
28
+ # Format: "networks/\\{network_code}/customFields/\\{custom_field_id}"
29
+ # @!attribute [rw] value
30
+ # @return [::Google::Ads::AdManager::V1::CustomFieldValue::Value]
31
+ # Required. A typed value representation of the value.
32
+ class CustomFieldValue
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
+
36
+ # Represent custom field value type.
37
+ # Next Id: 5
38
+ # @!attribute [rw] dropdown_value
39
+ # @return [::Integer]
40
+ # The custom_field_option_id, if the CustomFieldDataType is DROPDOWN.
41
+ # @!attribute [rw] string_value
42
+ # @return [::String]
43
+ # The value, if the CustomFieldDataType is STRING.
44
+ # @!attribute [rw] number_value
45
+ # @return [::Float]
46
+ # The value, if the CustomFieldDataType is NUMBER.
47
+ # @!attribute [rw] toggle_value
48
+ # @return [::Boolean]
49
+ # The value, if the CustomFieldDataType is TOGGLE.
50
+ class Value
51
+ include ::Google::Protobuf::MessageExts
52
+ extend ::Google::Protobuf::MessageExts::ClassMethods
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,86 @@
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::CustomTargetingKeyStatusEnum::CustomTargetingKeyStatus CustomTargetingKeyStatus}
26
+ class CustomTargetingKeyStatusEnum
27
+ include ::Google::Protobuf::MessageExts
28
+ extend ::Google::Protobuf::MessageExts::ClassMethods
29
+
30
+ # Status of the custom targeting key.
31
+ module CustomTargetingKeyStatus
32
+ # Not specified value.
33
+ CUSTOM_TARGETING_KEY_STATUS_UNSPECIFIED = 0
34
+
35
+ # Custom targeting key is active.
36
+ ACTIVE = 1
37
+
38
+ # Custom targeting key is inactive.
39
+ INACTIVE = 2
40
+ end
41
+ end
42
+
43
+ # Wrapper message for
44
+ # {::Google::Ads::AdManager::V1::CustomTargetingKeyTypeEnum::CustomTargetingKeyType CustomTargetingKeyType}
45
+ class CustomTargetingKeyTypeEnum
46
+ include ::Google::Protobuf::MessageExts
47
+ extend ::Google::Protobuf::MessageExts::ClassMethods
48
+
49
+ # Type of the custom targeting key.
50
+ module CustomTargetingKeyType
51
+ # Not specified value.
52
+ CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED = 0
53
+
54
+ # Key with a fixed set of values.
55
+ PREDEFINED = 1
56
+
57
+ # Key without a fixed set of values
58
+ FREEFORM = 2
59
+ end
60
+ end
61
+
62
+ # Wrapper message for
63
+ # {::Google::Ads::AdManager::V1::CustomTargetingKeyReportableTypeEnum::CustomTargetingKeyReportableType CustomTargetingKeyReportableType}
64
+ class CustomTargetingKeyReportableTypeEnum
65
+ include ::Google::Protobuf::MessageExts
66
+ extend ::Google::Protobuf::MessageExts::ClassMethods
67
+
68
+ # Reportable type of the custom targeting key.
69
+ module CustomTargetingKeyReportableType
70
+ # Not specified value.
71
+ CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED = 0
72
+
73
+ # Not available for reporting in the Ad Manager query tool.
74
+ OFF = 1
75
+
76
+ # Available for reporting in the Ad Manager query tool.
77
+ ON = 2
78
+
79
+ # Custom dimension available for reporting in the AdManager query tool.
80
+ CUSTOM_DIMENSION = 3
81
+ end
82
+ end
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,59 @@
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 `CustomTargetingKey` resource.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Identifier. The resource name of the `CustomTargetingKey`.
28
+ # Format:
29
+ # `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
30
+ # @!attribute [r] custom_targeting_key_id
31
+ # @return [::Integer]
32
+ # Output only. `CustomTargetingKey` ID.
33
+ # @!attribute [rw] ad_tag_name
34
+ # @return [::String]
35
+ # Immutable. Name of the key. Keys can contain up to 10 characters each. You
36
+ # can use alphanumeric characters and symbols other than the following:
37
+ # ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
38
+ # @!attribute [rw] display_name
39
+ # @return [::String]
40
+ # Optional. Descriptive name for the `CustomTargetingKey`.
41
+ # @!attribute [rw] type
42
+ # @return [::Google::Ads::AdManager::V1::CustomTargetingKeyTypeEnum::CustomTargetingKeyType]
43
+ # Required. Indicates whether users will select from predefined values or
44
+ # create new targeting values, while specifying targeting criteria for a line
45
+ # item.
46
+ # @!attribute [r] status
47
+ # @return [::Google::Ads::AdManager::V1::CustomTargetingKeyStatusEnum::CustomTargetingKeyStatus]
48
+ # Output only. Status of the `CustomTargetingKey`.
49
+ # @!attribute [rw] reportable_type
50
+ # @return [::Google::Ads::AdManager::V1::CustomTargetingKeyReportableTypeEnum::CustomTargetingKeyReportableType]
51
+ # Required. Reportable state of the `CustomTargetingKey`.
52
+ class CustomTargetingKey
53
+ include ::Google::Protobuf::MessageExts
54
+ extend ::Google::Protobuf::MessageExts::ClassMethods
55
+ end
56
+ end
57
+ end
58
+ end
59
+ end
@@ -0,0 +1,100 @@
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 `GetCustomTargetingKey` method.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Required. The resource name of the CustomTargetingKey.
28
+ # Format:
29
+ # `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
30
+ class GetCustomTargetingKeyRequest
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Request object for `ListCustomTargetingKeys` method.
36
+ # @!attribute [rw] parent
37
+ # @return [::String]
38
+ # Required. The parent, which owns this collection of CustomTargetingKeys.
39
+ # Format: `networks/{network_code}`
40
+ # @!attribute [rw] page_size
41
+ # @return [::Integer]
42
+ # Optional. The maximum number of `CustomTargetingKeys` to return. The
43
+ # service may return fewer than this value. If unspecified, at most 50
44
+ # `CustomTargetingKeys` will be returned. The maximum value is 1000; values
45
+ # above 1000 will be coerced to 1000.
46
+ # @!attribute [rw] page_token
47
+ # @return [::String]
48
+ # Optional. A page token, received from a previous `ListCustomTargetingKeys`
49
+ # call. Provide this to retrieve the subsequent page.
50
+ #
51
+ # When paginating, all other parameters provided to `ListCustomTargetingKeys`
52
+ # must match the call that provided the page token.
53
+ # @!attribute [rw] filter
54
+ # @return [::String]
55
+ # Optional. Expression to filter the response.
56
+ # See syntax details at
57
+ # https://developers.google.com/ad-manager/api/beta/filters
58
+ # @!attribute [rw] order_by
59
+ # @return [::String]
60
+ # Optional. Expression to specify sorting order.
61
+ # See syntax details at
62
+ # https://developers.google.com/ad-manager/api/beta/filters#order
63
+ # @!attribute [rw] skip
64
+ # @return [::Integer]
65
+ # Optional. Number of individual resources to skip while paginating.
66
+ class ListCustomTargetingKeysRequest
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+ end
70
+
71
+ # Response object for `ListCustomTargetingKeysRequest` containing matching
72
+ # `CustomTargetingKey` objects.
73
+ # @!attribute [rw] custom_targeting_keys
74
+ # @return [::Array<::Google::Ads::AdManager::V1::CustomTargetingKey>]
75
+ # The `CustomTargetingKey` objects from the specified network.
76
+ # @!attribute [rw] next_page_token
77
+ # @return [::String]
78
+ # A token, which can be sent as `page_token` to retrieve the next page.
79
+ # If this field is omitted, there are no subsequent pages.
80
+ # @!attribute [rw] total_size
81
+ # @return [::Integer]
82
+ # Total number of `CustomTargetingKey` objects.
83
+ # If a filter was included in the request, this reflects the total number
84
+ # after the filtering is applied.
85
+ #
86
+ # `total_size` will not be calculated in the response unless it has been
87
+ # included in a response field mask. The response field mask can be provided
88
+ # to the method by using the URL parameter `$fields` or `fields`, or by using
89
+ # the HTTP/gRPC header `X-Goog-FieldMask`.
90
+ #
91
+ # For more information, see
92
+ # https://developers.google.com/ad-manager/api/beta/field-masks
93
+ class ListCustomTargetingKeysResponse
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
97
+ end
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,97 @@
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::CustomTargetingValueStatusEnum::CustomTargetingValueStatus CustomTargetingValueStatus}
26
+ class CustomTargetingValueStatusEnum
27
+ include ::Google::Protobuf::MessageExts
28
+ extend ::Google::Protobuf::MessageExts::ClassMethods
29
+
30
+ # Status of the custom targeting value.
31
+ module CustomTargetingValueStatus
32
+ # Not specified value.
33
+ CUSTOM_TARGETING_VALUE_STATUS_UNSPECIFIED = 0
34
+
35
+ # Custom targeting value is active.
36
+ ACTIVE = 1
37
+
38
+ # Custom targeting value is inactive.
39
+ INACTIVE = 2
40
+ end
41
+ end
42
+
43
+ # Wrapper message for
44
+ # {::Google::Ads::AdManager::V1::CustomTargetingValueMatchTypeEnum::CustomTargetingValueMatchType CustomTargetingValueMatchType}
45
+ class CustomTargetingValueMatchTypeEnum
46
+ include ::Google::Protobuf::MessageExts
47
+ extend ::Google::Protobuf::MessageExts::ClassMethods
48
+
49
+ # Match type of the custom targeting value.
50
+ module CustomTargetingValueMatchType
51
+ # Not specified value.
52
+ CUSTOM_TARGETING_VALUE_MATCH_TYPE_UNSPECIFIED = 0
53
+
54
+ # Used for exact matching. For example, the targeting value car=honda will
55
+ # only match to the ad request car=honda.
56
+ EXACT = 1
57
+
58
+ # Used for lenient matching when at least one of the words in the ad
59
+ # request matches the targeted value. The targeting value car=honda will
60
+ # match to ad requests containing the word honda. So ad requests car=honda
61
+ # or car=honda civic or car=buy honda or car=how much does a honda cost
62
+ # will all have the line item delivered.
63
+ # This match type can not be used within an audience segment rule.
64
+ BROAD = 2
65
+
66
+ # Used for 'starts with' matching when the first few characters in the ad
67
+ # request match all of the characters in the targeted value. The targeting
68
+ # value car=honda will match to ad requests car=honda or car=hondas for
69
+ # sale but not to car=I want a honda.
70
+ PREFIX = 3
71
+
72
+ # This is a combination of MatchType#BROAD and MatchType#PREFIX matching.
73
+ # The targeting value car=honda will match to ad requests that contain
74
+ # words that start with the characters in the targeted value, for example
75
+ # with car=civic hondas.
76
+ # This match type can not be used within an audience segment rule.
77
+ BROAD_PREFIX = 4
78
+
79
+ # Used for 'ends with' matching when the last characters in the ad request
80
+ # match all of the characters in the targeted value. The targeting value
81
+ # car=honda will match with ad requests car=honda or car=I want a honda but
82
+ # not to car=hondas for sale.
83
+ # This match type can not be used within line item targeting.
84
+ SUFFIX = 5
85
+
86
+ # Used for 'within' matching when the string in the ad request contains the
87
+ # string in the targeted value. The targeting value car=honda will match
88
+ # with ad requests car=honda, car=I want a honda, and also with car=hondas
89
+ # for sale, but not with car=misspelled hond a. This match type can not be
90
+ # used within line item targeting.
91
+ CONTAINS = 6
92
+ end
93
+ end
94
+ end
95
+ end
96
+ end
97
+ 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
+ # The `CustomTargetingValue` resource.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Identifier. The resource name of the `CustomTargetingValue`.
28
+ # Format:
29
+ # `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}`
30
+ # @!attribute [rw] ad_tag_name
31
+ # @return [::String]
32
+ # Immutable. Name of the `CustomTargetingValue`. Values can contain up to 40
33
+ # characters each. You can use alphanumeric characters and symbols other than
34
+ # the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are
35
+ # not data-specific; all values are treated as strings. For example, instead
36
+ # of using "age>=18 AND <=34", try "18-34"
37
+ # @!attribute [rw] display_name
38
+ # @return [::String]
39
+ # Optional. Descriptive name for the `CustomTargetingValue`.
40
+ # @!attribute [rw] match_type
41
+ # @return [::Google::Ads::AdManager::V1::CustomTargetingValueMatchTypeEnum::CustomTargetingValueMatchType]
42
+ # Required. Immutable. The way in which the CustomTargetingValue.name strings
43
+ # will be matched.
44
+ # @!attribute [r] status
45
+ # @return [::Google::Ads::AdManager::V1::CustomTargetingValueStatusEnum::CustomTargetingValueStatus]
46
+ # Output only. Status of the `CustomTargetingValue`.
47
+ class CustomTargetingValue
48
+ include ::Google::Protobuf::MessageExts
49
+ extend ::Google::Protobuf::MessageExts::ClassMethods
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,103 @@
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 `GetCustomTargetingValue` method.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Required. The resource name of the CustomTargetingValue.
28
+ # Format:
29
+ # `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}`
30
+ class GetCustomTargetingValueRequest
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Request object for `ListCustomTargetingValues` method.
36
+ # @!attribute [rw] parent
37
+ # @return [::String]
38
+ # Required. The parent, which owns this collection of CustomTargetingValues.
39
+ # Format:
40
+ # `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
41
+ # @!attribute [rw] page_size
42
+ # @return [::Integer]
43
+ # Optional. The maximum number of `CustomTargetingValues` to return. The
44
+ # service may return fewer than this value. If unspecified, at most 50
45
+ # `CustomTargetingValues` will be returned. The maximum value is 1000; values
46
+ # above 1000 will be coerced to 1000.
47
+ # @!attribute [rw] page_token
48
+ # @return [::String]
49
+ # Optional. A page token, received from a previous
50
+ # `ListCustomTargetingValues` call. Provide this to retrieve the subsequent
51
+ # page.
52
+ #
53
+ # When paginating, all other parameters provided to
54
+ # `ListCustomTargetingValues` must match the call that provided the page
55
+ # token.
56
+ # @!attribute [rw] filter
57
+ # @return [::String]
58
+ # Optional. Expression to filter the response.
59
+ # See syntax details at
60
+ # https://developers.google.com/ad-manager/api/beta/filters
61
+ # @!attribute [rw] order_by
62
+ # @return [::String]
63
+ # Optional. Expression to specify sorting order.
64
+ # See syntax details at
65
+ # https://developers.google.com/ad-manager/api/beta/filters#order
66
+ # @!attribute [rw] skip
67
+ # @return [::Integer]
68
+ # Optional. Number of individual resources to skip while paginating.
69
+ class ListCustomTargetingValuesRequest
70
+ include ::Google::Protobuf::MessageExts
71
+ extend ::Google::Protobuf::MessageExts::ClassMethods
72
+ end
73
+
74
+ # Response object for `ListCustomTargetingValuesRequest` containing matching
75
+ # `CustomTargetingValue` objects.
76
+ # @!attribute [rw] custom_targeting_values
77
+ # @return [::Array<::Google::Ads::AdManager::V1::CustomTargetingValue>]
78
+ # The `CustomTargetingValue` objects from the specified network.
79
+ # @!attribute [rw] next_page_token
80
+ # @return [::String]
81
+ # A token, which can be sent as `page_token` to retrieve the next page.
82
+ # If this field is omitted, there are no subsequent pages.
83
+ # @!attribute [rw] total_size
84
+ # @return [::Integer]
85
+ # Total number of `CustomTargetingValue` objects.
86
+ # If a filter was included in the request, this reflects the total number
87
+ # after the filtering is applied.
88
+ #
89
+ # `total_size` will not be calculated in the response unless it has been
90
+ # included in a response field mask. The response field mask can be provided
91
+ # to the method by using the URL parameter `$fields` or `fields`, or by using
92
+ # the HTTP/gRPC header `X-Goog-FieldMask`.
93
+ #
94
+ # For more information, see
95
+ # https://developers.google.com/ad-manager/api/beta/field-masks
96
+ class ListCustomTargetingValuesResponse
97
+ include ::Google::Protobuf::MessageExts
98
+ extend ::Google::Protobuf::MessageExts::ClassMethods
99
+ end
100
+ end
101
+ end
102
+ end
103
+ end