google-api-client 0.10.2 → 0.10.3

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 (248) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/MIGRATING.md +22 -7
  4. data/README.md +4 -8
  5. data/api_names.yaml +1210 -37815
  6. data/generated/google/apis/acceleratedmobilepageurl_v1.rb +32 -0
  7. data/generated/google/apis/acceleratedmobilepageurl_v1/classes.rb +144 -0
  8. data/generated/google/apis/acceleratedmobilepageurl_v1/representations.rb +86 -0
  9. data/generated/google/apis/acceleratedmobilepageurl_v1/service.rb +90 -0
  10. data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
  11. data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +764 -764
  12. data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +180 -180
  13. data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +421 -421
  14. data/generated/google/apis/adexchangebuyer_v1_4/classes.rb +1 -0
  15. data/generated/google/apis/admin_directory_v1/classes.rb +1 -0
  16. data/generated/google/apis/admin_reports_v1.rb +1 -1
  17. data/generated/google/apis/adsense_v1_4.rb +1 -1
  18. data/generated/google/apis/adsensehost_v4_1.rb +1 -1
  19. data/generated/google/apis/analyticsreporting_v4/classes.rb +187 -187
  20. data/generated/google/apis/analyticsreporting_v4/representations.rb +42 -42
  21. data/generated/google/apis/appengine_v1.rb +40 -0
  22. data/generated/google/apis/appengine_v1/classes.rb +2251 -0
  23. data/generated/google/apis/appengine_v1/representations.rb +858 -0
  24. data/generated/google/apis/appengine_v1/service.rb +894 -0
  25. data/generated/google/apis/bigquery_v2.rb +1 -1
  26. data/generated/google/apis/bigquery_v2/classes.rb +11 -6
  27. data/generated/google/apis/books_v1.rb +1 -1
  28. data/generated/google/apis/books_v1/classes.rb +26 -0
  29. data/generated/google/apis/books_v1/representations.rb +15 -0
  30. data/generated/google/apis/books_v1/service.rb +4 -1
  31. data/generated/google/apis/calendar_v3.rb +1 -1
  32. data/generated/google/apis/classroom_v1.rb +1 -1
  33. data/generated/google/apis/cloudbuild_v1.rb +1 -1
  34. data/generated/google/apis/cloudbuild_v1/classes.rb +638 -637
  35. data/generated/google/apis/cloudbuild_v1/representations.rb +110 -110
  36. data/generated/google/apis/cloudbuild_v1/service.rb +139 -139
  37. data/generated/google/apis/clouddebugger_v2.rb +3 -3
  38. data/generated/google/apis/clouddebugger_v2/classes.rb +131 -131
  39. data/generated/google/apis/clouddebugger_v2/representations.rb +25 -25
  40. data/generated/google/apis/clouderrorreporting_v1beta1.rb +36 -0
  41. data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +590 -0
  42. data/generated/google/apis/clouderrorreporting_v1beta1/representations.rb +252 -0
  43. data/generated/google/apis/clouderrorreporting_v1beta1/service.rb +350 -0
  44. data/generated/google/apis/cloudfunctions_v1.rb +35 -0
  45. data/generated/google/apis/cloudfunctions_v1/classes.rb +98 -0
  46. data/generated/google/apis/cloudfunctions_v1/representations.rb +57 -0
  47. data/generated/google/apis/cloudfunctions_v1/service.rb +89 -0
  48. data/generated/google/apis/cloudkms_v1/classes.rb +277 -270
  49. data/generated/google/apis/cloudkms_v1/representations.rb +73 -73
  50. data/generated/google/apis/cloudkms_v1/service.rb +194 -194
  51. data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
  52. data/generated/google/apis/cloudresourcemanager_v1/classes.rb +1147 -1144
  53. data/generated/google/apis/cloudresourcemanager_v1/representations.rb +188 -188
  54. data/generated/google/apis/cloudresourcemanager_v1/service.rb +513 -936
  55. data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
  56. data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +307 -916
  57. data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +63 -285
  58. data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +333 -681
  59. data/generated/google/apis/cloudtrace_v1/classes.rb +38 -38
  60. data/generated/google/apis/cloudtrace_v1/representations.rb +13 -13
  61. data/generated/google/apis/cloudtrace_v1/service.rb +16 -16
  62. data/generated/google/apis/compute_beta.rb +1 -1
  63. data/generated/google/apis/compute_beta/classes.rb +32 -7
  64. data/generated/google/apis/compute_beta/representations.rb +2 -0
  65. data/generated/google/apis/compute_beta/service.rb +11 -11
  66. data/generated/google/apis/compute_v1.rb +1 -1
  67. data/generated/google/apis/compute_v1/classes.rb +95 -2
  68. data/generated/google/apis/compute_v1/representations.rb +33 -0
  69. data/generated/google/apis/dataflow_v1b3/classes.rb +3333 -3333
  70. data/generated/google/apis/dataflow_v1b3/representations.rb +759 -759
  71. data/generated/google/apis/dataflow_v1b3/service.rb +154 -154
  72. data/generated/google/apis/dataproc_v1.rb +1 -1
  73. data/generated/google/apis/dataproc_v1/classes.rb +1097 -1097
  74. data/generated/google/apis/dataproc_v1/representations.rb +200 -200
  75. data/generated/google/apis/dataproc_v1/service.rb +356 -356
  76. data/generated/google/apis/datastore_v1.rb +4 -4
  77. data/generated/google/apis/datastore_v1/classes.rb +701 -690
  78. data/generated/google/apis/datastore_v1/representations.rb +160 -160
  79. data/generated/google/apis/datastore_v1/service.rb +52 -52
  80. data/generated/google/apis/deploymentmanager_v2/classes.rb +4 -0
  81. data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
  82. data/generated/google/apis/drive_v2.rb +1 -1
  83. data/generated/google/apis/drive_v2/classes.rb +158 -35
  84. data/generated/google/apis/drive_v2/representations.rb +39 -0
  85. data/generated/google/apis/drive_v2/service.rb +4 -4
  86. data/generated/google/apis/drive_v3.rb +1 -1
  87. data/generated/google/apis/drive_v3/classes.rb +162 -33
  88. data/generated/google/apis/drive_v3/representations.rb +39 -0
  89. data/generated/google/apis/drive_v3/service.rb +4 -4
  90. data/generated/google/apis/firebasedynamiclinks_v1.rb +35 -0
  91. data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +466 -0
  92. data/generated/google/apis/firebasedynamiclinks_v1/representations.rb +222 -0
  93. data/generated/google/apis/firebasedynamiclinks_v1/service.rb +95 -0
  94. data/generated/google/apis/firebaserules_v1.rb +41 -0
  95. data/generated/google/apis/firebaserules_v1/classes.rb +425 -0
  96. data/generated/google/apis/firebaserules_v1/representations.rb +222 -0
  97. data/generated/google/apis/firebaserules_v1/service.rb +495 -0
  98. data/generated/google/apis/games_v1/classes.rb +4 -0
  99. data/generated/google/apis/genomics_v1.rb +7 -7
  100. data/generated/google/apis/genomics_v1/classes.rb +2336 -2335
  101. data/generated/google/apis/genomics_v1/representations.rb +387 -387
  102. data/generated/google/apis/genomics_v1/service.rb +1187 -1187
  103. data/generated/google/apis/gmail_v1/classes.rb +3 -0
  104. data/generated/google/apis/iam_v1.rb +1 -1
  105. data/generated/google/apis/iam_v1/classes.rb +123 -117
  106. data/generated/google/apis/iam_v1/representations.rb +33 -33
  107. data/generated/google/apis/iam_v1/service.rb +109 -109
  108. data/generated/google/apis/identitytoolkit_v3/classes.rb +5 -0
  109. data/generated/google/apis/kgsearch_v1/classes.rb +6 -6
  110. data/generated/google/apis/kgsearch_v1/representations.rb +1 -1
  111. data/generated/google/apis/kgsearch_v1/service.rb +4 -4
  112. data/generated/google/apis/language_v1.rb +36 -0
  113. data/generated/google/apis/language_v1/classes.rb +757 -0
  114. data/generated/google/apis/language_v1/representations.rb +338 -0
  115. data/generated/google/apis/language_v1/service.rb +185 -0
  116. data/generated/google/apis/language_v1beta1/classes.rb +407 -407
  117. data/generated/google/apis/language_v1beta1/representations.rb +103 -103
  118. data/generated/google/apis/language_v1beta1/service.rb +45 -45
  119. data/generated/google/apis/logging_v2.rb +46 -0
  120. data/generated/google/apis/logging_v2/classes.rb +1271 -0
  121. data/generated/google/apis/logging_v2/representations.rb +421 -0
  122. data/generated/google/apis/logging_v2/service.rb +1569 -0
  123. data/generated/google/apis/logging_v2beta1.rb +1 -1
  124. data/generated/google/apis/logging_v2beta1/classes.rb +886 -886
  125. data/generated/google/apis/logging_v2beta1/representations.rb +132 -132
  126. data/generated/google/apis/logging_v2beta1/service.rb +235 -235
  127. data/generated/google/apis/manufacturers_v1/classes.rb +147 -147
  128. data/generated/google/apis/manufacturers_v1/representations.rb +29 -29
  129. data/generated/google/apis/ml_v1.rb +34 -0
  130. data/generated/google/apis/ml_v1/classes.rb +1617 -0
  131. data/generated/google/apis/ml_v1/representations.rb +498 -0
  132. data/generated/google/apis/ml_v1/service.rb +769 -0
  133. data/generated/google/apis/monitoring_v3.rb +4 -4
  134. data/generated/google/apis/monitoring_v3/classes.rb +630 -630
  135. data/generated/google/apis/monitoring_v3/representations.rb +134 -134
  136. data/generated/google/apis/monitoring_v3/service.rb +240 -240
  137. data/generated/google/apis/pagespeedonline_v2/classes.rb +1 -0
  138. data/generated/google/apis/partners_v2.rb +1 -1
  139. data/generated/google/apis/partners_v2/classes.rb +639 -639
  140. data/generated/google/apis/partners_v2/representations.rb +168 -168
  141. data/generated/google/apis/partners_v2/service.rb +381 -381
  142. data/generated/google/apis/people_v1.rb +10 -10
  143. data/generated/google/apis/people_v1/classes.rb +524 -524
  144. data/generated/google/apis/people_v1/representations.rb +143 -143
  145. data/generated/google/apis/people_v1/service.rb +30 -30
  146. data/generated/google/apis/plus_domains_v1.rb +1 -1
  147. data/generated/google/apis/plus_v1.rb +1 -1
  148. data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +454 -444
  149. data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +90 -90
  150. data/generated/google/apis/proximitybeacon_v1beta1/service.rb +110 -110
  151. data/generated/google/apis/pubsub_v1/classes.rb +175 -173
  152. data/generated/google/apis/pubsub_v1/representations.rb +53 -53
  153. data/generated/google/apis/pubsub_v1/service.rb +210 -210
  154. data/generated/google/apis/replicapool_v1beta2/classes.rb +2 -0
  155. data/generated/google/apis/runtimeconfig_v1.rb +38 -0
  156. data/generated/google/apis/runtimeconfig_v1/classes.rb +252 -0
  157. data/generated/google/apis/runtimeconfig_v1/representations.rb +98 -0
  158. data/generated/google/apis/runtimeconfig_v1/service.rb +176 -0
  159. data/generated/google/apis/script_v1.rb +1 -1
  160. data/generated/google/apis/script_v1/classes.rb +6 -6
  161. data/generated/google/apis/script_v1/representations.rb +1 -1
  162. data/generated/google/apis/searchconsole_v1.rb +31 -0
  163. data/generated/google/apis/searchconsole_v1/classes.rb +205 -0
  164. data/generated/google/apis/searchconsole_v1/representations.rb +129 -0
  165. data/generated/google/apis/searchconsole_v1/service.rb +88 -0
  166. data/generated/google/apis/servicecontrol_v1.rb +38 -0
  167. data/generated/google/apis/servicecontrol_v1/classes.rb +1675 -0
  168. data/generated/google/apis/servicecontrol_v1/representations.rb +601 -0
  169. data/generated/google/apis/servicecontrol_v1/service.rb +337 -0
  170. data/generated/google/apis/servicemanagement_v1.rb +45 -0
  171. data/generated/google/apis/servicemanagement_v1/classes.rb +4934 -0
  172. data/generated/google/apis/servicemanagement_v1/representations.rb +1526 -0
  173. data/generated/google/apis/servicemanagement_v1/service.rb +860 -0
  174. data/generated/google/apis/serviceuser_v1.rb +42 -0
  175. data/generated/google/apis/serviceuser_v1/classes.rb +3746 -0
  176. data/generated/google/apis/serviceuser_v1/representations.rb +1041 -0
  177. data/generated/google/apis/serviceuser_v1/service.rb +214 -0
  178. data/generated/google/apis/sheets_v4.rb +3 -3
  179. data/generated/google/apis/sheets_v4/classes.rb +4390 -4390
  180. data/generated/google/apis/sheets_v4/representations.rb +381 -381
  181. data/generated/google/apis/sheets_v4/service.rb +48 -48
  182. data/generated/google/apis/slides_v1.rb +3 -3
  183. data/generated/google/apis/slides_v1/classes.rb +2860 -2860
  184. data/generated/google/apis/slides_v1/representations.rb +693 -693
  185. data/generated/google/apis/slides_v1/service.rb +30 -30
  186. data/generated/google/apis/sourcerepo_v1.rb +34 -0
  187. data/generated/google/apis/sourcerepo_v1/classes.rb +687 -0
  188. data/generated/google/apis/sourcerepo_v1/representations.rb +285 -0
  189. data/generated/google/apis/sourcerepo_v1/service.rb +291 -0
  190. data/generated/google/apis/spanner_v1.rb +35 -0
  191. data/generated/google/apis/spanner_v1/classes.rb +3294 -0
  192. data/generated/google/apis/spanner_v1/representations.rb +984 -0
  193. data/generated/google/apis/spanner_v1/service.rb +1504 -0
  194. data/generated/google/apis/speech_v1beta1.rb +1 -1
  195. data/generated/google/apis/speech_v1beta1/classes.rb +197 -196
  196. data/generated/google/apis/speech_v1beta1/representations.rb +53 -53
  197. data/generated/google/apis/speech_v1beta1/service.rb +27 -27
  198. data/generated/google/apis/storage_v1.rb +1 -1
  199. data/generated/google/apis/storage_v1/classes.rb +131 -0
  200. data/generated/google/apis/storage_v1/representations.rb +51 -0
  201. data/generated/google/apis/storage_v1/service.rb +182 -0
  202. data/generated/google/apis/storagetransfer_v1.rb +1 -1
  203. data/generated/google/apis/storagetransfer_v1/classes.rb +732 -661
  204. data/generated/google/apis/storagetransfer_v1/representations.rb +132 -132
  205. data/generated/google/apis/storagetransfer_v1/service.rb +174 -197
  206. data/generated/google/apis/surveys_v2.rb +40 -0
  207. data/generated/google/apis/surveys_v2/classes.rb +806 -0
  208. data/generated/google/apis/surveys_v2/representations.rb +347 -0
  209. data/generated/google/apis/surveys_v2/service.rb +477 -0
  210. data/generated/google/apis/tagmanager_v2.rb +52 -0
  211. data/generated/google/apis/tagmanager_v2/classes.rb +2435 -0
  212. data/generated/google/apis/tagmanager_v2/representations.rb +993 -0
  213. data/generated/google/apis/tagmanager_v2/service.rb +2865 -0
  214. data/generated/google/apis/toolresults_v1beta3.rb +34 -0
  215. data/generated/google/apis/toolresults_v1beta3/classes.rb +2160 -0
  216. data/generated/google/apis/toolresults_v1beta3/representations.rb +729 -0
  217. data/generated/google/apis/toolresults_v1beta3/service.rb +1236 -0
  218. data/generated/google/apis/tracing_v1.rb +40 -0
  219. data/generated/google/apis/tracing_v1/classes.rb +664 -0
  220. data/generated/google/apis/tracing_v1/representations.rb +279 -0
  221. data/generated/google/apis/tracing_v1/service.rb +225 -0
  222. data/generated/google/apis/vision_v1.rb +1 -1
  223. data/generated/google/apis/vision_v1/classes.rb +1223 -1222
  224. data/generated/google/apis/vision_v1/representations.rb +234 -234
  225. data/generated/google/apis/vision_v1/service.rb +10 -10
  226. data/generated/google/apis/webfonts_v1.rb +33 -0
  227. data/generated/google/apis/webfonts_v1/classes.rb +113 -0
  228. data/generated/google/apis/webfonts_v1/representations.rb +62 -0
  229. data/generated/google/apis/webfonts_v1/service.rb +102 -0
  230. data/generated/google/apis/youtube_analytics_v1.rb +1 -1
  231. data/generated/google/apis/youtube_partner_v1.rb +1 -1
  232. data/generated/google/apis/youtube_partner_v1/classes.rb +31 -0
  233. data/generated/google/apis/youtube_partner_v1/representations.rb +6 -0
  234. data/generated/google/apis/youtube_partner_v1/service.rb +41 -0
  235. data/generated/google/apis/youtube_v3/classes.rb +1 -0
  236. data/generated/google/apis/youtubereporting_v1.rb +4 -4
  237. data/generated/google/apis/youtubereporting_v1/classes.rb +76 -76
  238. data/generated/google/apis/youtubereporting_v1/representations.rb +25 -25
  239. data/generated/google/apis/youtubereporting_v1/service.rb +95 -95
  240. data/lib/google/apis/generator/annotator.rb +5 -4
  241. data/lib/google/apis/generator/templates/_class.tmpl +3 -0
  242. data/lib/google/apis/version.rb +1 -1
  243. data/samples/cli/lib/samples/adsense.rb +99 -0
  244. data/samples/cli/lib/samples/analytics.rb +18 -0
  245. data/samples/cli/lib/samples/gmail.rb +33 -0
  246. data/samples/cli/lib/samples/vision.rb +69 -0
  247. metadata +89 -4
  248. data/sync.rb +0 -71
@@ -0,0 +1,32 @@
1
+ # Copyright 2015 Google Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/acceleratedmobilepageurl_v1/service.rb'
16
+ require 'google/apis/acceleratedmobilepageurl_v1/classes.rb'
17
+ require 'google/apis/acceleratedmobilepageurl_v1/representations.rb'
18
+
19
+ module Google
20
+ module Apis
21
+ # Accelerated Mobile Pages (AMP) URL API
22
+ #
23
+ # This API contains a single method, batchGet. Call this method to retrieve the
24
+ # AMP URL (and equivalent AMP Cache URL) for given public URL(s).
25
+ #
26
+ # @see https://developers.google.com/amp/cache/
27
+ module AcceleratedmobilepageurlV1
28
+ VERSION = 'V1'
29
+ REVISION = '20170329'
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,144 @@
1
+ # Copyright 2015 Google Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module AcceleratedmobilepageurlV1
24
+
25
+ # Batch AMP URL response.
26
+ class BatchGetAmpUrlsResponse
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # For each URL in BatchAmpUrlsRequest, the URL response. The response might
30
+ # not be in the same order as URLs in the batch request.
31
+ # If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated
32
+ # only once.
33
+ # Corresponds to the JSON property `ampUrls`
34
+ # @return [Array<Google::Apis::AcceleratedmobilepageurlV1::AmpUrl>]
35
+ attr_accessor :amp_urls
36
+
37
+ # The errors for requested URLs that have no AMP URL.
38
+ # Corresponds to the JSON property `urlErrors`
39
+ # @return [Array<Google::Apis::AcceleratedmobilepageurlV1::AmpUrlError>]
40
+ attr_accessor :url_errors
41
+
42
+ def initialize(**args)
43
+ update!(**args)
44
+ end
45
+
46
+ # Update properties of this object
47
+ def update!(**args)
48
+ @amp_urls = args[:amp_urls] if args.key?(:amp_urls)
49
+ @url_errors = args[:url_errors] if args.key?(:url_errors)
50
+ end
51
+ end
52
+
53
+ # AMP URL response for a requested URL.
54
+ class AmpUrl
55
+ include Google::Apis::Core::Hashable
56
+
57
+ # The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to
58
+ # the cached document in the Google AMP Cache.
59
+ # Corresponds to the JSON property `cdnAmpUrl`
60
+ # @return [String]
61
+ attr_accessor :cdn_amp_url
62
+
63
+ # The original non-AMP URL.
64
+ # Corresponds to the JSON property `originalUrl`
65
+ # @return [String]
66
+ attr_accessor :original_url
67
+
68
+ # The AMP URL pointing to the publisher's web server.
69
+ # Corresponds to the JSON property `ampUrl`
70
+ # @return [String]
71
+ attr_accessor :amp_url
72
+
73
+ def initialize(**args)
74
+ update!(**args)
75
+ end
76
+
77
+ # Update properties of this object
78
+ def update!(**args)
79
+ @cdn_amp_url = args[:cdn_amp_url] if args.key?(:cdn_amp_url)
80
+ @original_url = args[:original_url] if args.key?(:original_url)
81
+ @amp_url = args[:amp_url] if args.key?(:amp_url)
82
+ end
83
+ end
84
+
85
+ # AMP URL Error resource for a requested URL that couldn't be found.
86
+ class AmpUrlError
87
+ include Google::Apis::Core::Hashable
88
+
89
+ # An optional descriptive error message.
90
+ # Corresponds to the JSON property `errorMessage`
91
+ # @return [String]
92
+ attr_accessor :error_message
93
+
94
+ # The error code of an API call.
95
+ # Corresponds to the JSON property `errorCode`
96
+ # @return [String]
97
+ attr_accessor :error_code
98
+
99
+ # The original non-AMP URL.
100
+ # Corresponds to the JSON property `originalUrl`
101
+ # @return [String]
102
+ attr_accessor :original_url
103
+
104
+ def initialize(**args)
105
+ update!(**args)
106
+ end
107
+
108
+ # Update properties of this object
109
+ def update!(**args)
110
+ @error_message = args[:error_message] if args.key?(:error_message)
111
+ @error_code = args[:error_code] if args.key?(:error_code)
112
+ @original_url = args[:original_url] if args.key?(:original_url)
113
+ end
114
+ end
115
+
116
+ # AMP URL request for a batch of URLs.
117
+ class BatchGetAmpUrlsRequest
118
+ include Google::Apis::Core::Hashable
119
+
120
+ # List of URLs to look up for the paired AMP URLs.
121
+ # The URLs are case-sensitive. Up to 50 URLs per lookup
122
+ # (see [Usage Limits](/amp/cache/reference/limits)).
123
+ # Corresponds to the JSON property `urls`
124
+ # @return [Array<String>]
125
+ attr_accessor :urls
126
+
127
+ # The lookup_strategy being requested.
128
+ # Corresponds to the JSON property `lookupStrategy`
129
+ # @return [String]
130
+ attr_accessor :lookup_strategy
131
+
132
+ def initialize(**args)
133
+ update!(**args)
134
+ end
135
+
136
+ # Update properties of this object
137
+ def update!(**args)
138
+ @urls = args[:urls] if args.key?(:urls)
139
+ @lookup_strategy = args[:lookup_strategy] if args.key?(:lookup_strategy)
140
+ end
141
+ end
142
+ end
143
+ end
144
+ end
@@ -0,0 +1,86 @@
1
+ # Copyright 2015 Google Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module AcceleratedmobilepageurlV1
24
+
25
+ class BatchGetAmpUrlsResponse
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class AmpUrl
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class AmpUrlError
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class BatchGetAmpUrlsRequest
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class BatchGetAmpUrlsResponse
50
+ # @private
51
+ class Representation < Google::Apis::Core::JsonRepresentation
52
+ collection :amp_urls, as: 'ampUrls', class: Google::Apis::AcceleratedmobilepageurlV1::AmpUrl, decorator: Google::Apis::AcceleratedmobilepageurlV1::AmpUrl::Representation
53
+
54
+ collection :url_errors, as: 'urlErrors', class: Google::Apis::AcceleratedmobilepageurlV1::AmpUrlError, decorator: Google::Apis::AcceleratedmobilepageurlV1::AmpUrlError::Representation
55
+
56
+ end
57
+ end
58
+
59
+ class AmpUrl
60
+ # @private
61
+ class Representation < Google::Apis::Core::JsonRepresentation
62
+ property :cdn_amp_url, as: 'cdnAmpUrl'
63
+ property :original_url, as: 'originalUrl'
64
+ property :amp_url, as: 'ampUrl'
65
+ end
66
+ end
67
+
68
+ class AmpUrlError
69
+ # @private
70
+ class Representation < Google::Apis::Core::JsonRepresentation
71
+ property :error_message, as: 'errorMessage'
72
+ property :error_code, as: 'errorCode'
73
+ property :original_url, as: 'originalUrl'
74
+ end
75
+ end
76
+
77
+ class BatchGetAmpUrlsRequest
78
+ # @private
79
+ class Representation < Google::Apis::Core::JsonRepresentation
80
+ collection :urls, as: 'urls'
81
+ property :lookup_strategy, as: 'lookupStrategy'
82
+ end
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,90 @@
1
+ # Copyright 2015 Google Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module AcceleratedmobilepageurlV1
23
+ # Accelerated Mobile Pages (AMP) URL API
24
+ #
25
+ # This API contains a single method, batchGet. Call this method to retrieve the
26
+ # AMP URL (and equivalent AMP Cache URL) for given public URL(s).
27
+ #
28
+ # @example
29
+ # require 'google/apis/acceleratedmobilepageurl_v1'
30
+ #
31
+ # Acceleratedmobilepageurl = Google::Apis::AcceleratedmobilepageurlV1 # Alias the module
32
+ # service = Acceleratedmobilepageurl::AcceleratedmobilepageurlService.new
33
+ #
34
+ # @see https://developers.google.com/amp/cache/
35
+ class AcceleratedmobilepageurlService < Google::Apis::Core::BaseService
36
+ # @return [String]
37
+ # API key. Your API key identifies your project and provides you with API access,
38
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
39
+ attr_accessor :key
40
+
41
+ # @return [String]
42
+ # Available to use for quota purposes for server-side applications. Can be any
43
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
44
+ attr_accessor :quota_user
45
+
46
+ def initialize
47
+ super('https://acceleratedmobilepageurl.googleapis.com/', '')
48
+ end
49
+
50
+ # Returns AMP URL(s) and equivalent
51
+ # [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).
52
+ # @param [Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsRequest] batch_get_amp_urls_request_object
53
+ # @param [String] fields
54
+ # Selector specifying which fields to include in a partial response.
55
+ # @param [String] quota_user
56
+ # Available to use for quota purposes for server-side applications. Can be any
57
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
58
+ # @param [Google::Apis::RequestOptions] options
59
+ # Request-specific options
60
+ #
61
+ # @yield [result, err] Result & error if block supplied
62
+ # @yieldparam result [Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsResponse] parsed result object
63
+ # @yieldparam err [StandardError] error object if request failed
64
+ #
65
+ # @return [Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsResponse]
66
+ #
67
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
68
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
69
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
70
+ def batch_get_amp_urls(batch_get_amp_urls_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
71
+ command = make_simple_command(:post, 'v1/ampUrls:batchGet', options)
72
+ command.request_representation = Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsRequest::Representation
73
+ command.request_object = batch_get_amp_urls_request_object
74
+ command.response_representation = Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsResponse::Representation
75
+ command.response_class = Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsResponse
76
+ command.query['fields'] = fields unless fields.nil?
77
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
78
+ execute_or_queue_command(command, &block)
79
+ end
80
+
81
+ protected
82
+
83
+ def apply_command_defaults(command)
84
+ command.query['key'] = key unless key.nil?
85
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
86
+ end
87
+ end
88
+ end
89
+ end
90
+ end
@@ -26,7 +26,7 @@ module Google
26
26
  # @see https://developers.google.com/ad-exchange/buyer-rest/guides/client-access/
27
27
  module Adexchangebuyer2V2beta1
28
28
  VERSION = 'V2beta1'
29
- REVISION = '20170324'
29
+ REVISION = '20170330'
30
30
 
31
31
  # Manage your Ad Exchange buyer account configuration
32
32
  AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer'
@@ -22,18 +22,24 @@ module Google
22
22
  module Apis
23
23
  module Adexchangebuyer2V2beta1
24
24
 
25
- # A request for watching changes to creative Status.
26
- class WatchCreativeRequest
25
+ # The association between a creative and a deal.
26
+ class CreativeDealAssociation
27
27
  include Google::Apis::Core::Hashable
28
28
 
29
- # The Pub/Sub topic to publish notifications to.
30
- # This topic must already exist and must give permission to
31
- # ad-exchange-buyside-reports@google.com to write to the topic.
32
- # This should be the full resource name in
33
- # "projects/`project_id`/topics/`topic_id`" format.
34
- # Corresponds to the JSON property `topic`
29
+ # The externalDealId for the deal associated with the creative.
30
+ # Corresponds to the JSON property `dealsId`
35
31
  # @return [String]
36
- attr_accessor :topic
32
+ attr_accessor :deals_id
33
+
34
+ # The account the creative belongs to.
35
+ # Corresponds to the JSON property `accountId`
36
+ # @return [String]
37
+ attr_accessor :account_id
38
+
39
+ # The ID of the creative associated with the deal.
40
+ # Corresponds to the JSON property `creativeId`
41
+ # @return [String]
42
+ attr_accessor :creative_id
37
43
 
38
44
  def initialize(**args)
39
45
  update!(**args)
@@ -41,130 +47,178 @@ module Google
41
47
 
42
48
  # Update properties of this object
43
49
  def update!(**args)
44
- @topic = args[:topic] if args.key?(:topic)
50
+ @deals_id = args[:deals_id] if args.key?(:deals_id)
51
+ @account_id = args[:account_id] if args.key?(:account_id)
52
+ @creative_id = args[:creative_id] if args.key?(:creative_id)
45
53
  end
46
54
  end
47
55
 
48
- # @OutputOnly The app type the restriction applies to for mobile device.
49
- class AppContext
56
+ # A creative and its classification data.
57
+ class Creative
50
58
  include Google::Apis::Core::Hashable
51
59
 
52
- # The app types this restriction applies to.
53
- # Corresponds to the JSON property `appTypes`
54
- # @return [Array<String>]
55
- attr_accessor :app_types
60
+ # The account that this creative belongs to.
61
+ # Can be used to filter the response of the
62
+ # creatives.list
63
+ # method.
64
+ # Corresponds to the JSON property `accountId`
65
+ # @return [String]
66
+ attr_accessor :account_id
56
67
 
57
- def initialize(**args)
58
- update!(**args)
59
- end
68
+ # Native content for a creative.
69
+ # Corresponds to the JSON property `native`
70
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::NativeContent]
71
+ attr_accessor :native
60
72
 
61
- # Update properties of this object
62
- def update!(**args)
63
- @app_types = args[:app_types] if args.key?(:app_types)
64
- end
65
- end
73
+ # @OutputOnly The granular status of this ad in specific contexts.
74
+ # A context here relates to where something ultimately serves (for example,
75
+ # a physical location, a platform, an HTTPS vs HTTP request, or the type
76
+ # of auction).
77
+ # Corresponds to the JSON property `servingRestrictions`
78
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ServingRestriction>]
79
+ attr_accessor :serving_restrictions
66
80
 
67
- #
68
- class ListClientsResponse
69
- include Google::Apis::Core::Hashable
81
+ # Video content for a creative.
82
+ # Corresponds to the JSON property `video`
83
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::VideoContent]
84
+ attr_accessor :video
70
85
 
71
- # The returned list of clients.
72
- # Corresponds to the JSON property `clients`
73
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Client>]
74
- attr_accessor :clients
86
+ # The agency ID for this creative.
87
+ # Corresponds to the JSON property `agencyId`
88
+ # @return [String]
89
+ attr_accessor :agency_id
75
90
 
76
- # A token to retrieve the next page of results.
77
- # Pass this value in the
78
- # ListClientsRequest.pageToken
79
- # field in the subsequent call to the
80
- # accounts.clients.list method
81
- # to retrieve the next page of results.
82
- # Corresponds to the JSON property `nextPageToken`
91
+ # The set of destination URLs for the creative.
92
+ # Corresponds to the JSON property `clickThroughUrls`
93
+ # @return [Array<String>]
94
+ attr_accessor :click_through_urls
95
+
96
+ # The link to AdChoices destination page.
97
+ # Corresponds to the JSON property `adChoicesDestinationUrl`
83
98
  # @return [String]
84
- attr_accessor :next_page_token
99
+ attr_accessor :ad_choices_destination_url
85
100
 
86
- def initialize(**args)
87
- update!(**args)
88
- end
101
+ # @OutputOnly Detected sensitive categories, if any.
102
+ # See the ad-sensitive-categories.txt file in the technical documentation for
103
+ # a list of IDs. You should use these IDs along with the
104
+ # excluded-sensitive-category field in the bid request to filter your bids.
105
+ # Corresponds to the JSON property `detectedSensitiveCategories`
106
+ # @return [Array<Fixnum>]
107
+ attr_accessor :detected_sensitive_categories
89
108
 
90
- # Update properties of this object
91
- def update!(**args)
92
- @clients = args[:clients] if args.key?(:clients)
93
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
94
- end
95
- end
109
+ # All restricted categories for the ads that may be shown from this creative.
110
+ # Corresponds to the JSON property `restrictedCategories`
111
+ # @return [Array<String>]
112
+ attr_accessor :restricted_categories
96
113
 
97
- # Native content for a creative.
98
- class NativeContent
99
- include Google::Apis::Core::Hashable
114
+ # @OutputOnly Shows any corrections that were applied to this creative.
115
+ # Corresponds to the JSON property `corrections`
116
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Correction>]
117
+ attr_accessor :corrections
100
118
 
101
- # The URL to fetch a native video ad.
102
- # Corresponds to the JSON property `videoUrl`
103
- # @return [String]
104
- attr_accessor :video_url
119
+ # @OutputOnly The version of this creative.
120
+ # Corresponds to the JSON property `version`
121
+ # @return [Fixnum]
122
+ attr_accessor :version
105
123
 
106
- # An image resource. You may provide a larger image than was requested,
107
- # so long as the aspect ratio is preserved.
108
- # Corresponds to the JSON property `logo`
109
- # @return [Google::Apis::Adexchangebuyer2V2beta1::Image]
110
- attr_accessor :logo
124
+ # All vendor IDs for the ads that may be shown from this creative.
125
+ # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
126
+ # for possible values.
127
+ # Corresponds to the JSON property `vendorIds`
128
+ # @return [Array<Fixnum>]
129
+ attr_accessor :vendor_ids
111
130
 
112
- # The URL that the browser/SDK will load when the user clicks the ad.
113
- # Corresponds to the JSON property `clickLinkUrl`
114
- # @return [String]
115
- attr_accessor :click_link_url
131
+ # The set of URLs to be called to record an impression.
132
+ # Corresponds to the JSON property `impressionTrackingUrls`
133
+ # @return [Array<String>]
134
+ attr_accessor :impression_tracking_urls
116
135
 
117
- # The price of the promoted app including currency info.
118
- # Corresponds to the JSON property `priceDisplayText`
119
- # @return [String]
120
- attr_accessor :price_display_text
136
+ # HTML content for a creative.
137
+ # Corresponds to the JSON property `html`
138
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::HtmlContent]
139
+ attr_accessor :html
121
140
 
122
- # The URL to use for click tracking.
123
- # Corresponds to the JSON property `clickTrackingUrl`
141
+ # @OutputOnly Detected product categories, if any.
142
+ # See the ad-product-categories.txt file in the technical documentation
143
+ # for a list of IDs.
144
+ # Corresponds to the JSON property `detectedProductCategories`
145
+ # @return [Array<Fixnum>]
146
+ attr_accessor :detected_product_categories
147
+
148
+ # @OutputOnly The top-level deals status of this creative.
149
+ # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
150
+ # serving_restrictions will also exist. Note
151
+ # that this may be nuanced with other contextual restrictions, in which case,
152
+ # it may be preferable to read from serving_restrictions directly.
153
+ # Can be used to filter the response of the
154
+ # creatives.list
155
+ # method.
156
+ # Corresponds to the JSON property `dealsStatus`
124
157
  # @return [String]
125
- attr_accessor :click_tracking_url
158
+ attr_accessor :deals_status
126
159
 
127
- # An image resource. You may provide a larger image than was requested,
128
- # so long as the aspect ratio is preserved.
129
- # Corresponds to the JSON property `image`
130
- # @return [Google::Apis::Adexchangebuyer2V2beta1::Image]
131
- attr_accessor :image
160
+ # @OutputOnly The top-level open auction status of this creative.
161
+ # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
162
+ # serving_restrictions will also exist. Note
163
+ # that this may be nuanced with other contextual restrictions, in which case,
164
+ # it may be preferable to read from serving_restrictions directly.
165
+ # Can be used to filter the response of the
166
+ # creatives.list
167
+ # method.
168
+ # Corresponds to the JSON property `openAuctionStatus`
169
+ # @return [String]
170
+ attr_accessor :open_auction_status
132
171
 
133
- # The name of the advertiser or sponsor, to be displayed in the ad creative.
172
+ # The name of the company being advertised in the creative.
134
173
  # Corresponds to the JSON property `advertiserName`
135
174
  # @return [String]
136
175
  attr_accessor :advertiser_name
137
176
 
138
- # The URL to the app store to purchase/download the promoted app.
139
- # Corresponds to the JSON property `storeUrl`
140
- # @return [String]
141
- attr_accessor :store_url
177
+ # @OutputOnly Detected advertiser IDs, if any.
178
+ # Corresponds to the JSON property `detectedAdvertiserIds`
179
+ # @return [Array<String>]
180
+ attr_accessor :detected_advertiser_ids
142
181
 
143
- # A short title for the ad.
144
- # Corresponds to the JSON property `headline`
145
- # @return [String]
146
- attr_accessor :headline
182
+ # @OutputOnly
183
+ # The detected domains for this creative.
184
+ # Corresponds to the JSON property `detectedDomains`
185
+ # @return [Array<String>]
186
+ attr_accessor :detected_domains
147
187
 
148
- # An image resource. You may provide a larger image than was requested,
149
- # so long as the aspect ratio is preserved.
150
- # Corresponds to the JSON property `appIcon`
151
- # @return [Google::Apis::Adexchangebuyer2V2beta1::Image]
152
- attr_accessor :app_icon
188
+ # @OutputOnly Filtering reasons for this creative during a period of a single
189
+ # day (from midnight to midnight Pacific).
190
+ # Corresponds to the JSON property `filteringStats`
191
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::FilteringStats]
192
+ attr_accessor :filtering_stats
153
193
 
154
- # A label for the button that the user is supposed to click.
155
- # Corresponds to the JSON property `callToAction`
156
- # @return [String]
157
- attr_accessor :call_to_action
194
+ # All attributes for the ads that may be shown from this creative.
195
+ # Can be used to filter the response of the
196
+ # creatives.list
197
+ # method.
198
+ # Corresponds to the JSON property `attributes`
199
+ # @return [Array<String>]
200
+ attr_accessor :attributes
158
201
 
159
- # A long description of the ad.
160
- # Corresponds to the JSON property `body`
202
+ # @OutputOnly The last update timestamp of the creative via API.
203
+ # Corresponds to the JSON property `apiUpdateTime`
161
204
  # @return [String]
162
- attr_accessor :body
205
+ attr_accessor :api_update_time
163
206
 
164
- # The app rating in the app store. Must be in the range [0-5].
165
- # Corresponds to the JSON property `starRating`
166
- # @return [Float]
167
- attr_accessor :star_rating
207
+ # @OutputOnly
208
+ # The detected languages for this creative. The order is arbitrary. The codes
209
+ # are 2 or 5 characters and are documented at
210
+ # https://developers.google.com/adwords/api/docs/appendix/languagecodes.
211
+ # Corresponds to the JSON property `detectedLanguages`
212
+ # @return [Array<String>]
213
+ attr_accessor :detected_languages
214
+
215
+ # The buyer-defined creative ID of this creative.
216
+ # Can be used to filter the response of the
217
+ # creatives.list
218
+ # method.
219
+ # Corresponds to the JSON property `creativeId`
220
+ # @return [String]
221
+ attr_accessor :creative_id
168
222
 
169
223
  def initialize(**args)
170
224
  update!(**args)
@@ -172,30 +226,54 @@ module Google
172
226
 
173
227
  # Update properties of this object
174
228
  def update!(**args)
175
- @video_url = args[:video_url] if args.key?(:video_url)
176
- @logo = args[:logo] if args.key?(:logo)
177
- @click_link_url = args[:click_link_url] if args.key?(:click_link_url)
178
- @price_display_text = args[:price_display_text] if args.key?(:price_display_text)
179
- @click_tracking_url = args[:click_tracking_url] if args.key?(:click_tracking_url)
180
- @image = args[:image] if args.key?(:image)
229
+ @account_id = args[:account_id] if args.key?(:account_id)
230
+ @native = args[:native] if args.key?(:native)
231
+ @serving_restrictions = args[:serving_restrictions] if args.key?(:serving_restrictions)
232
+ @video = args[:video] if args.key?(:video)
233
+ @agency_id = args[:agency_id] if args.key?(:agency_id)
234
+ @click_through_urls = args[:click_through_urls] if args.key?(:click_through_urls)
235
+ @ad_choices_destination_url = args[:ad_choices_destination_url] if args.key?(:ad_choices_destination_url)
236
+ @detected_sensitive_categories = args[:detected_sensitive_categories] if args.key?(:detected_sensitive_categories)
237
+ @restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories)
238
+ @corrections = args[:corrections] if args.key?(:corrections)
239
+ @version = args[:version] if args.key?(:version)
240
+ @vendor_ids = args[:vendor_ids] if args.key?(:vendor_ids)
241
+ @impression_tracking_urls = args[:impression_tracking_urls] if args.key?(:impression_tracking_urls)
242
+ @html = args[:html] if args.key?(:html)
243
+ @detected_product_categories = args[:detected_product_categories] if args.key?(:detected_product_categories)
244
+ @deals_status = args[:deals_status] if args.key?(:deals_status)
245
+ @open_auction_status = args[:open_auction_status] if args.key?(:open_auction_status)
181
246
  @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name)
182
- @store_url = args[:store_url] if args.key?(:store_url)
183
- @headline = args[:headline] if args.key?(:headline)
184
- @app_icon = args[:app_icon] if args.key?(:app_icon)
185
- @call_to_action = args[:call_to_action] if args.key?(:call_to_action)
186
- @body = args[:body] if args.key?(:body)
187
- @star_rating = args[:star_rating] if args.key?(:star_rating)
247
+ @detected_advertiser_ids = args[:detected_advertiser_ids] if args.key?(:detected_advertiser_ids)
248
+ @detected_domains = args[:detected_domains] if args.key?(:detected_domains)
249
+ @filtering_stats = args[:filtering_stats] if args.key?(:filtering_stats)
250
+ @attributes = args[:attributes] if args.key?(:attributes)
251
+ @api_update_time = args[:api_update_time] if args.key?(:api_update_time)
252
+ @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
253
+ @creative_id = args[:creative_id] if args.key?(:creative_id)
188
254
  end
189
255
  end
190
256
 
191
- # @OutputOnly A security context.
192
- class SecurityContext
257
+ # @OutputOnly Filtering reasons for this creative during a period of a single
258
+ # day (from midnight to midnight Pacific).
259
+ class FilteringStats
193
260
  include Google::Apis::Core::Hashable
194
261
 
195
- # The security types in this context.
196
- # Corresponds to the JSON property `securities`
197
- # @return [Array<String>]
198
- attr_accessor :securities
262
+ # The set of filtering reasons for this date.
263
+ # Corresponds to the JSON property `reasons`
264
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Reason>]
265
+ attr_accessor :reasons
266
+
267
+ # Represents a whole calendar date, e.g. date of birth. The time of day and
268
+ # time zone are either specified elsewhere or are not significant. The date
269
+ # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
270
+ # represent a year and month where the day is not significant, e.g. credit card
271
+ # expiration date. The year may be 0 to represent a month and day independent
272
+ # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
273
+ # and `google.protobuf.Timestamp`.
274
+ # Corresponds to the JSON property `date`
275
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::Date]
276
+ attr_accessor :date
199
277
 
200
278
  def initialize(**args)
201
279
  update!(**args)
@@ -203,28 +281,19 @@ module Google
203
281
 
204
282
  # Update properties of this object
205
283
  def update!(**args)
206
- @securities = args[:securities] if args.key?(:securities)
284
+ @reasons = args[:reasons] if args.key?(:reasons)
285
+ @date = args[:date] if args.key?(:date)
207
286
  end
208
287
  end
209
288
 
210
- # HTML content for a creative.
211
- class HtmlContent
289
+ # A request for removing the association between a deal and a creative.
290
+ class RemoveDealAssociationRequest
212
291
  include Google::Apis::Core::Hashable
213
292
 
214
- # The width of the HTML snippet in pixels.
215
- # Corresponds to the JSON property `width`
216
- # @return [Fixnum]
217
- attr_accessor :width
218
-
219
- # The HTML snippet that displays the ad when inserted in the web page.
220
- # Corresponds to the JSON property `snippet`
221
- # @return [String]
222
- attr_accessor :snippet
223
-
224
- # The height of the HTML snippet in pixels.
225
- # Corresponds to the JSON property `height`
226
- # @return [Fixnum]
227
- attr_accessor :height
293
+ # The association between a creative and a deal.
294
+ # Corresponds to the JSON property `association`
295
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation]
296
+ attr_accessor :association
228
297
 
229
298
  def initialize(**args)
230
299
  update!(**args)
@@ -232,74 +301,82 @@ module Google
232
301
 
233
302
  # Update properties of this object
234
303
  def update!(**args)
235
- @width = args[:width] if args.key?(:width)
236
- @snippet = args[:snippet] if args.key?(:snippet)
237
- @height = args[:height] if args.key?(:height)
304
+ @association = args[:association] if args.key?(:association)
238
305
  end
239
306
  end
240
307
 
241
- # A response for listing creatives.
242
- class ListCreativesResponse
308
+ # A client resource represents a client buyer&mdash;an agency,
309
+ # a brand, or an advertiser customer of the sponsor buyer.
310
+ # Users associated with the client buyer have restricted access to
311
+ # the Ad Exchange Marketplace and certain other sections
312
+ # of the Ad Exchange Buyer UI based on the role
313
+ # granted to the client buyer.
314
+ # All fields are required unless otherwise specified.
315
+ class Client
243
316
  include Google::Apis::Core::Hashable
244
317
 
245
- # The list of creatives.
246
- # Corresponds to the JSON property `creatives`
247
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Creative>]
248
- attr_accessor :creatives
318
+ # Whether the client buyer will be visible to sellers.
319
+ # Corresponds to the JSON property `visibleToSeller`
320
+ # @return [Boolean]
321
+ attr_accessor :visible_to_seller
322
+ alias_method :visible_to_seller?, :visible_to_seller
249
323
 
250
- # A token to retrieve the next page of results.
251
- # Pass this value in the
252
- # ListCreativesRequest.page_token
253
- # field in the subsequent call to `ListCreatives` method to retrieve the next
254
- # page of results.
255
- # Corresponds to the JSON property `nextPageToken`
324
+ # Numerical identifier of the client entity.
325
+ # The entity can be an advertiser, a brand, or an agency.
326
+ # This identifier is unique among all the entities with the same type.
327
+ # A list of all known advertisers with their identifiers is available in the
328
+ # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/
329
+ # advertisers.txt)
330
+ # file.
331
+ # A list of all known brands with their identifiers is available in the
332
+ # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
333
+ # file.
334
+ # A list of all known agencies with their identifiers is available in the
335
+ # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.
336
+ # txt)
337
+ # file.
338
+ # Corresponds to the JSON property `entityId`
256
339
  # @return [String]
257
- attr_accessor :next_page_token
258
-
259
- def initialize(**args)
260
- update!(**args)
261
- end
262
-
263
- # Update properties of this object
264
- def update!(**args)
265
- @creatives = args[:creatives] if args.key?(:creatives)
266
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
267
- end
268
- end
269
-
270
- # The serving context for this restriction.
271
- class ServingContext
272
- include Google::Apis::Core::Hashable
340
+ attr_accessor :entity_id
273
341
 
274
- # @OutputOnly The app type the restriction applies to for mobile device.
275
- # Corresponds to the JSON property `appType`
276
- # @return [Google::Apis::Adexchangebuyer2V2beta1::AppContext]
277
- attr_accessor :app_type
342
+ # The globally-unique numerical ID of the client.
343
+ # The value of this field is ignored in create and update operations.
344
+ # Corresponds to the JSON property `clientAccountId`
345
+ # @return [String]
346
+ attr_accessor :client_account_id
278
347
 
279
- # @OutputOnly A security context.
280
- # Corresponds to the JSON property `securityType`
281
- # @return [Google::Apis::Adexchangebuyer2V2beta1::SecurityContext]
282
- attr_accessor :security_type
348
+ # The name of the entity. This field is automatically fetched based on
349
+ # the type and ID.
350
+ # The value of this field is ignored in create and update operations.
351
+ # Corresponds to the JSON property `entityName`
352
+ # @return [String]
353
+ attr_accessor :entity_name
283
354
 
284
- # @OutputOnly The type of platform the restriction applies to.
285
- # Corresponds to the JSON property `platform`
286
- # @return [Google::Apis::Adexchangebuyer2V2beta1::PlatformContext]
287
- attr_accessor :platform
355
+ # The status of the client buyer.
356
+ # Corresponds to the JSON property `status`
357
+ # @return [String]
358
+ attr_accessor :status
288
359
 
289
- # @OutputOnly The Geo criteria the restriction applies to.
290
- # Corresponds to the JSON property `location`
291
- # @return [Google::Apis::Adexchangebuyer2V2beta1::LocationContext]
292
- attr_accessor :location
360
+ # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
361
+ # Corresponds to the JSON property `entityType`
362
+ # @return [String]
363
+ attr_accessor :entity_type
293
364
 
294
- # @OutputOnly The auction type the restriction applies to.
295
- # Corresponds to the JSON property `auctionType`
296
- # @return [Google::Apis::Adexchangebuyer2V2beta1::AuctionContext]
297
- attr_accessor :auction_type
365
+ # Name used to represent this client to publishers.
366
+ # You may have multiple clients that map to the same entity,
367
+ # but for each client the combination of `clientName` and entity
368
+ # must be unique.
369
+ # You can specify this field as empty.
370
+ # Corresponds to the JSON property `clientName`
371
+ # @return [String]
372
+ attr_accessor :client_name
298
373
 
299
- # Matches all contexts.
300
- # Corresponds to the JSON property `all`
374
+ # The role which is assigned to the client buyer. Each role implies a set of
375
+ # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
376
+ # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
377
+ # Corresponds to the JSON property `role`
301
378
  # @return [String]
302
- attr_accessor :all
379
+ attr_accessor :role
303
380
 
304
381
  def initialize(**args)
305
382
  update!(**args)
@@ -307,34 +384,35 @@ module Google
307
384
 
308
385
  # Update properties of this object
309
386
  def update!(**args)
310
- @app_type = args[:app_type] if args.key?(:app_type)
311
- @security_type = args[:security_type] if args.key?(:security_type)
312
- @platform = args[:platform] if args.key?(:platform)
313
- @location = args[:location] if args.key?(:location)
314
- @auction_type = args[:auction_type] if args.key?(:auction_type)
315
- @all = args[:all] if args.key?(:all)
387
+ @visible_to_seller = args[:visible_to_seller] if args.key?(:visible_to_seller)
388
+ @entity_id = args[:entity_id] if args.key?(:entity_id)
389
+ @client_account_id = args[:client_account_id] if args.key?(:client_account_id)
390
+ @entity_name = args[:entity_name] if args.key?(:entity_name)
391
+ @status = args[:status] if args.key?(:status)
392
+ @entity_type = args[:entity_type] if args.key?(:entity_type)
393
+ @client_name = args[:client_name] if args.key?(:client_name)
394
+ @role = args[:role] if args.key?(:role)
316
395
  end
317
396
  end
318
397
 
319
- # An image resource. You may provide a larger image than was requested,
320
- # so long as the aspect ratio is preserved.
321
- class Image
398
+ # @OutputOnly Shows any corrections that were applied to this creative.
399
+ class Correction
322
400
  include Google::Apis::Core::Hashable
323
401
 
324
- # Image width in pixels.
325
- # Corresponds to the JSON property `width`
326
- # @return [Fixnum]
327
- attr_accessor :width
402
+ # Additional details about what was corrected.
403
+ # Corresponds to the JSON property `details`
404
+ # @return [Array<String>]
405
+ attr_accessor :details
328
406
 
329
- # The URL of the image.
330
- # Corresponds to the JSON property `url`
407
+ # The type of correction that was applied to the creative.
408
+ # Corresponds to the JSON property `type`
331
409
  # @return [String]
332
- attr_accessor :url
410
+ attr_accessor :type
333
411
 
334
- # Image height in pixels.
335
- # Corresponds to the JSON property `height`
336
- # @return [Fixnum]
337
- attr_accessor :height
412
+ # The contexts for the correction.
413
+ # Corresponds to the JSON property `contexts`
414
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ServingContext>]
415
+ attr_accessor :contexts
338
416
 
339
417
  def initialize(**args)
340
418
  update!(**args)
@@ -342,29 +420,20 @@ module Google
342
420
 
343
421
  # Update properties of this object
344
422
  def update!(**args)
345
- @width = args[:width] if args.key?(:width)
346
- @url = args[:url] if args.key?(:url)
347
- @height = args[:height] if args.key?(:height)
423
+ @details = args[:details] if args.key?(:details)
424
+ @type = args[:type] if args.key?(:type)
425
+ @contexts = args[:contexts] if args.key?(:contexts)
348
426
  end
349
427
  end
350
428
 
351
- # A specific filtering status and how many times it occurred.
352
- class Reason
429
+ # A request for associating a deal and a creative.
430
+ class AddDealAssociationRequest
353
431
  include Google::Apis::Core::Hashable
354
432
 
355
- # The filtering status code. Please refer to the
356
- # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-
357
- # dictionaries/creative-status-codes.txt)
358
- # file for different statuses.
359
- # Corresponds to the JSON property `status`
360
- # @return [Fixnum]
361
- attr_accessor :status
362
-
363
- # The number of times the creative was filtered for the status. The
364
- # count is aggregated across all publishers on the exchange.
365
- # Corresponds to the JSON property `count`
366
- # @return [String]
367
- attr_accessor :count
433
+ # The association between a creative and a deal.
434
+ # Corresponds to the JSON property `association`
435
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation]
436
+ attr_accessor :association
368
437
 
369
438
  def initialize(**args)
370
439
  update!(**args)
@@ -372,19 +441,27 @@ module Google
372
441
 
373
442
  # Update properties of this object
374
443
  def update!(**args)
375
- @status = args[:status] if args.key?(:status)
376
- @count = args[:count] if args.key?(:count)
444
+ @association = args[:association] if args.key?(:association)
377
445
  end
378
446
  end
379
447
 
380
- # Video content for a creative.
381
- class VideoContent
448
+ # A response for listing creative and deal associations
449
+ class ListDealAssociationsResponse
382
450
  include Google::Apis::Core::Hashable
383
451
 
384
- # The URL to fetch a video ad.
385
- # Corresponds to the JSON property `videoUrl`
452
+ # A token to retrieve the next page of results.
453
+ # Pass this value in the
454
+ # ListDealAssociationsRequest.page_token
455
+ # field in the subsequent call to 'ListDealAssociation' method to retrieve
456
+ # the next page of results.
457
+ # Corresponds to the JSON property `nextPageToken`
386
458
  # @return [String]
387
- attr_accessor :video_url
459
+ attr_accessor :next_page_token
460
+
461
+ # The list of associations.
462
+ # Corresponds to the JSON property `associations`
463
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation>]
464
+ attr_accessor :associations
388
465
 
389
466
  def initialize(**args)
390
467
  update!(**args)
@@ -392,35 +469,24 @@ module Google
392
469
 
393
470
  # Update properties of this object
394
471
  def update!(**args)
395
- @video_url = args[:video_url] if args.key?(:video_url)
472
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
473
+ @associations = args[:associations] if args.key?(:associations)
396
474
  end
397
475
  end
398
476
 
399
- # An invitation for a new client user to get access to the Ad Exchange
400
- # Buyer UI.
401
- # All fields are required unless otherwise specified.
402
- class ClientUserInvitation
477
+ # @OutputOnly The reason and details for a disapproval.
478
+ class Disapproval
403
479
  include Google::Apis::Core::Hashable
404
480
 
405
- # The email address to which the invitation is sent. Email
406
- # addresses should be unique among all client users under each sponsor
407
- # buyer.
408
- # Corresponds to the JSON property `email`
409
- # @return [String]
410
- attr_accessor :email
411
-
412
- # Numerical account ID of the client buyer
413
- # that the invited user is associated with.
414
- # The value of this field is ignored in create operations.
415
- # Corresponds to the JSON property `clientAccountId`
416
- # @return [String]
417
- attr_accessor :client_account_id
481
+ # Additional details about the reason for disapproval.
482
+ # Corresponds to the JSON property `details`
483
+ # @return [Array<String>]
484
+ attr_accessor :details
418
485
 
419
- # The unique numerical ID of the invitation that is sent to the user.
420
- # The value of this field is ignored in create operations.
421
- # Corresponds to the JSON property `invitationId`
486
+ # The categorized reason for disapproval.
487
+ # Corresponds to the JSON property `reason`
422
488
  # @return [String]
423
- attr_accessor :invitation_id
489
+ attr_accessor :reason
424
490
 
425
491
  def initialize(**args)
426
492
  update!(**args)
@@ -428,50 +494,50 @@ module Google
428
494
 
429
495
  # Update properties of this object
430
496
  def update!(**args)
431
- @email = args[:email] if args.key?(:email)
432
- @client_account_id = args[:client_account_id] if args.key?(:client_account_id)
433
- @invitation_id = args[:invitation_id] if args.key?(:invitation_id)
497
+ @details = args[:details] if args.key?(:details)
498
+ @reason = args[:reason] if args.key?(:reason)
434
499
  end
435
500
  end
436
501
 
437
- # @OutputOnly The auction type the restriction applies to.
438
- class AuctionContext
502
+ # A request for stopping notifications for changes to creative Status.
503
+ class StopWatchingCreativeRequest
439
504
  include Google::Apis::Core::Hashable
440
505
 
441
- # The auction types this restriction applies to.
442
- # Corresponds to the JSON property `auctionTypes`
443
- # @return [Array<String>]
444
- attr_accessor :auction_types
445
-
446
506
  def initialize(**args)
447
507
  update!(**args)
448
508
  end
449
509
 
450
510
  # Update properties of this object
451
511
  def update!(**args)
452
- @auction_types = args[:auction_types] if args.key?(:auction_types)
453
512
  end
454
513
  end
455
514
 
456
- #
457
- class ListClientUserInvitationsResponse
515
+ # @OutputOnly A representation of the status of an ad in a
516
+ # specific context. A context here relates to where something ultimately serves
517
+ # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
518
+ # or the type of auction).
519
+ class ServingRestriction
458
520
  include Google::Apis::Core::Hashable
459
521
 
460
- # A token to retrieve the next page of results.
461
- # Pass this value in the
462
- # ListClientUserInvitationsRequest.pageToken
463
- # field in the subsequent call to the
464
- # clients.invitations.list
465
- # method to retrieve the next
466
- # page of results.
467
- # Corresponds to the JSON property `nextPageToken`
468
- # @return [String]
469
- attr_accessor :next_page_token
522
+ # Any disapprovals bound to this restriction.
523
+ # Only present if status=DISAPPROVED.
524
+ # Can be used to filter the response of the
525
+ # creatives.list
526
+ # method.
527
+ # Corresponds to the JSON property `disapprovalReasons`
528
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Disapproval>]
529
+ attr_accessor :disapproval_reasons
470
530
 
471
- # The returned list of client users.
472
- # Corresponds to the JSON property `invitations`
473
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation>]
474
- attr_accessor :invitations
531
+ # The contexts for the restriction.
532
+ # Corresponds to the JSON property `contexts`
533
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ServingContext>]
534
+ attr_accessor :contexts
535
+
536
+ # The status of the creative in this context (for example, it has been
537
+ # explicitly disapproved or is pending review).
538
+ # Corresponds to the JSON property `status`
539
+ # @return [String]
540
+ attr_accessor :status
475
541
 
476
542
  def initialize(**args)
477
543
  update!(**args)
@@ -479,30 +545,38 @@ module Google
479
545
 
480
546
  # Update properties of this object
481
547
  def update!(**args)
482
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
483
- @invitations = args[:invitations] if args.key?(:invitations)
548
+ @disapproval_reasons = args[:disapproval_reasons] if args.key?(:disapproval_reasons)
549
+ @contexts = args[:contexts] if args.key?(:contexts)
550
+ @status = args[:status] if args.key?(:status)
484
551
  end
485
552
  end
486
553
 
487
- #
488
- class ListClientUsersResponse
554
+ # Represents a whole calendar date, e.g. date of birth. The time of day and
555
+ # time zone are either specified elsewhere or are not significant. The date
556
+ # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
557
+ # represent a year and month where the day is not significant, e.g. credit card
558
+ # expiration date. The year may be 0 to represent a month and day independent
559
+ # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
560
+ # and `google.protobuf.Timestamp`.
561
+ class Date
489
562
  include Google::Apis::Core::Hashable
490
563
 
491
- # A token to retrieve the next page of results.
492
- # Pass this value in the
493
- # ListClientUsersRequest.pageToken
494
- # field in the subsequent call to the
495
- # clients.invitations.list
496
- # method to retrieve the next
497
- # page of results.
498
- # Corresponds to the JSON property `nextPageToken`
499
- # @return [String]
500
- attr_accessor :next_page_token
564
+ # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
565
+ # a year.
566
+ # Corresponds to the JSON property `year`
567
+ # @return [Fixnum]
568
+ attr_accessor :year
501
569
 
502
- # The returned list of client users.
503
- # Corresponds to the JSON property `users`
504
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ClientUser>]
505
- attr_accessor :users
570
+ # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
571
+ # if specifying a year/month where the day is not significant.
572
+ # Corresponds to the JSON property `day`
573
+ # @return [Fixnum]
574
+ attr_accessor :day
575
+
576
+ # Month of year. Must be from 1 to 12.
577
+ # Corresponds to the JSON property `month`
578
+ # @return [Fixnum]
579
+ attr_accessor :month
506
580
 
507
581
  def initialize(**args)
508
582
  update!(**args)
@@ -510,42 +584,43 @@ module Google
510
584
 
511
585
  # Update properties of this object
512
586
  def update!(**args)
513
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
514
- @users = args[:users] if args.key?(:users)
587
+ @year = args[:year] if args.key?(:year)
588
+ @day = args[:day] if args.key?(:day)
589
+ @month = args[:month] if args.key?(:month)
515
590
  end
516
591
  end
517
592
 
518
- # @OutputOnly The Geo criteria the restriction applies to.
519
- class LocationContext
593
+ # A generic empty message that you can re-use to avoid defining duplicated
594
+ # empty messages in your APIs. A typical example is to use it as the request
595
+ # or the response type of an API method. For instance:
596
+ # service Foo `
597
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
598
+ # `
599
+ # The JSON representation for `Empty` is empty JSON object ````.
600
+ class Empty
520
601
  include Google::Apis::Core::Hashable
521
602
 
522
- # IDs representing the geo location for this context.
523
- # Please refer to the
524
- # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.
525
- # csv)
526
- # file for different geo criteria IDs.
527
- # Corresponds to the JSON property `geoCriteriaIds`
528
- # @return [Array<Fixnum>]
529
- attr_accessor :geo_criteria_ids
530
-
531
603
  def initialize(**args)
532
604
  update!(**args)
533
605
  end
534
606
 
535
607
  # Update properties of this object
536
608
  def update!(**args)
537
- @geo_criteria_ids = args[:geo_criteria_ids] if args.key?(:geo_criteria_ids)
538
609
  end
539
610
  end
540
611
 
541
- # @OutputOnly The type of platform the restriction applies to.
542
- class PlatformContext
612
+ # A request for watching changes to creative Status.
613
+ class WatchCreativeRequest
543
614
  include Google::Apis::Core::Hashable
544
615
 
545
- # The platforms this restriction applies to.
546
- # Corresponds to the JSON property `platforms`
547
- # @return [Array<String>]
548
- attr_accessor :platforms
616
+ # The Pub/Sub topic to publish notifications to.
617
+ # This topic must already exist and must give permission to
618
+ # ad-exchange-buyside-reports@google.com to write to the topic.
619
+ # This should be the full resource name in
620
+ # "projects/`project_id`/topics/`topic_id`" format.
621
+ # Corresponds to the JSON property `topic`
622
+ # @return [String]
623
+ attr_accessor :topic
549
624
 
550
625
  def initialize(**args)
551
626
  update!(**args)
@@ -553,48 +628,18 @@ module Google
553
628
 
554
629
  # Update properties of this object
555
630
  def update!(**args)
556
- @platforms = args[:platforms] if args.key?(:platforms)
631
+ @topic = args[:topic] if args.key?(:topic)
557
632
  end
558
633
  end
559
634
 
560
- # A client user is created under a client buyer and has restricted access to
561
- # the Ad Exchange Marketplace and certain other sections
562
- # of the Ad Exchange Buyer UI based on the role
563
- # granted to the associated client buyer.
564
- # The only way a new client user can be created is via accepting an
565
- # email invitation
566
- # (see the
567
- # accounts.clients.invitations.create
568
- # method).
569
- # All fields are required unless otherwise specified.
570
- class ClientUser
635
+ # @OutputOnly The app type the restriction applies to for mobile device.
636
+ class AppContext
571
637
  include Google::Apis::Core::Hashable
572
638
 
573
- # The status of the client user.
574
- # Corresponds to the JSON property `status`
575
- # @return [String]
576
- attr_accessor :status
577
-
578
- # The unique numerical ID of the client user
579
- # that has accepted an invitation.
580
- # The value of this field is ignored in an update operation.
581
- # Corresponds to the JSON property `userId`
582
- # @return [String]
583
- attr_accessor :user_id
584
-
585
- # User's email address. The value of this field
586
- # is ignored in an update operation.
587
- # Corresponds to the JSON property `email`
588
- # @return [String]
589
- attr_accessor :email
590
-
591
- # Numerical account ID of the client buyer
592
- # with which the user is associated; the
593
- # buyer must be a client of the current sponsor buyer.
594
- # The value of this field is ignored in an update operation.
595
- # Corresponds to the JSON property `clientAccountId`
596
- # @return [String]
597
- attr_accessor :client_account_id
639
+ # The app types this restriction applies to.
640
+ # Corresponds to the JSON property `appTypes`
641
+ # @return [Array<String>]
642
+ attr_accessor :app_types
598
643
 
599
644
  def initialize(**args)
600
645
  update!(**args)
@@ -602,31 +647,28 @@ module Google
602
647
 
603
648
  # Update properties of this object
604
649
  def update!(**args)
605
- @status = args[:status] if args.key?(:status)
606
- @user_id = args[:user_id] if args.key?(:user_id)
607
- @email = args[:email] if args.key?(:email)
608
- @client_account_id = args[:client_account_id] if args.key?(:client_account_id)
650
+ @app_types = args[:app_types] if args.key?(:app_types)
609
651
  end
610
652
  end
611
653
 
612
- # The association between a creative and a deal.
613
- class CreativeDealAssociation
654
+ #
655
+ class ListClientsResponse
614
656
  include Google::Apis::Core::Hashable
615
657
 
616
- # The ID of the creative associated with the deal.
617
- # Corresponds to the JSON property `creativeId`
618
- # @return [String]
619
- attr_accessor :creative_id
620
-
621
- # The externalDealId for the deal associated with the creative.
622
- # Corresponds to the JSON property `dealsId`
658
+ # A token to retrieve the next page of results.
659
+ # Pass this value in the
660
+ # ListClientsRequest.pageToken
661
+ # field in the subsequent call to the
662
+ # accounts.clients.list method
663
+ # to retrieve the next page of results.
664
+ # Corresponds to the JSON property `nextPageToken`
623
665
  # @return [String]
624
- attr_accessor :deals_id
666
+ attr_accessor :next_page_token
625
667
 
626
- # The account the creative belongs to.
627
- # Corresponds to the JSON property `accountId`
628
- # @return [String]
629
- attr_accessor :account_id
668
+ # The returned list of clients.
669
+ # Corresponds to the JSON property `clients`
670
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Client>]
671
+ attr_accessor :clients
630
672
 
631
673
  def initialize(**args)
632
674
  update!(**args)
@@ -634,210 +676,217 @@ module Google
634
676
 
635
677
  # Update properties of this object
636
678
  def update!(**args)
637
- @creative_id = args[:creative_id] if args.key?(:creative_id)
638
- @deals_id = args[:deals_id] if args.key?(:deals_id)
639
- @account_id = args[:account_id] if args.key?(:account_id)
679
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
680
+ @clients = args[:clients] if args.key?(:clients)
640
681
  end
641
682
  end
642
683
 
643
- # @OutputOnly Filtering reasons for this creative during a period of a single
644
- # day (from midnight to midnight Pacific).
645
- class FilteringStats
684
+ # Native content for a creative.
685
+ class NativeContent
646
686
  include Google::Apis::Core::Hashable
647
687
 
648
- # Represents a whole calendar date, e.g. date of birth. The time of day and
649
- # time zone are either specified elsewhere or are not significant. The date
650
- # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
651
- # represent a year and month where the day is not significant, e.g. credit card
652
- # expiration date. The year may be 0 to represent a month and day independent
653
- # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
654
- # and `google.protobuf.Timestamp`.
655
- # Corresponds to the JSON property `date`
656
- # @return [Google::Apis::Adexchangebuyer2V2beta1::Date]
657
- attr_accessor :date
688
+ # A long description of the ad.
689
+ # Corresponds to the JSON property `body`
690
+ # @return [String]
691
+ attr_accessor :body
658
692
 
659
- # The set of filtering reasons for this date.
660
- # Corresponds to the JSON property `reasons`
661
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Reason>]
662
- attr_accessor :reasons
693
+ # The app rating in the app store. Must be in the range [0-5].
694
+ # Corresponds to the JSON property `starRating`
695
+ # @return [Float]
696
+ attr_accessor :star_rating
663
697
 
664
- def initialize(**args)
665
- update!(**args)
666
- end
698
+ # The URL to fetch a native video ad.
699
+ # Corresponds to the JSON property `videoUrl`
700
+ # @return [String]
701
+ attr_accessor :video_url
667
702
 
668
- # Update properties of this object
669
- def update!(**args)
670
- @date = args[:date] if args.key?(:date)
671
- @reasons = args[:reasons] if args.key?(:reasons)
672
- end
673
- end
703
+ # The URL that the browser/SDK will load when the user clicks the ad.
704
+ # Corresponds to the JSON property `clickLinkUrl`
705
+ # @return [String]
706
+ attr_accessor :click_link_url
674
707
 
675
- # A creative and its classification data.
676
- class Creative
677
- include Google::Apis::Core::Hashable
708
+ # An image resource. You may provide a larger image than was requested,
709
+ # so long as the aspect ratio is preserved.
710
+ # Corresponds to the JSON property `logo`
711
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::Image]
712
+ attr_accessor :logo
678
713
 
679
- # @OutputOnly The top-level open auction status of this creative.
680
- # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
681
- # serving_restrictions will also exist. Note
682
- # that this may be nuanced with other contextual restrictions, in which case,
683
- # it may be preferable to read from serving_restrictions directly.
684
- # Can be used to filter the response of the
685
- # creatives.list
686
- # method.
687
- # Corresponds to the JSON property `openAuctionStatus`
714
+ # The price of the promoted app including currency info.
715
+ # Corresponds to the JSON property `priceDisplayText`
688
716
  # @return [String]
689
- attr_accessor :open_auction_status
717
+ attr_accessor :price_display_text
690
718
 
691
- # The name of the company being advertised in the creative.
719
+ # The URL to use for click tracking.
720
+ # Corresponds to the JSON property `clickTrackingUrl`
721
+ # @return [String]
722
+ attr_accessor :click_tracking_url
723
+
724
+ # An image resource. You may provide a larger image than was requested,
725
+ # so long as the aspect ratio is preserved.
726
+ # Corresponds to the JSON property `image`
727
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::Image]
728
+ attr_accessor :image
729
+
730
+ # The name of the advertiser or sponsor, to be displayed in the ad creative.
692
731
  # Corresponds to the JSON property `advertiserName`
693
732
  # @return [String]
694
733
  attr_accessor :advertiser_name
695
734
 
696
- # @OutputOnly Detected advertiser IDs, if any.
697
- # Corresponds to the JSON property `detectedAdvertiserIds`
698
- # @return [Array<String>]
699
- attr_accessor :detected_advertiser_ids
700
-
701
- # @OutputOnly
702
- # The detected domains for this creative.
703
- # Corresponds to the JSON property `detectedDomains`
704
- # @return [Array<String>]
705
- attr_accessor :detected_domains
735
+ # The URL to the app store to purchase/download the promoted app.
736
+ # Corresponds to the JSON property `storeUrl`
737
+ # @return [String]
738
+ attr_accessor :store_url
706
739
 
707
- # @OutputOnly Filtering reasons for this creative during a period of a single
708
- # day (from midnight to midnight Pacific).
709
- # Corresponds to the JSON property `filteringStats`
710
- # @return [Google::Apis::Adexchangebuyer2V2beta1::FilteringStats]
711
- attr_accessor :filtering_stats
740
+ # A short title for the ad.
741
+ # Corresponds to the JSON property `headline`
742
+ # @return [String]
743
+ attr_accessor :headline
712
744
 
713
- # All attributes for the ads that may be shown from this creative.
714
- # Can be used to filter the response of the
715
- # creatives.list
716
- # method.
717
- # Corresponds to the JSON property `attributes`
718
- # @return [Array<String>]
719
- attr_accessor :attributes
745
+ # An image resource. You may provide a larger image than was requested,
746
+ # so long as the aspect ratio is preserved.
747
+ # Corresponds to the JSON property `appIcon`
748
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::Image]
749
+ attr_accessor :app_icon
720
750
 
721
- # @OutputOnly The last update timestamp of the creative via API.
722
- # Corresponds to the JSON property `apiUpdateTime`
751
+ # A label for the button that the user is supposed to click.
752
+ # Corresponds to the JSON property `callToAction`
723
753
  # @return [String]
724
- attr_accessor :api_update_time
754
+ attr_accessor :call_to_action
725
755
 
726
- # @OutputOnly
727
- # The detected languages for this creative. The order is arbitrary. The codes
728
- # are 2 or 5 characters and are documented at
729
- # https://developers.google.com/adwords/api/docs/appendix/languagecodes.
730
- # Corresponds to the JSON property `detectedLanguages`
756
+ def initialize(**args)
757
+ update!(**args)
758
+ end
759
+
760
+ # Update properties of this object
761
+ def update!(**args)
762
+ @body = args[:body] if args.key?(:body)
763
+ @star_rating = args[:star_rating] if args.key?(:star_rating)
764
+ @video_url = args[:video_url] if args.key?(:video_url)
765
+ @click_link_url = args[:click_link_url] if args.key?(:click_link_url)
766
+ @logo = args[:logo] if args.key?(:logo)
767
+ @price_display_text = args[:price_display_text] if args.key?(:price_display_text)
768
+ @click_tracking_url = args[:click_tracking_url] if args.key?(:click_tracking_url)
769
+ @image = args[:image] if args.key?(:image)
770
+ @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name)
771
+ @store_url = args[:store_url] if args.key?(:store_url)
772
+ @headline = args[:headline] if args.key?(:headline)
773
+ @app_icon = args[:app_icon] if args.key?(:app_icon)
774
+ @call_to_action = args[:call_to_action] if args.key?(:call_to_action)
775
+ end
776
+ end
777
+
778
+ # @OutputOnly A security context.
779
+ class SecurityContext
780
+ include Google::Apis::Core::Hashable
781
+
782
+ # The security types in this context.
783
+ # Corresponds to the JSON property `securities`
731
784
  # @return [Array<String>]
732
- attr_accessor :detected_languages
785
+ attr_accessor :securities
733
786
 
734
- # The buyer-defined creative ID of this creative.
735
- # Can be used to filter the response of the
736
- # creatives.list
737
- # method.
738
- # Corresponds to the JSON property `creativeId`
739
- # @return [String]
740
- attr_accessor :creative_id
787
+ def initialize(**args)
788
+ update!(**args)
789
+ end
741
790
 
742
- # The account that this creative belongs to.
743
- # Can be used to filter the response of the
744
- # creatives.list
745
- # method.
746
- # Corresponds to the JSON property `accountId`
791
+ # Update properties of this object
792
+ def update!(**args)
793
+ @securities = args[:securities] if args.key?(:securities)
794
+ end
795
+ end
796
+
797
+ # A response for listing creatives.
798
+ class ListCreativesResponse
799
+ include Google::Apis::Core::Hashable
800
+
801
+ # The list of creatives.
802
+ # Corresponds to the JSON property `creatives`
803
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Creative>]
804
+ attr_accessor :creatives
805
+
806
+ # A token to retrieve the next page of results.
807
+ # Pass this value in the
808
+ # ListCreativesRequest.page_token
809
+ # field in the subsequent call to `ListCreatives` method to retrieve the next
810
+ # page of results.
811
+ # Corresponds to the JSON property `nextPageToken`
747
812
  # @return [String]
748
- attr_accessor :account_id
813
+ attr_accessor :next_page_token
749
814
 
750
- # Native content for a creative.
751
- # Corresponds to the JSON property `native`
752
- # @return [Google::Apis::Adexchangebuyer2V2beta1::NativeContent]
753
- attr_accessor :native
815
+ def initialize(**args)
816
+ update!(**args)
817
+ end
754
818
 
755
- # @OutputOnly The granular status of this ad in specific contexts.
756
- # A context here relates to where something ultimately serves (for example,
757
- # a physical location, a platform, an HTTPS vs HTTP request, or the type
758
- # of auction).
759
- # Corresponds to the JSON property `servingRestrictions`
760
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ServingRestriction>]
761
- attr_accessor :serving_restrictions
819
+ # Update properties of this object
820
+ def update!(**args)
821
+ @creatives = args[:creatives] if args.key?(:creatives)
822
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
823
+ end
824
+ end
762
825
 
763
- # Video content for a creative.
764
- # Corresponds to the JSON property `video`
765
- # @return [Google::Apis::Adexchangebuyer2V2beta1::VideoContent]
766
- attr_accessor :video
826
+ # HTML content for a creative.
827
+ class HtmlContent
828
+ include Google::Apis::Core::Hashable
767
829
 
768
- # The agency ID for this creative.
769
- # Corresponds to the JSON property `agencyId`
770
- # @return [String]
771
- attr_accessor :agency_id
830
+ # The height of the HTML snippet in pixels.
831
+ # Corresponds to the JSON property `height`
832
+ # @return [Fixnum]
833
+ attr_accessor :height
772
834
 
773
- # The set of destination URLs for the creative.
774
- # Corresponds to the JSON property `clickThroughUrls`
775
- # @return [Array<String>]
776
- attr_accessor :click_through_urls
835
+ # The width of the HTML snippet in pixels.
836
+ # Corresponds to the JSON property `width`
837
+ # @return [Fixnum]
838
+ attr_accessor :width
777
839
 
778
- # The link to AdChoices destination page.
779
- # Corresponds to the JSON property `adChoicesDestinationUrl`
840
+ # The HTML snippet that displays the ad when inserted in the web page.
841
+ # Corresponds to the JSON property `snippet`
780
842
  # @return [String]
781
- attr_accessor :ad_choices_destination_url
843
+ attr_accessor :snippet
782
844
 
783
- # @OutputOnly Detected sensitive categories, if any.
784
- # See the ad-sensitive-categories.txt file in the technical documentation for
785
- # a list of IDs. You should use these IDs along with the
786
- # excluded-sensitive-category field in the bid request to filter your bids.
787
- # Corresponds to the JSON property `detectedSensitiveCategories`
788
- # @return [Array<Fixnum>]
789
- attr_accessor :detected_sensitive_categories
845
+ def initialize(**args)
846
+ update!(**args)
847
+ end
790
848
 
791
- # All restricted categories for the ads that may be shown from this creative.
792
- # Corresponds to the JSON property `restrictedCategories`
793
- # @return [Array<String>]
794
- attr_accessor :restricted_categories
849
+ # Update properties of this object
850
+ def update!(**args)
851
+ @height = args[:height] if args.key?(:height)
852
+ @width = args[:width] if args.key?(:width)
853
+ @snippet = args[:snippet] if args.key?(:snippet)
854
+ end
855
+ end
795
856
 
796
- # @OutputOnly Shows any corrections that were applied to this creative.
797
- # Corresponds to the JSON property `corrections`
798
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Correction>]
799
- attr_accessor :corrections
857
+ # The serving context for this restriction.
858
+ class ServingContext
859
+ include Google::Apis::Core::Hashable
800
860
 
801
- # @OutputOnly The version of this creative.
802
- # Corresponds to the JSON property `version`
803
- # @return [Fixnum]
804
- attr_accessor :version
861
+ # @OutputOnly The app type the restriction applies to for mobile device.
862
+ # Corresponds to the JSON property `appType`
863
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::AppContext]
864
+ attr_accessor :app_type
805
865
 
806
- # All vendor IDs for the ads that may be shown from this creative.
807
- # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
808
- # for possible values.
809
- # Corresponds to the JSON property `vendorIds`
810
- # @return [Array<Fixnum>]
811
- attr_accessor :vendor_ids
866
+ # @OutputOnly A security context.
867
+ # Corresponds to the JSON property `securityType`
868
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::SecurityContext]
869
+ attr_accessor :security_type
812
870
 
813
- # The set of URLs to be called to record an impression.
814
- # Corresponds to the JSON property `impressionTrackingUrls`
815
- # @return [Array<String>]
816
- attr_accessor :impression_tracking_urls
871
+ # @OutputOnly The type of platform the restriction applies to.
872
+ # Corresponds to the JSON property `platform`
873
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::PlatformContext]
874
+ attr_accessor :platform
817
875
 
818
- # HTML content for a creative.
819
- # Corresponds to the JSON property `html`
820
- # @return [Google::Apis::Adexchangebuyer2V2beta1::HtmlContent]
821
- attr_accessor :html
876
+ # @OutputOnly The Geo criteria the restriction applies to.
877
+ # Corresponds to the JSON property `location`
878
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::LocationContext]
879
+ attr_accessor :location
822
880
 
823
- # @OutputOnly The top-level deals status of this creative.
824
- # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
825
- # serving_restrictions will also exist. Note
826
- # that this may be nuanced with other contextual restrictions, in which case,
827
- # it may be preferable to read from serving_restrictions directly.
828
- # Can be used to filter the response of the
829
- # creatives.list
830
- # method.
831
- # Corresponds to the JSON property `dealsStatus`
832
- # @return [String]
833
- attr_accessor :deals_status
881
+ # @OutputOnly The auction type the restriction applies to.
882
+ # Corresponds to the JSON property `auctionType`
883
+ # @return [Google::Apis::Adexchangebuyer2V2beta1::AuctionContext]
884
+ attr_accessor :auction_type
834
885
 
835
- # @OutputOnly Detected product categories, if any.
836
- # See the ad-product-categories.txt file in the technical documentation
837
- # for a list of IDs.
838
- # Corresponds to the JSON property `detectedProductCategories`
839
- # @return [Array<Fixnum>]
840
- attr_accessor :detected_product_categories
886
+ # Matches all contexts.
887
+ # Corresponds to the JSON property `all`
888
+ # @return [String]
889
+ attr_accessor :all
841
890
 
842
891
  def initialize(**args)
843
892
  update!(**args)
@@ -845,42 +894,34 @@ module Google
845
894
 
846
895
  # Update properties of this object
847
896
  def update!(**args)
848
- @open_auction_status = args[:open_auction_status] if args.key?(:open_auction_status)
849
- @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name)
850
- @detected_advertiser_ids = args[:detected_advertiser_ids] if args.key?(:detected_advertiser_ids)
851
- @detected_domains = args[:detected_domains] if args.key?(:detected_domains)
852
- @filtering_stats = args[:filtering_stats] if args.key?(:filtering_stats)
853
- @attributes = args[:attributes] if args.key?(:attributes)
854
- @api_update_time = args[:api_update_time] if args.key?(:api_update_time)
855
- @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
856
- @creative_id = args[:creative_id] if args.key?(:creative_id)
857
- @account_id = args[:account_id] if args.key?(:account_id)
858
- @native = args[:native] if args.key?(:native)
859
- @serving_restrictions = args[:serving_restrictions] if args.key?(:serving_restrictions)
860
- @video = args[:video] if args.key?(:video)
861
- @agency_id = args[:agency_id] if args.key?(:agency_id)
862
- @click_through_urls = args[:click_through_urls] if args.key?(:click_through_urls)
863
- @ad_choices_destination_url = args[:ad_choices_destination_url] if args.key?(:ad_choices_destination_url)
864
- @detected_sensitive_categories = args[:detected_sensitive_categories] if args.key?(:detected_sensitive_categories)
865
- @restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories)
866
- @corrections = args[:corrections] if args.key?(:corrections)
867
- @version = args[:version] if args.key?(:version)
868
- @vendor_ids = args[:vendor_ids] if args.key?(:vendor_ids)
869
- @impression_tracking_urls = args[:impression_tracking_urls] if args.key?(:impression_tracking_urls)
870
- @html = args[:html] if args.key?(:html)
871
- @deals_status = args[:deals_status] if args.key?(:deals_status)
872
- @detected_product_categories = args[:detected_product_categories] if args.key?(:detected_product_categories)
897
+ @app_type = args[:app_type] if args.key?(:app_type)
898
+ @security_type = args[:security_type] if args.key?(:security_type)
899
+ @platform = args[:platform] if args.key?(:platform)
900
+ @location = args[:location] if args.key?(:location)
901
+ @auction_type = args[:auction_type] if args.key?(:auction_type)
902
+ @all = args[:all] if args.key?(:all)
873
903
  end
874
904
  end
875
905
 
876
- # A request for removing the association between a deal and a creative.
877
- class RemoveDealAssociationRequest
906
+ # An image resource. You may provide a larger image than was requested,
907
+ # so long as the aspect ratio is preserved.
908
+ class Image
878
909
  include Google::Apis::Core::Hashable
879
910
 
880
- # The association between a creative and a deal.
881
- # Corresponds to the JSON property `association`
882
- # @return [Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation]
883
- attr_accessor :association
911
+ # Image height in pixels.
912
+ # Corresponds to the JSON property `height`
913
+ # @return [Fixnum]
914
+ attr_accessor :height
915
+
916
+ # Image width in pixels.
917
+ # Corresponds to the JSON property `width`
918
+ # @return [Fixnum]
919
+ attr_accessor :width
920
+
921
+ # The URL of the image.
922
+ # Corresponds to the JSON property `url`
923
+ # @return [String]
924
+ attr_accessor :url
884
925
 
885
926
  def initialize(**args)
886
927
  update!(**args)
@@ -888,118 +929,106 @@ module Google
888
929
 
889
930
  # Update properties of this object
890
931
  def update!(**args)
891
- @association = args[:association] if args.key?(:association)
932
+ @height = args[:height] if args.key?(:height)
933
+ @width = args[:width] if args.key?(:width)
934
+ @url = args[:url] if args.key?(:url)
892
935
  end
893
936
  end
894
937
 
895
- # A client resource represents a client buyer&mdash;an agency,
896
- # a brand, or an advertiser customer of the sponsor buyer.
897
- # Users associated with the client buyer have restricted access to
898
- # the Ad Exchange Marketplace and certain other sections
899
- # of the Ad Exchange Buyer UI based on the role
900
- # granted to the client buyer.
901
- # All fields are required unless otherwise specified.
902
- class Client
938
+ # A specific filtering status and how many times it occurred.
939
+ class Reason
903
940
  include Google::Apis::Core::Hashable
904
941
 
905
- # The name of the entity. This field is automatically fetched based on
906
- # the type and ID.
907
- # The value of this field is ignored in create and update operations.
908
- # Corresponds to the JSON property `entityName`
909
- # @return [String]
910
- attr_accessor :entity_name
911
-
912
- # The status of the client buyer.
942
+ # The filtering status code. Please refer to the
943
+ # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-
944
+ # dictionaries/creative-status-codes.txt)
945
+ # file for different statuses.
913
946
  # Corresponds to the JSON property `status`
914
- # @return [String]
947
+ # @return [Fixnum]
915
948
  attr_accessor :status
916
949
 
917
- # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
918
- # Corresponds to the JSON property `entityType`
950
+ # The number of times the creative was filtered for the status. The
951
+ # count is aggregated across all publishers on the exchange.
952
+ # Corresponds to the JSON property `count`
919
953
  # @return [String]
920
- attr_accessor :entity_type
954
+ attr_accessor :count
921
955
 
922
- # Name used to represent this client to publishers.
923
- # You may have multiple clients that map to the same entity,
924
- # but for each client the combination of `clientName` and entity
925
- # must be unique.
926
- # You can specify this field as empty.
927
- # Corresponds to the JSON property `clientName`
928
- # @return [String]
929
- attr_accessor :client_name
956
+ def initialize(**args)
957
+ update!(**args)
958
+ end
930
959
 
931
- # The role which is assigned to the client buyer. Each role implies a set of
932
- # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
933
- # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
934
- # Corresponds to the JSON property `role`
935
- # @return [String]
936
- attr_accessor :role
960
+ # Update properties of this object
961
+ def update!(**args)
962
+ @status = args[:status] if args.key?(:status)
963
+ @count = args[:count] if args.key?(:count)
964
+ end
965
+ end
937
966
 
938
- # Whether the client buyer will be visible to sellers.
939
- # Corresponds to the JSON property `visibleToSeller`
940
- # @return [Boolean]
941
- attr_accessor :visible_to_seller
942
- alias_method :visible_to_seller?, :visible_to_seller
967
+ # Video content for a creative.
968
+ class VideoContent
969
+ include Google::Apis::Core::Hashable
943
970
 
944
- # Numerical identifier of the client entity.
945
- # The entity can be an advertiser, a brand, or an agency.
946
- # This identifier is unique among all the entities with the same type.
947
- # A list of all known advertisers with their identifiers is available in the
948
- # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/
949
- # advertisers.txt)
950
- # file.
951
- # A list of all known brands with their identifiers is available in the
952
- # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
953
- # file.
954
- # A list of all known agencies with their identifiers is available in the
955
- # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.
956
- # txt)
957
- # file.
958
- # Corresponds to the JSON property `entityId`
971
+ # The URL to fetch a video ad.
972
+ # Corresponds to the JSON property `videoUrl`
973
+ # @return [String]
974
+ attr_accessor :video_url
975
+
976
+ def initialize(**args)
977
+ update!(**args)
978
+ end
979
+
980
+ # Update properties of this object
981
+ def update!(**args)
982
+ @video_url = args[:video_url] if args.key?(:video_url)
983
+ end
984
+ end
985
+
986
+ # An invitation for a new client user to get access to the Ad Exchange
987
+ # Buyer UI.
988
+ # All fields are required unless otherwise specified.
989
+ class ClientUserInvitation
990
+ include Google::Apis::Core::Hashable
991
+
992
+ # The email address to which the invitation is sent. Email
993
+ # addresses should be unique among all client users under each sponsor
994
+ # buyer.
995
+ # Corresponds to the JSON property `email`
959
996
  # @return [String]
960
- attr_accessor :entity_id
997
+ attr_accessor :email
961
998
 
962
- # The globally-unique numerical ID of the client.
963
- # The value of this field is ignored in create and update operations.
999
+ # Numerical account ID of the client buyer
1000
+ # that the invited user is associated with.
1001
+ # The value of this field is ignored in create operations.
964
1002
  # Corresponds to the JSON property `clientAccountId`
965
1003
  # @return [String]
966
1004
  attr_accessor :client_account_id
967
1005
 
1006
+ # The unique numerical ID of the invitation that is sent to the user.
1007
+ # The value of this field is ignored in create operations.
1008
+ # Corresponds to the JSON property `invitationId`
1009
+ # @return [String]
1010
+ attr_accessor :invitation_id
1011
+
968
1012
  def initialize(**args)
969
1013
  update!(**args)
970
1014
  end
971
1015
 
972
1016
  # Update properties of this object
973
1017
  def update!(**args)
974
- @entity_name = args[:entity_name] if args.key?(:entity_name)
975
- @status = args[:status] if args.key?(:status)
976
- @entity_type = args[:entity_type] if args.key?(:entity_type)
977
- @client_name = args[:client_name] if args.key?(:client_name)
978
- @role = args[:role] if args.key?(:role)
979
- @visible_to_seller = args[:visible_to_seller] if args.key?(:visible_to_seller)
980
- @entity_id = args[:entity_id] if args.key?(:entity_id)
1018
+ @email = args[:email] if args.key?(:email)
981
1019
  @client_account_id = args[:client_account_id] if args.key?(:client_account_id)
1020
+ @invitation_id = args[:invitation_id] if args.key?(:invitation_id)
982
1021
  end
983
1022
  end
984
1023
 
985
- # @OutputOnly Shows any corrections that were applied to this creative.
986
- class Correction
1024
+ # @OutputOnly The auction type the restriction applies to.
1025
+ class AuctionContext
987
1026
  include Google::Apis::Core::Hashable
988
1027
 
989
- # Additional details about what was corrected.
990
- # Corresponds to the JSON property `details`
1028
+ # The auction types this restriction applies to.
1029
+ # Corresponds to the JSON property `auctionTypes`
991
1030
  # @return [Array<String>]
992
- attr_accessor :details
993
-
994
- # The type of correction that was applied to the creative.
995
- # Corresponds to the JSON property `type`
996
- # @return [String]
997
- attr_accessor :type
998
-
999
- # The contexts for the correction.
1000
- # Corresponds to the JSON property `contexts`
1001
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ServingContext>]
1002
- attr_accessor :contexts
1031
+ attr_accessor :auction_types
1003
1032
 
1004
1033
  def initialize(**args)
1005
1034
  update!(**args)
@@ -1007,29 +1036,29 @@ module Google
1007
1036
 
1008
1037
  # Update properties of this object
1009
1038
  def update!(**args)
1010
- @details = args[:details] if args.key?(:details)
1011
- @type = args[:type] if args.key?(:type)
1012
- @contexts = args[:contexts] if args.key?(:contexts)
1039
+ @auction_types = args[:auction_types] if args.key?(:auction_types)
1013
1040
  end
1014
1041
  end
1015
1042
 
1016
- # A response for listing creative and deal associations
1017
- class ListDealAssociationsResponse
1043
+ #
1044
+ class ListClientUserInvitationsResponse
1018
1045
  include Google::Apis::Core::Hashable
1019
1046
 
1020
1047
  # A token to retrieve the next page of results.
1021
1048
  # Pass this value in the
1022
- # ListDealAssociationsRequest.page_token
1023
- # field in the subsequent call to 'ListDealAssociation' method to retrieve
1024
- # the next page of results.
1049
+ # ListClientUserInvitationsRequest.pageToken
1050
+ # field in the subsequent call to the
1051
+ # clients.invitations.list
1052
+ # method to retrieve the next
1053
+ # page of results.
1025
1054
  # Corresponds to the JSON property `nextPageToken`
1026
1055
  # @return [String]
1027
1056
  attr_accessor :next_page_token
1028
1057
 
1029
- # The list of associations.
1030
- # Corresponds to the JSON property `associations`
1031
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation>]
1032
- attr_accessor :associations
1058
+ # The returned list of client users.
1059
+ # Corresponds to the JSON property `invitations`
1060
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation>]
1061
+ attr_accessor :invitations
1033
1062
 
1034
1063
  def initialize(**args)
1035
1064
  update!(**args)
@@ -1038,18 +1067,29 @@ module Google
1038
1067
  # Update properties of this object
1039
1068
  def update!(**args)
1040
1069
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1041
- @associations = args[:associations] if args.key?(:associations)
1070
+ @invitations = args[:invitations] if args.key?(:invitations)
1042
1071
  end
1043
1072
  end
1044
1073
 
1045
- # A request for associating a deal and a creative.
1046
- class AddDealAssociationRequest
1074
+ #
1075
+ class ListClientUsersResponse
1047
1076
  include Google::Apis::Core::Hashable
1048
1077
 
1049
- # The association between a creative and a deal.
1050
- # Corresponds to the JSON property `association`
1051
- # @return [Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation]
1052
- attr_accessor :association
1078
+ # A token to retrieve the next page of results.
1079
+ # Pass this value in the
1080
+ # ListClientUsersRequest.pageToken
1081
+ # field in the subsequent call to the
1082
+ # clients.invitations.list
1083
+ # method to retrieve the next
1084
+ # page of results.
1085
+ # Corresponds to the JSON property `nextPageToken`
1086
+ # @return [String]
1087
+ attr_accessor :next_page_token
1088
+
1089
+ # The returned list of client users.
1090
+ # Corresponds to the JSON property `users`
1091
+ # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ClientUser>]
1092
+ attr_accessor :users
1053
1093
 
1054
1094
  def initialize(**args)
1055
1095
  update!(**args)
@@ -1057,36 +1097,42 @@ module Google
1057
1097
 
1058
1098
  # Update properties of this object
1059
1099
  def update!(**args)
1060
- @association = args[:association] if args.key?(:association)
1100
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1101
+ @users = args[:users] if args.key?(:users)
1061
1102
  end
1062
1103
  end
1063
1104
 
1064
- # A request for stopping notifications for changes to creative Status.
1065
- class StopWatchingCreativeRequest
1105
+ # @OutputOnly The Geo criteria the restriction applies to.
1106
+ class LocationContext
1066
1107
  include Google::Apis::Core::Hashable
1067
1108
 
1109
+ # IDs representing the geo location for this context.
1110
+ # Please refer to the
1111
+ # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.
1112
+ # csv)
1113
+ # file for different geo criteria IDs.
1114
+ # Corresponds to the JSON property `geoCriteriaIds`
1115
+ # @return [Array<Fixnum>]
1116
+ attr_accessor :geo_criteria_ids
1117
+
1068
1118
  def initialize(**args)
1069
1119
  update!(**args)
1070
1120
  end
1071
1121
 
1072
1122
  # Update properties of this object
1073
1123
  def update!(**args)
1124
+ @geo_criteria_ids = args[:geo_criteria_ids] if args.key?(:geo_criteria_ids)
1074
1125
  end
1075
1126
  end
1076
1127
 
1077
- # @OutputOnly The reason and details for a disapproval.
1078
- class Disapproval
1128
+ # @OutputOnly The type of platform the restriction applies to.
1129
+ class PlatformContext
1079
1130
  include Google::Apis::Core::Hashable
1080
1131
 
1081
- # Additional details about the reason for disapproval.
1082
- # Corresponds to the JSON property `details`
1132
+ # The platforms this restriction applies to.
1133
+ # Corresponds to the JSON property `platforms`
1083
1134
  # @return [Array<String>]
1084
- attr_accessor :details
1085
-
1086
- # The categorized reason for disapproval.
1087
- # Corresponds to the JSON property `reason`
1088
- # @return [String]
1089
- attr_accessor :reason
1135
+ attr_accessor :platforms
1090
1136
 
1091
1137
  def initialize(**args)
1092
1138
  update!(**args)
@@ -1094,98 +1140,48 @@ module Google
1094
1140
 
1095
1141
  # Update properties of this object
1096
1142
  def update!(**args)
1097
- @details = args[:details] if args.key?(:details)
1098
- @reason = args[:reason] if args.key?(:reason)
1143
+ @platforms = args[:platforms] if args.key?(:platforms)
1099
1144
  end
1100
1145
  end
1101
1146
 
1102
- # @OutputOnly A representation of the status of an ad in a
1103
- # specific context. A context here relates to where something ultimately serves
1104
- # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
1105
- # or the type of auction).
1106
- class ServingRestriction
1147
+ # A client user is created under a client buyer and has restricted access to
1148
+ # the Ad Exchange Marketplace and certain other sections
1149
+ # of the Ad Exchange Buyer UI based on the role
1150
+ # granted to the associated client buyer.
1151
+ # The only way a new client user can be created is via accepting an
1152
+ # email invitation
1153
+ # (see the
1154
+ # accounts.clients.invitations.create
1155
+ # method).
1156
+ # All fields are required unless otherwise specified.
1157
+ class ClientUser
1107
1158
  include Google::Apis::Core::Hashable
1108
1159
 
1109
- # The contexts for the restriction.
1110
- # Corresponds to the JSON property `contexts`
1111
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ServingContext>]
1112
- attr_accessor :contexts
1160
+ # Numerical account ID of the client buyer
1161
+ # with which the user is associated; the
1162
+ # buyer must be a client of the current sponsor buyer.
1163
+ # The value of this field is ignored in an update operation.
1164
+ # Corresponds to the JSON property `clientAccountId`
1165
+ # @return [String]
1166
+ attr_accessor :client_account_id
1113
1167
 
1114
- # The status of the creative in this context (for example, it has been
1115
- # explicitly disapproved or is pending review).
1168
+ # The status of the client user.
1116
1169
  # Corresponds to the JSON property `status`
1117
1170
  # @return [String]
1118
1171
  attr_accessor :status
1119
1172
 
1120
- # Any disapprovals bound to this restriction.
1121
- # Only present if status=DISAPPROVED.
1122
- # Can be used to filter the response of the
1123
- # creatives.list
1124
- # method.
1125
- # Corresponds to the JSON property `disapprovalReasons`
1126
- # @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Disapproval>]
1127
- attr_accessor :disapproval_reasons
1128
-
1129
- def initialize(**args)
1130
- update!(**args)
1131
- end
1132
-
1133
- # Update properties of this object
1134
- def update!(**args)
1135
- @contexts = args[:contexts] if args.key?(:contexts)
1136
- @status = args[:status] if args.key?(:status)
1137
- @disapproval_reasons = args[:disapproval_reasons] if args.key?(:disapproval_reasons)
1138
- end
1139
- end
1140
-
1141
- # Represents a whole calendar date, e.g. date of birth. The time of day and
1142
- # time zone are either specified elsewhere or are not significant. The date
1143
- # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
1144
- # represent a year and month where the day is not significant, e.g. credit card
1145
- # expiration date. The year may be 0 to represent a month and day independent
1146
- # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
1147
- # and `google.protobuf.Timestamp`.
1148
- class Date
1149
- include Google::Apis::Core::Hashable
1150
-
1151
- # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1152
- # a year.
1153
- # Corresponds to the JSON property `year`
1154
- # @return [Fixnum]
1155
- attr_accessor :year
1156
-
1157
- # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1158
- # if specifying a year/month where the day is not significant.
1159
- # Corresponds to the JSON property `day`
1160
- # @return [Fixnum]
1161
- attr_accessor :day
1162
-
1163
- # Month of year. Must be from 1 to 12.
1164
- # Corresponds to the JSON property `month`
1165
- # @return [Fixnum]
1166
- attr_accessor :month
1167
-
1168
- def initialize(**args)
1169
- update!(**args)
1170
- end
1171
-
1172
- # Update properties of this object
1173
- def update!(**args)
1174
- @year = args[:year] if args.key?(:year)
1175
- @day = args[:day] if args.key?(:day)
1176
- @month = args[:month] if args.key?(:month)
1177
- end
1178
- end
1173
+ # The unique numerical ID of the client user
1174
+ # that has accepted an invitation.
1175
+ # The value of this field is ignored in an update operation.
1176
+ # Corresponds to the JSON property `userId`
1177
+ # @return [String]
1178
+ attr_accessor :user_id
1179
1179
 
1180
- # A generic empty message that you can re-use to avoid defining duplicated
1181
- # empty messages in your APIs. A typical example is to use it as the request
1182
- # or the response type of an API method. For instance:
1183
- # service Foo `
1184
- # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
1185
- # `
1186
- # The JSON representation for `Empty` is empty JSON object ````.
1187
- class Empty
1188
- include Google::Apis::Core::Hashable
1180
+ # User's email address. The value of this field
1181
+ # is ignored in an update operation.
1182
+ # Corresponds to the JSON property `email`
1183
+ # @return [String]
1184
+ attr_accessor :email
1189
1185
 
1190
1186
  def initialize(**args)
1191
1187
  update!(**args)
@@ -1193,6 +1189,10 @@ module Google
1193
1189
 
1194
1190
  # Update properties of this object
1195
1191
  def update!(**args)
1192
+ @client_account_id = args[:client_account_id] if args.key?(:client_account_id)
1193
+ @status = args[:status] if args.key?(:status)
1194
+ @user_id = args[:user_id] if args.key?(:user_id)
1195
+ @email = args[:email] if args.key?(:email)
1196
1196
  end
1197
1197
  end
1198
1198
  end