google-api-client 0.38.0 → 0.39.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (329) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +124 -0
  3. data/api_list_config.yaml +1 -2
  4. data/bin/generate-api +1 -1
  5. data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
  6. data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +22 -1
  7. data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +3 -0
  8. data/generated/google/apis/androidenterprise_v1.rb +1 -1
  9. data/generated/google/apis/androidenterprise_v1/classes.rb +2 -1
  10. data/generated/google/apis/androidpublisher_v1.rb +1 -4
  11. data/generated/google/apis/androidpublisher_v1/classes.rb +0 -41
  12. data/generated/google/apis/androidpublisher_v1/representations.rb +0 -16
  13. data/generated/google/apis/androidpublisher_v1/service.rb +1 -81
  14. data/generated/google/apis/androidpublisher_v1_1.rb +1 -1
  15. data/generated/google/apis/androidpublisher_v1_1/classes.rb +0 -41
  16. data/generated/google/apis/androidpublisher_v1_1/representations.rb +0 -16
  17. data/generated/google/apis/androidpublisher_v1_1/service.rb +0 -80
  18. data/generated/google/apis/androidpublisher_v2.rb +1 -1
  19. data/generated/google/apis/androidpublisher_v2/classes.rb +36 -1661
  20. data/generated/google/apis/androidpublisher_v2/representations.rb +0 -739
  21. data/generated/google/apis/androidpublisher_v2/service.rb +0 -2359
  22. data/generated/google/apis/androidpublisher_v3.rb +1 -1
  23. data/generated/google/apis/androidpublisher_v3/classes.rb +3 -2
  24. data/generated/google/apis/androidpublisher_v3/service.rb +4 -3
  25. data/generated/google/apis/apigee_v1.rb +40 -0
  26. data/generated/google/apis/apigee_v1/classes.rb +5205 -0
  27. data/generated/google/apis/apigee_v1/representations.rb +1944 -0
  28. data/generated/google/apis/apigee_v1/service.rb +6068 -0
  29. data/generated/google/apis/bigquery_v2.rb +1 -1
  30. data/generated/google/apis/bigquery_v2/classes.rb +51 -19
  31. data/generated/google/apis/bigquery_v2/representations.rb +21 -4
  32. data/generated/google/apis/bigqueryconnection_v1beta1.rb +1 -1
  33. data/generated/google/apis/bigqueryconnection_v1beta1/classes.rb +1 -2
  34. data/generated/google/apis/bigqueryconnection_v1beta1/service.rb +2 -2
  35. data/generated/google/apis/bigqueryreservation_v1.rb +1 -1
  36. data/generated/google/apis/bigqueryreservation_v1/classes.rb +12 -12
  37. data/generated/google/apis/bigqueryreservation_v1beta1.rb +1 -1
  38. data/generated/google/apis/bigqueryreservation_v1beta1/classes.rb +12 -12
  39. data/generated/google/apis/binaryauthorization_v1.rb +1 -1
  40. data/generated/google/apis/binaryauthorization_v1/classes.rb +23 -10
  41. data/generated/google/apis/binaryauthorization_v1/service.rb +10 -4
  42. data/generated/google/apis/binaryauthorization_v1beta1.rb +1 -1
  43. data/generated/google/apis/binaryauthorization_v1beta1/classes.rb +23 -10
  44. data/generated/google/apis/binaryauthorization_v1beta1/service.rb +10 -4
  45. data/generated/google/apis/calendar_v3.rb +1 -1
  46. data/generated/google/apis/calendar_v3/classes.rb +5 -5
  47. data/generated/google/apis/classroom_v1.rb +1 -1
  48. data/generated/google/apis/classroom_v1/classes.rb +14 -14
  49. data/generated/google/apis/classroom_v1/service.rb +11 -11
  50. data/generated/google/apis/cloudasset_v1p1beta1.rb +1 -1
  51. data/generated/google/apis/cloudasset_v1p1beta1/service.rb +2 -0
  52. data/generated/google/apis/{osconfig_v1beta.rb → cloudasset_v1p4beta1.rb} +8 -9
  53. data/generated/google/apis/cloudasset_v1p4beta1/classes.rb +924 -0
  54. data/generated/google/apis/cloudasset_v1p4beta1/representations.rb +377 -0
  55. data/generated/google/apis/cloudasset_v1p4beta1/service.rb +217 -0
  56. data/generated/google/apis/cloudbilling_v1.rb +1 -1
  57. data/generated/google/apis/cloudbilling_v1/classes.rb +24 -12
  58. data/generated/google/apis/cloudbilling_v1/service.rb +3 -0
  59. data/generated/google/apis/cloudbuild_v1.rb +1 -1
  60. data/generated/google/apis/cloudbuild_v1/classes.rb +2 -2
  61. data/generated/google/apis/clouddebugger_v2.rb +1 -1
  62. data/generated/google/apis/clouddebugger_v2/classes.rb +26 -0
  63. data/generated/google/apis/clouddebugger_v2/representations.rb +4 -0
  64. data/generated/google/apis/clouddebugger_v2/service.rb +9 -2
  65. data/generated/google/apis/cloudidentity_v1beta1.rb +1 -1
  66. data/generated/google/apis/cloudidentity_v1beta1/classes.rb +214 -66
  67. data/generated/google/apis/cloudidentity_v1beta1/representations.rb +64 -10
  68. data/generated/google/apis/cloudiot_v1.rb +1 -1
  69. data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
  70. data/generated/google/apis/cloudresourcemanager_v1/classes.rb +1 -2
  71. data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
  72. data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +1 -2
  73. data/generated/google/apis/cloudresourcemanager_v2.rb +1 -1
  74. data/generated/google/apis/cloudresourcemanager_v2/classes.rb +1 -2
  75. data/generated/google/apis/cloudresourcemanager_v2beta1.rb +1 -1
  76. data/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +1 -2
  77. data/generated/google/apis/cloudscheduler_v1.rb +1 -1
  78. data/generated/google/apis/cloudscheduler_v1/classes.rb +1 -1
  79. data/generated/google/apis/cloudscheduler_v1beta1.rb +1 -1
  80. data/generated/google/apis/cloudscheduler_v1beta1/classes.rb +1 -1
  81. data/generated/google/apis/cloudsearch_v1.rb +1 -1
  82. data/generated/google/apis/cloudsearch_v1/classes.rb +6 -4
  83. data/generated/google/apis/cloudsearch_v1/service.rb +3 -1
  84. data/generated/google/apis/cloudshell_v1.rb +1 -1
  85. data/generated/google/apis/cloudshell_v1alpha1.rb +1 -1
  86. data/generated/google/apis/cloudshell_v1alpha1/classes.rb +6 -0
  87. data/generated/google/apis/cloudshell_v1alpha1/representations.rb +2 -0
  88. data/generated/google/apis/cloudtasks_v2.rb +1 -1
  89. data/generated/google/apis/cloudtasks_v2/classes.rb +6 -9
  90. data/generated/google/apis/cloudtasks_v2beta2.rb +1 -1
  91. data/generated/google/apis/cloudtasks_v2beta2/classes.rb +6 -9
  92. data/generated/google/apis/cloudtasks_v2beta3.rb +1 -1
  93. data/generated/google/apis/cloudtasks_v2beta3/classes.rb +6 -9
  94. data/generated/google/apis/cloudtrace_v2.rb +1 -1
  95. data/generated/google/apis/cloudtrace_v2/classes.rb +3 -4
  96. data/generated/google/apis/composer_v1beta1.rb +1 -1
  97. data/generated/google/apis/composer_v1beta1/classes.rb +1 -2
  98. data/generated/google/apis/compute_alpha.rb +1 -1
  99. data/generated/google/apis/compute_alpha/classes.rb +414 -29
  100. data/generated/google/apis/compute_alpha/representations.rb +141 -0
  101. data/generated/google/apis/compute_alpha/service.rb +351 -1
  102. data/generated/google/apis/compute_beta.rb +1 -1
  103. data/generated/google/apis/compute_beta/classes.rb +34 -29
  104. data/generated/google/apis/compute_beta/service.rb +3 -1
  105. data/generated/google/apis/compute_v1.rb +1 -1
  106. data/generated/google/apis/compute_v1/classes.rb +129 -10
  107. data/generated/google/apis/compute_v1/representations.rb +38 -0
  108. data/generated/google/apis/compute_v1/service.rb +3 -1
  109. data/generated/google/apis/container_v1.rb +1 -1
  110. data/generated/google/apis/container_v1/classes.rb +145 -132
  111. data/generated/google/apis/container_v1/service.rb +168 -159
  112. data/generated/google/apis/container_v1beta1.rb +1 -1
  113. data/generated/google/apis/container_v1beta1/classes.rb +186 -134
  114. data/generated/google/apis/container_v1beta1/representations.rb +16 -0
  115. data/generated/google/apis/container_v1beta1/service.rb +169 -160
  116. data/generated/google/apis/containeranalysis_v1alpha1.rb +1 -1
  117. data/generated/google/apis/containeranalysis_v1alpha1/classes.rb +26 -10
  118. data/generated/google/apis/containeranalysis_v1beta1.rb +1 -1
  119. data/generated/google/apis/containeranalysis_v1beta1/classes.rb +360 -10
  120. data/generated/google/apis/containeranalysis_v1beta1/representations.rb +159 -0
  121. data/generated/google/apis/content_v2.rb +1 -1
  122. data/generated/google/apis/content_v2/classes.rb +1176 -1094
  123. data/generated/google/apis/content_v2/representations.rb +31 -0
  124. data/generated/google/apis/content_v2/service.rb +45 -45
  125. data/generated/google/apis/content_v2_1.rb +1 -1
  126. data/generated/google/apis/content_v2_1/classes.rb +1801 -931
  127. data/generated/google/apis/content_v2_1/representations.rb +351 -0
  128. data/generated/google/apis/content_v2_1/service.rb +299 -47
  129. data/generated/google/apis/customsearch_v1.rb +1 -1
  130. data/generated/google/apis/datacatalog_v1beta1.rb +1 -1
  131. data/generated/google/apis/datacatalog_v1beta1/classes.rb +67 -7
  132. data/generated/google/apis/datacatalog_v1beta1/representations.rb +3 -0
  133. data/generated/google/apis/datacatalog_v1beta1/service.rb +43 -33
  134. data/generated/google/apis/dataproc_v1.rb +1 -1
  135. data/generated/google/apis/dataproc_v1/classes.rb +69 -36
  136. data/generated/google/apis/dataproc_v1/service.rb +14 -14
  137. data/generated/google/apis/dataproc_v1beta2.rb +1 -1
  138. data/generated/google/apis/dataproc_v1beta2/classes.rb +46 -26
  139. data/generated/google/apis/dialogflow_v2.rb +1 -1
  140. data/generated/google/apis/dialogflow_v2/classes.rb +203 -35
  141. data/generated/google/apis/dialogflow_v2/representations.rb +46 -0
  142. data/generated/google/apis/dialogflow_v2/service.rb +39 -0
  143. data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
  144. data/generated/google/apis/dialogflow_v2beta1/classes.rb +261 -36
  145. data/generated/google/apis/dialogflow_v2beta1/representations.rb +64 -0
  146. data/generated/google/apis/dialogflow_v2beta1/service.rb +88 -10
  147. data/generated/google/apis/displayvideo_v1.rb +1 -1
  148. data/generated/google/apis/displayvideo_v1/classes.rb +7216 -220
  149. data/generated/google/apis/displayvideo_v1/representations.rb +2846 -55
  150. data/generated/google/apis/displayvideo_v1/service.rb +2665 -0
  151. data/generated/google/apis/dlp_v2.rb +1 -1
  152. data/generated/google/apis/dlp_v2/classes.rb +6 -1
  153. data/generated/google/apis/drive_v2.rb +1 -1
  154. data/generated/google/apis/drive_v2/classes.rb +1 -0
  155. data/generated/google/apis/drive_v2/service.rb +51 -57
  156. data/generated/google/apis/drive_v3.rb +1 -1
  157. data/generated/google/apis/drive_v3/service.rb +28 -29
  158. data/generated/google/apis/driveactivity_v2.rb +1 -1
  159. data/generated/google/apis/driveactivity_v2/classes.rb +9 -5
  160. data/generated/google/apis/file_v1.rb +1 -1
  161. data/generated/google/apis/file_v1/classes.rb +1 -1
  162. data/generated/google/apis/file_v1/service.rb +5 -5
  163. data/generated/google/apis/file_v1beta1.rb +1 -1
  164. data/generated/google/apis/file_v1beta1/classes.rb +1 -1
  165. data/generated/google/apis/file_v1beta1/service.rb +10 -7
  166. data/generated/google/apis/firebase_v1beta1.rb +1 -1
  167. data/generated/google/apis/firebase_v1beta1/service.rb +5 -2
  168. data/generated/google/apis/firebasehosting_v1beta1.rb +1 -1
  169. data/generated/google/apis/firebasehosting_v1beta1/classes.rb +8 -58
  170. data/generated/google/apis/firebasehosting_v1beta1/representations.rb +1 -31
  171. data/generated/google/apis/firebasehosting_v1beta1/service.rb +0 -70
  172. data/generated/google/apis/firebaseml_v1beta2.rb +34 -0
  173. data/generated/google/apis/firebaseml_v1beta2/classes.rb +344 -0
  174. data/generated/google/apis/firebaseml_v1beta2/representations.rb +154 -0
  175. data/generated/google/apis/firebaseml_v1beta2/service.rb +267 -0
  176. data/generated/google/apis/games_configuration_v1configuration.rb +1 -1
  177. data/generated/google/apis/games_configuration_v1configuration/classes.rb +9 -10
  178. data/generated/google/apis/games_configuration_v1configuration/service.rb +2 -2
  179. data/generated/google/apis/games_management_v1management.rb +1 -1
  180. data/generated/google/apis/games_management_v1management/classes.rb +0 -6
  181. data/generated/google/apis/games_management_v1management/representations.rb +0 -1
  182. data/generated/google/apis/games_v1.rb +1 -1
  183. data/generated/google/apis/games_v1/classes.rb +1 -7
  184. data/generated/google/apis/games_v1/representations.rb +0 -1
  185. data/generated/google/apis/games_v1/service.rb +3 -12
  186. data/generated/google/apis/gameservices_v1beta.rb +1 -1
  187. data/generated/google/apis/gameservices_v1beta/classes.rb +1 -2
  188. data/generated/google/apis/gameservices_v1beta/service.rb +2 -2
  189. data/generated/google/apis/healthcare_v1.rb +1 -1
  190. data/generated/google/apis/healthcare_v1/classes.rb +0 -1
  191. data/generated/google/apis/healthcare_v1/service.rb +9 -7
  192. data/generated/google/apis/healthcare_v1beta1.rb +1 -1
  193. data/generated/google/apis/healthcare_v1beta1/service.rb +124 -1
  194. data/generated/google/apis/homegraph_v1.rb +1 -1
  195. data/generated/google/apis/homegraph_v1/classes.rb +8 -6
  196. data/generated/google/apis/iamcredentials_v1.rb +1 -1
  197. data/generated/google/apis/iamcredentials_v1/classes.rb +9 -4
  198. data/generated/google/apis/managedidentities_v1.rb +1 -1
  199. data/generated/google/apis/managedidentities_v1/service.rb +2 -2
  200. data/generated/google/apis/managedidentities_v1alpha1.rb +1 -1
  201. data/generated/google/apis/managedidentities_v1alpha1/service.rb +2 -2
  202. data/generated/google/apis/managedidentities_v1beta1.rb +1 -1
  203. data/generated/google/apis/managedidentities_v1beta1/service.rb +2 -2
  204. data/generated/google/apis/memcache_v1beta2.rb +1 -1
  205. data/generated/google/apis/memcache_v1beta2/classes.rb +7 -7
  206. data/generated/google/apis/memcache_v1beta2/service.rb +1 -1
  207. data/generated/google/apis/ml_v1.rb +1 -1
  208. data/generated/google/apis/ml_v1/classes.rb +41 -38
  209. data/generated/google/apis/ml_v1/service.rb +17 -11
  210. data/generated/google/apis/monitoring_v3.rb +1 -1
  211. data/generated/google/apis/monitoring_v3/classes.rb +27 -38
  212. data/generated/google/apis/monitoring_v3/representations.rb +3 -16
  213. data/generated/google/apis/monitoring_v3/service.rb +6 -5
  214. data/generated/google/apis/people_v1.rb +7 -1
  215. data/generated/google/apis/policytroubleshooter_v1.rb +1 -1
  216. data/generated/google/apis/policytroubleshooter_v1/classes.rb +23 -10
  217. data/generated/google/apis/policytroubleshooter_v1beta.rb +1 -1
  218. data/generated/google/apis/policytroubleshooter_v1beta/classes.rb +23 -10
  219. data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
  220. data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +13 -0
  221. data/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb +2 -0
  222. data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +6 -0
  223. data/generated/google/apis/remotebuildexecution_v1.rb +1 -1
  224. data/generated/google/apis/remotebuildexecution_v1/classes.rb +57 -1
  225. data/generated/google/apis/remotebuildexecution_v1/representations.rb +19 -0
  226. data/generated/google/apis/remotebuildexecution_v1alpha.rb +1 -1
  227. data/generated/google/apis/remotebuildexecution_v1alpha/classes.rb +57 -1
  228. data/generated/google/apis/remotebuildexecution_v1alpha/representations.rb +19 -0
  229. data/generated/google/apis/remotebuildexecution_v2.rb +1 -1
  230. data/generated/google/apis/remotebuildexecution_v2/classes.rb +57 -1
  231. data/generated/google/apis/remotebuildexecution_v2/representations.rb +19 -0
  232. data/generated/google/apis/run_v1.rb +1 -1
  233. data/generated/google/apis/run_v1/classes.rb +22 -46
  234. data/generated/google/apis/run_v1/representations.rb +5 -19
  235. data/generated/google/apis/run_v1alpha1.rb +1 -1
  236. data/generated/google/apis/run_v1alpha1/classes.rb +1 -2
  237. data/generated/google/apis/runtimeconfig_v1beta1.rb +1 -1
  238. data/generated/google/apis/runtimeconfig_v1beta1/classes.rb +23 -10
  239. data/generated/google/apis/runtimeconfig_v1beta1/service.rb +8 -5
  240. data/generated/google/apis/sasportal_v1alpha1.rb +1 -1
  241. data/generated/google/apis/sasportal_v1alpha1/classes.rb +13 -0
  242. data/generated/google/apis/sasportal_v1alpha1/representations.rb +2 -0
  243. data/generated/google/apis/sasportal_v1alpha1/service.rb +6 -0
  244. data/generated/google/apis/script_v1.rb +1 -1
  245. data/generated/google/apis/script_v1/classes.rb +4 -22
  246. data/generated/google/apis/secretmanager_v1.rb +1 -1
  247. data/generated/google/apis/secretmanager_v1/classes.rb +1 -2
  248. data/generated/google/apis/secretmanager_v1beta1.rb +1 -1
  249. data/generated/google/apis/secretmanager_v1beta1/classes.rb +1 -2
  250. data/generated/google/apis/securitycenter_v1.rb +1 -1
  251. data/generated/google/apis/securitycenter_v1/classes.rb +0 -12
  252. data/generated/google/apis/securitycenter_v1beta1.rb +1 -1
  253. data/generated/google/apis/securitycenter_v1beta1/classes.rb +0 -8
  254. data/generated/google/apis/securitycenter_v1p1alpha1.rb +1 -1
  255. data/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +0 -8
  256. data/generated/google/apis/securitycenter_v1p1beta1.rb +1 -1
  257. data/generated/google/apis/securitycenter_v1p1beta1/classes.rb +0 -8
  258. data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
  259. data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +34 -14
  260. data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
  261. data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +34 -14
  262. data/generated/google/apis/servicecontrol_v1.rb +1 -1
  263. data/generated/google/apis/servicedirectory_v1beta1.rb +1 -1
  264. data/generated/google/apis/servicemanagement_v1.rb +1 -1
  265. data/generated/google/apis/servicemanagement_v1/service.rb +6 -1
  266. data/generated/google/apis/servicenetworking_v1.rb +1 -1
  267. data/generated/google/apis/servicenetworking_v1/classes.rb +34 -14
  268. data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
  269. data/generated/google/apis/servicenetworking_v1beta/classes.rb +34 -14
  270. data/generated/google/apis/serviceusage_v1.rb +1 -1
  271. data/generated/google/apis/serviceusage_v1/classes.rb +34 -14
  272. data/generated/google/apis/serviceusage_v1/service.rb +1 -1
  273. data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
  274. data/generated/google/apis/serviceusage_v1beta1/classes.rb +34 -14
  275. data/generated/google/apis/sheets_v4.rb +1 -1
  276. data/generated/google/apis/sheets_v4/classes.rb +2 -2
  277. data/generated/google/apis/slides_v1.rb +1 -1
  278. data/generated/google/apis/slides_v1/classes.rb +1 -1
  279. data/generated/google/apis/slides_v1/service.rb +1 -1
  280. data/generated/google/apis/sourcerepo_v1.rb +1 -1
  281. data/generated/google/apis/sourcerepo_v1/classes.rb +1 -2
  282. data/generated/google/apis/speech_v1.rb +1 -1
  283. data/generated/google/apis/speech_v1/classes.rb +2 -1
  284. data/generated/google/apis/speech_v1p1beta1.rb +1 -1
  285. data/generated/google/apis/speech_v1p1beta1/classes.rb +182 -1
  286. data/generated/google/apis/speech_v1p1beta1/representations.rb +77 -0
  287. data/generated/google/apis/storage_v1.rb +1 -1
  288. data/generated/google/apis/storage_v1/classes.rb +21 -0
  289. data/generated/google/apis/storage_v1/representations.rb +5 -0
  290. data/generated/google/apis/tagmanager_v1.rb +1 -1
  291. data/generated/google/apis/tagmanager_v1/service.rb +1 -1
  292. data/generated/google/apis/tagmanager_v2.rb +1 -1
  293. data/generated/google/apis/tagmanager_v2/service.rb +1 -1
  294. data/generated/google/apis/testing_v1.rb +1 -1
  295. data/generated/google/apis/testing_v1/classes.rb +9 -0
  296. data/generated/google/apis/testing_v1/representations.rb +1 -0
  297. data/generated/google/apis/toolresults_v1beta3.rb +2 -2
  298. data/generated/google/apis/toolresults_v1beta3/classes.rb +1431 -1231
  299. data/generated/google/apis/toolresults_v1beta3/representations.rb +442 -2
  300. data/generated/google/apis/toolresults_v1beta3/service.rb +647 -720
  301. data/generated/google/apis/vault_v1.rb +1 -1
  302. data/generated/google/apis/vault_v1/classes.rb +6 -6
  303. data/generated/google/apis/vault_v1/service.rb +7 -7
  304. data/generated/google/apis/videointelligence_v1.rb +1 -1
  305. data/generated/google/apis/videointelligence_v1/classes.rb +215 -76
  306. data/generated/google/apis/videointelligence_v1/representations.rb +23 -0
  307. data/generated/google/apis/videointelligence_v1beta2.rb +1 -1
  308. data/generated/google/apis/videointelligence_v1beta2/classes.rb +215 -76
  309. data/generated/google/apis/videointelligence_v1beta2/representations.rb +23 -0
  310. data/generated/google/apis/videointelligence_v1p1beta1.rb +1 -1
  311. data/generated/google/apis/videointelligence_v1p1beta1/classes.rb +215 -76
  312. data/generated/google/apis/videointelligence_v1p1beta1/representations.rb +23 -0
  313. data/generated/google/apis/videointelligence_v1p2beta1.rb +1 -1
  314. data/generated/google/apis/videointelligence_v1p2beta1/classes.rb +215 -76
  315. data/generated/google/apis/videointelligence_v1p2beta1/representations.rb +23 -0
  316. data/generated/google/apis/videointelligence_v1p3beta1.rb +1 -1
  317. data/generated/google/apis/videointelligence_v1p3beta1/classes.rb +222 -83
  318. data/generated/google/apis/videointelligence_v1p3beta1/representations.rb +23 -0
  319. data/generated/google/apis/youtube_partner_v1.rb +1 -1
  320. data/generated/google/apis/youtube_v3.rb +1 -1
  321. data/lib/google/apis/version.rb +1 -1
  322. metadata +15 -11
  323. data/generated/google/apis/commentanalyzer_v1alpha1.rb +0 -39
  324. data/generated/google/apis/commentanalyzer_v1alpha1/classes.rb +0 -480
  325. data/generated/google/apis/commentanalyzer_v1alpha1/representations.rb +0 -210
  326. data/generated/google/apis/commentanalyzer_v1alpha1/service.rb +0 -124
  327. data/generated/google/apis/osconfig_v1beta/classes.rb +0 -2365
  328. data/generated/google/apis/osconfig_v1beta/representations.rb +0 -966
  329. data/generated/google/apis/osconfig_v1beta/service.rb +0 -605
@@ -48,6 +48,2467 @@ module Google
48
48
  @batch_path = 'batch'
49
49
  end
50
50
 
51
+ # Creates a new advertiser.
52
+ # Returns the newly created advertiser if successful.
53
+ # This method can take up to 180 seconds to complete.
54
+ # @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object
55
+ # @param [String] fields
56
+ # Selector specifying which fields to include in a partial response.
57
+ # @param [String] quota_user
58
+ # Available to use for quota purposes for server-side applications. Can be any
59
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
60
+ # @param [Google::Apis::RequestOptions] options
61
+ # Request-specific options
62
+ #
63
+ # @yield [result, err] Result & error if block supplied
64
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object
65
+ # @yieldparam err [StandardError] error object if request failed
66
+ #
67
+ # @return [Google::Apis::DisplayvideoV1::Advertiser]
68
+ #
69
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
70
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
71
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
72
+ def create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block)
73
+ command = make_simple_command(:post, 'v1/advertisers', options)
74
+ command.request_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
75
+ command.request_object = advertiser_object
76
+ command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
77
+ command.response_class = Google::Apis::DisplayvideoV1::Advertiser
78
+ command.query['fields'] = fields unless fields.nil?
79
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
80
+ execute_or_queue_command(command, &block)
81
+ end
82
+
83
+ # Deletes an advertiser.
84
+ # Deleting an advertiser will delete all of its child resources, for example,
85
+ # campaigns, insertion orders and line items.
86
+ # A deleted advertiser cannot be recovered.
87
+ # @param [Fixnum] advertiser_id
88
+ # The ID of the advertiser we need to delete.
89
+ # @param [String] fields
90
+ # Selector specifying which fields to include in a partial response.
91
+ # @param [String] quota_user
92
+ # Available to use for quota purposes for server-side applications. Can be any
93
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
94
+ # @param [Google::Apis::RequestOptions] options
95
+ # Request-specific options
96
+ #
97
+ # @yield [result, err] Result & error if block supplied
98
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
99
+ # @yieldparam err [StandardError] error object if request failed
100
+ #
101
+ # @return [Google::Apis::DisplayvideoV1::Empty]
102
+ #
103
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
104
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
105
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
106
+ def delete_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
107
+ command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}', options)
108
+ command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
109
+ command.response_class = Google::Apis::DisplayvideoV1::Empty
110
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
111
+ command.query['fields'] = fields unless fields.nil?
112
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
113
+ execute_or_queue_command(command, &block)
114
+ end
115
+
116
+ # Gets an advertiser.
117
+ # @param [Fixnum] advertiser_id
118
+ # Required. The ID of the advertiser to fetch.
119
+ # @param [String] fields
120
+ # Selector specifying which fields to include in a partial response.
121
+ # @param [String] quota_user
122
+ # Available to use for quota purposes for server-side applications. Can be any
123
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
124
+ # @param [Google::Apis::RequestOptions] options
125
+ # Request-specific options
126
+ #
127
+ # @yield [result, err] Result & error if block supplied
128
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object
129
+ # @yieldparam err [StandardError] error object if request failed
130
+ #
131
+ # @return [Google::Apis::DisplayvideoV1::Advertiser]
132
+ #
133
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
134
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
135
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
136
+ def get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
137
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}', options)
138
+ command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
139
+ command.response_class = Google::Apis::DisplayvideoV1::Advertiser
140
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
141
+ command.query['fields'] = fields unless fields.nil?
142
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
143
+ execute_or_queue_command(command, &block)
144
+ end
145
+
146
+ # Lists advertisers that are accessible to the current user.
147
+ # The order is defined by the order_by
148
+ # parameter.
149
+ # A single partner_id is required.
150
+ # Cross-partner listing is not supported.
151
+ # @param [String] filter
152
+ # Allows filtering by advertiser properties.
153
+ # Supported syntax:
154
+ # * Filter expressions are made up of one or more restrictions.
155
+ # * Restrictions can be combined by `AND` or `OR` logical operators. A
156
+ # sequence of restrictions implicitly uses `AND`.
157
+ # * A restriction has the form of ``field` `operator` `value``.
158
+ # * The operator must be `EQUALS (=)`.
159
+ # * Supported fields:
160
+ # - `entityStatus`
161
+ # Examples:
162
+ # * All active advertisers under a partner:
163
+ # `entityStatus="ENTITY_STATUS_ACTIVE"`
164
+ # The length of this field should be no more than 500 characters.
165
+ # @param [String] order_by
166
+ # Field by which to sort the list.
167
+ # Acceptable values are:
168
+ # * `displayName` (default)
169
+ # * `entityStatus`
170
+ # The default sorting order is ascending. To specify descending order for
171
+ # a field, a suffix "desc" should be added to the field name. For example,
172
+ # `displayName desc`.
173
+ # @param [Fixnum] page_size
174
+ # Requested page size. Must be between `1` and `100`. If unspecified will
175
+ # default to `100`.
176
+ # @param [String] page_token
177
+ # A token identifying a page of results the server should return.
178
+ # Typically, this is the value of
179
+ # next_page_token
180
+ # returned from the previous call to `ListAdvertisers` method.
181
+ # If not specified, the first page of results will be returned.
182
+ # @param [Fixnum] partner_id
183
+ # Required. The ID of the partner that the fetched advertisers should all belong
184
+ # to.
185
+ # The system only supports listing advertisers for one partner at a time.
186
+ # @param [String] fields
187
+ # Selector specifying which fields to include in a partial response.
188
+ # @param [String] quota_user
189
+ # Available to use for quota purposes for server-side applications. Can be any
190
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
191
+ # @param [Google::Apis::RequestOptions] options
192
+ # Request-specific options
193
+ #
194
+ # @yield [result, err] Result & error if block supplied
195
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListAdvertisersResponse] parsed result object
196
+ # @yieldparam err [StandardError] error object if request failed
197
+ #
198
+ # @return [Google::Apis::DisplayvideoV1::ListAdvertisersResponse]
199
+ #
200
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
201
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
202
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
203
+ def list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
204
+ command = make_simple_command(:get, 'v1/advertisers', options)
205
+ command.response_representation = Google::Apis::DisplayvideoV1::ListAdvertisersResponse::Representation
206
+ command.response_class = Google::Apis::DisplayvideoV1::ListAdvertisersResponse
207
+ command.query['filter'] = filter unless filter.nil?
208
+ command.query['orderBy'] = order_by unless order_by.nil?
209
+ command.query['pageSize'] = page_size unless page_size.nil?
210
+ command.query['pageToken'] = page_token unless page_token.nil?
211
+ command.query['partnerId'] = partner_id unless partner_id.nil?
212
+ command.query['fields'] = fields unless fields.nil?
213
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
214
+ execute_or_queue_command(command, &block)
215
+ end
216
+
217
+ # Updates an existing advertiser.
218
+ # Returns the updated advertiser if successful.
219
+ # @param [Fixnum] advertiser_id
220
+ # Output only. The unique ID of the advertiser. Assigned by the system.
221
+ # @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object
222
+ # @param [String] update_mask
223
+ # Required. The mask to control which fields to update.
224
+ # @param [String] fields
225
+ # Selector specifying which fields to include in a partial response.
226
+ # @param [String] quota_user
227
+ # Available to use for quota purposes for server-side applications. Can be any
228
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
229
+ # @param [Google::Apis::RequestOptions] options
230
+ # Request-specific options
231
+ #
232
+ # @yield [result, err] Result & error if block supplied
233
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Advertiser] parsed result object
234
+ # @yieldparam err [StandardError] error object if request failed
235
+ #
236
+ # @return [Google::Apis::DisplayvideoV1::Advertiser]
237
+ #
238
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
239
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
240
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
241
+ def patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
242
+ command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}', options)
243
+ command.request_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
244
+ command.request_object = advertiser_object
245
+ command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
246
+ command.response_class = Google::Apis::DisplayvideoV1::Advertiser
247
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
248
+ command.query['updateMask'] = update_mask unless update_mask.nil?
249
+ command.query['fields'] = fields unless fields.nil?
250
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
251
+ execute_or_queue_command(command, &block)
252
+ end
253
+
254
+ # Uploads an asset.
255
+ # Returns the ID of the newly uploaded asset if successful.
256
+ # The asset file size should be no more than 10 MB for images, 200 MB for
257
+ # ZIP files, and 1 GB for videos.
258
+ # @param [Fixnum] advertiser_id
259
+ # Required. The ID of the advertiser this asset belongs to.
260
+ # @param [Google::Apis::DisplayvideoV1::CreateAssetRequest] create_asset_request_object
261
+ # @param [String] fields
262
+ # Selector specifying which fields to include in a partial response.
263
+ # @param [String] quota_user
264
+ # Available to use for quota purposes for server-side applications. Can be any
265
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
266
+ # @param [IO, String] upload_source
267
+ # IO stream or filename containing content to upload
268
+ # @param [String] content_type
269
+ # Content type of the uploaded content.
270
+ # @param [Google::Apis::RequestOptions] options
271
+ # Request-specific options
272
+ #
273
+ # @yield [result, err] Result & error if block supplied
274
+ # @yieldparam result [Google::Apis::DisplayvideoV1::CreateAssetResponse] parsed result object
275
+ # @yieldparam err [StandardError] error object if request failed
276
+ #
277
+ # @return [Google::Apis::DisplayvideoV1::CreateAssetResponse]
278
+ #
279
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
280
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
281
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
282
+ def upload_advertiser_asset(advertiser_id, create_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
283
+ if upload_source.nil?
284
+ command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/assets', options)
285
+ else
286
+ command = make_upload_command(:post, 'v1/advertisers/{+advertiserId}/assets', options)
287
+ command.upload_source = upload_source
288
+ command.upload_content_type = content_type
289
+ end
290
+ command.request_representation = Google::Apis::DisplayvideoV1::CreateAssetRequest::Representation
291
+ command.request_object = create_asset_request_object
292
+ command.response_representation = Google::Apis::DisplayvideoV1::CreateAssetResponse::Representation
293
+ command.response_class = Google::Apis::DisplayvideoV1::CreateAssetResponse
294
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
295
+ command.query['fields'] = fields unless fields.nil?
296
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
297
+ execute_or_queue_command(command, &block)
298
+ end
299
+
300
+ # Creates a new campaign.
301
+ # Returns the newly created campaign if successful.
302
+ # @param [Fixnum] advertiser_id
303
+ # Output only. The unique ID of the advertiser the campaign belongs to.
304
+ # @param [Google::Apis::DisplayvideoV1::Campaign] campaign_object
305
+ # @param [String] fields
306
+ # Selector specifying which fields to include in a partial response.
307
+ # @param [String] quota_user
308
+ # Available to use for quota purposes for server-side applications. Can be any
309
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
310
+ # @param [Google::Apis::RequestOptions] options
311
+ # Request-specific options
312
+ #
313
+ # @yield [result, err] Result & error if block supplied
314
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object
315
+ # @yieldparam err [StandardError] error object if request failed
316
+ #
317
+ # @return [Google::Apis::DisplayvideoV1::Campaign]
318
+ #
319
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
320
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
321
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
322
+ def create_advertiser_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil, &block)
323
+ command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/campaigns', options)
324
+ command.request_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
325
+ command.request_object = campaign_object
326
+ command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
327
+ command.response_class = Google::Apis::DisplayvideoV1::Campaign
328
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
329
+ command.query['fields'] = fields unless fields.nil?
330
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
331
+ execute_or_queue_command(command, &block)
332
+ end
333
+
334
+ # Permanently deletes a campaign. A deleted campaign cannot be recovered.
335
+ # The campaign should be archived first, i.e. set
336
+ # entity_status to `ENTITY_STATUS_ARCHIVED`, to be
337
+ # able to delete it.
338
+ # @param [Fixnum] advertiser_id
339
+ # The ID of the advertiser this campaign belongs to.
340
+ # @param [Fixnum] campaign_id
341
+ # The ID of the campaign we need to delete.
342
+ # @param [String] fields
343
+ # Selector specifying which fields to include in a partial response.
344
+ # @param [String] quota_user
345
+ # Available to use for quota purposes for server-side applications. Can be any
346
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
347
+ # @param [Google::Apis::RequestOptions] options
348
+ # Request-specific options
349
+ #
350
+ # @yield [result, err] Result & error if block supplied
351
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
352
+ # @yieldparam err [StandardError] error object if request failed
353
+ #
354
+ # @return [Google::Apis::DisplayvideoV1::Empty]
355
+ #
356
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
357
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
358
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
359
+ def delete_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
360
+ command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
361
+ command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
362
+ command.response_class = Google::Apis::DisplayvideoV1::Empty
363
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
364
+ command.params['campaignId'] = campaign_id unless campaign_id.nil?
365
+ command.query['fields'] = fields unless fields.nil?
366
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
367
+ execute_or_queue_command(command, &block)
368
+ end
369
+
370
+ # Gets a campaign.
371
+ # @param [Fixnum] advertiser_id
372
+ # Required. The ID of the advertiser this campaign belongs to.
373
+ # @param [Fixnum] campaign_id
374
+ # Required. The ID of the campaign to fetch.
375
+ # @param [String] fields
376
+ # Selector specifying which fields to include in a partial response.
377
+ # @param [String] quota_user
378
+ # Available to use for quota purposes for server-side applications. Can be any
379
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
380
+ # @param [Google::Apis::RequestOptions] options
381
+ # Request-specific options
382
+ #
383
+ # @yield [result, err] Result & error if block supplied
384
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object
385
+ # @yieldparam err [StandardError] error object if request failed
386
+ #
387
+ # @return [Google::Apis::DisplayvideoV1::Campaign]
388
+ #
389
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
390
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
391
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
392
+ def get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
393
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
394
+ command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
395
+ command.response_class = Google::Apis::DisplayvideoV1::Campaign
396
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
397
+ command.params['campaignId'] = campaign_id unless campaign_id.nil?
398
+ command.query['fields'] = fields unless fields.nil?
399
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
400
+ execute_or_queue_command(command, &block)
401
+ end
402
+
403
+ # Lists campaigns in an advertiser.
404
+ # The order is defined by the order_by
405
+ # parameter.
406
+ # If a filter by
407
+ # entity_status is not specified, campaigns with
408
+ # `ENTITY_STATUS_ARCHIVED` will not be included in the results.
409
+ # @param [Fixnum] advertiser_id
410
+ # The ID of the advertiser to list campaigns for.
411
+ # @param [String] filter
412
+ # Allows filtering by campaign properties.
413
+ # Supported syntax:
414
+ # * Filter expressions are made up of one or more restrictions.
415
+ # * Restrictions can be combined by `AND` or `OR` logical operators. A
416
+ # sequence of restrictions implicitly uses `AND`.
417
+ # * A restriction has the form of ``field` `operator` `value``.
418
+ # * The operator must be `EQUALS (=)`.
419
+ # * Supported fields:
420
+ # - `entityStatus`
421
+ # Examples:
422
+ # * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an
423
+ # advertiser:
424
+ # `(entityStatus="ENTITY_STATUS_ACTIVE" OR
425
+ # entityStatus="ENTITY_STATUS_PAUSED")`
426
+ # The length of this field should be no more than 500 characters.
427
+ # @param [String] order_by
428
+ # Field by which to sort the list.
429
+ # Acceptable values are:
430
+ # * `displayName` (default)
431
+ # * `entityStatus`
432
+ # The default sorting order is ascending. To specify descending order for
433
+ # a field, a suffix "desc" should be added to the field name. Example:
434
+ # `displayName desc`.
435
+ # @param [Fixnum] page_size
436
+ # Requested page size. Must be between `1` and `100`. If unspecified will
437
+ # default to `100`.
438
+ # @param [String] page_token
439
+ # A token identifying a page of results the server should return.
440
+ # Typically, this is the value of
441
+ # next_page_token returned from the
442
+ # previous call to `ListCampaigns` method. If not specified, the first page
443
+ # of results will be returned.
444
+ # @param [String] fields
445
+ # Selector specifying which fields to include in a partial response.
446
+ # @param [String] quota_user
447
+ # Available to use for quota purposes for server-side applications. Can be any
448
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
449
+ # @param [Google::Apis::RequestOptions] options
450
+ # Request-specific options
451
+ #
452
+ # @yield [result, err] Result & error if block supplied
453
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListCampaignsResponse] parsed result object
454
+ # @yieldparam err [StandardError] error object if request failed
455
+ #
456
+ # @return [Google::Apis::DisplayvideoV1::ListCampaignsResponse]
457
+ #
458
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
459
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
460
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
461
+ def list_advertiser_campaigns(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
462
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns', options)
463
+ command.response_representation = Google::Apis::DisplayvideoV1::ListCampaignsResponse::Representation
464
+ command.response_class = Google::Apis::DisplayvideoV1::ListCampaignsResponse
465
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
466
+ command.query['filter'] = filter unless filter.nil?
467
+ command.query['orderBy'] = order_by unless order_by.nil?
468
+ command.query['pageSize'] = page_size unless page_size.nil?
469
+ command.query['pageToken'] = page_token unless page_token.nil?
470
+ command.query['fields'] = fields unless fields.nil?
471
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
472
+ execute_or_queue_command(command, &block)
473
+ end
474
+
475
+ # Updates an existing campaign.
476
+ # Returns the updated campaign if successful.
477
+ # @param [Fixnum] advertiser_id
478
+ # Output only. The unique ID of the advertiser the campaign belongs to.
479
+ # @param [Fixnum] campaign_id
480
+ # Output only. The unique ID of the campaign. Assigned by the system.
481
+ # @param [Google::Apis::DisplayvideoV1::Campaign] campaign_object
482
+ # @param [String] update_mask
483
+ # Required. The mask to control which fields to update.
484
+ # @param [String] fields
485
+ # Selector specifying which fields to include in a partial response.
486
+ # @param [String] quota_user
487
+ # Available to use for quota purposes for server-side applications. Can be any
488
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
489
+ # @param [Google::Apis::RequestOptions] options
490
+ # Request-specific options
491
+ #
492
+ # @yield [result, err] Result & error if block supplied
493
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Campaign] parsed result object
494
+ # @yieldparam err [StandardError] error object if request failed
495
+ #
496
+ # @return [Google::Apis::DisplayvideoV1::Campaign]
497
+ #
498
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
499
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
500
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
501
+ def patch_advertiser_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
502
+ command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
503
+ command.request_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
504
+ command.request_object = campaign_object
505
+ command.response_representation = Google::Apis::DisplayvideoV1::Campaign::Representation
506
+ command.response_class = Google::Apis::DisplayvideoV1::Campaign
507
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
508
+ command.params['campaignId'] = campaign_id unless campaign_id.nil?
509
+ command.query['updateMask'] = update_mask unless update_mask.nil?
510
+ command.query['fields'] = fields unless fields.nil?
511
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
512
+ execute_or_queue_command(command, &block)
513
+ end
514
+
515
+ # Gets a channel for a partner or advertiser.
516
+ # @param [Fixnum] advertiser_id
517
+ # The ID of the advertiser that owns the fetched channel.
518
+ # @param [Fixnum] channel_id
519
+ # Required. The ID of the channel to fetch.
520
+ # @param [Fixnum] partner_id
521
+ # The ID of the partner that owns the fetched channel.
522
+ # @param [String] fields
523
+ # Selector specifying which fields to include in a partial response.
524
+ # @param [String] quota_user
525
+ # Available to use for quota purposes for server-side applications. Can be any
526
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
527
+ # @param [Google::Apis::RequestOptions] options
528
+ # Request-specific options
529
+ #
530
+ # @yield [result, err] Result & error if block supplied
531
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
532
+ # @yieldparam err [StandardError] error object if request failed
533
+ #
534
+ # @return [Google::Apis::DisplayvideoV1::Channel]
535
+ #
536
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
537
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
538
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
539
+ def get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
540
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/channels/{+channelId}', options)
541
+ command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
542
+ command.response_class = Google::Apis::DisplayvideoV1::Channel
543
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
544
+ command.params['channelId'] = channel_id unless channel_id.nil?
545
+ command.query['partnerId'] = partner_id unless partner_id.nil?
546
+ command.query['fields'] = fields unless fields.nil?
547
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
548
+ execute_or_queue_command(command, &block)
549
+ end
550
+
551
+ # Lists channels for a partner or advertiser.
552
+ # @param [Fixnum] advertiser_id
553
+ # The ID of the advertiser that owns the channels.
554
+ # @param [String] filter
555
+ # Allows filtering by channel fields.
556
+ # Supported syntax:
557
+ # * Filter expressions for channel currently can only contain at most one
558
+ # * restriction.
559
+ # * A restriction has the form of ``field` `operator` `value``.
560
+ # * The operator must be `CONTAINS (:)`.
561
+ # * Supported fields:
562
+ # - `displayName`
563
+ # Examples:
564
+ # * All channels for which the display name contains "google":
565
+ # `displayName : "google"`.
566
+ # The length of this field should be no more than 500 characters.
567
+ # @param [String] order_by
568
+ # Field by which to sort the list.
569
+ # Acceptable values are:
570
+ # * `displayName` (default)
571
+ # * `channelId`
572
+ # The default sorting order is ascending. To specify descending order for a
573
+ # field, a suffix " desc" should be added to the field name. Example:
574
+ # `displayName desc`.
575
+ # @param [Fixnum] page_size
576
+ # Requested page size. Must be between `1` and `100`. If unspecified will
577
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
578
+ # is specified.
579
+ # @param [String] page_token
580
+ # A token identifying a page of results the server should return.
581
+ # Typically, this is the value of
582
+ # next_page_token returned from the
583
+ # previous call to `ListChannels` method. If not specified, the first page
584
+ # of results will be returned.
585
+ # @param [Fixnum] partner_id
586
+ # The ID of the partner that owns the channels.
587
+ # @param [String] fields
588
+ # Selector specifying which fields to include in a partial response.
589
+ # @param [String] quota_user
590
+ # Available to use for quota purposes for server-side applications. Can be any
591
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
592
+ # @param [Google::Apis::RequestOptions] options
593
+ # Request-specific options
594
+ #
595
+ # @yield [result, err] Result & error if block supplied
596
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListChannelsResponse] parsed result object
597
+ # @yieldparam err [StandardError] error object if request failed
598
+ #
599
+ # @return [Google::Apis::DisplayvideoV1::ListChannelsResponse]
600
+ #
601
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
602
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
603
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
604
+ def list_advertiser_channels(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
605
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/channels', options)
606
+ command.response_representation = Google::Apis::DisplayvideoV1::ListChannelsResponse::Representation
607
+ command.response_class = Google::Apis::DisplayvideoV1::ListChannelsResponse
608
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
609
+ command.query['filter'] = filter unless filter.nil?
610
+ command.query['orderBy'] = order_by unless order_by.nil?
611
+ command.query['pageSize'] = page_size unless page_size.nil?
612
+ command.query['pageToken'] = page_token unless page_token.nil?
613
+ command.query['partnerId'] = partner_id unless partner_id.nil?
614
+ command.query['fields'] = fields unless fields.nil?
615
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
616
+ execute_or_queue_command(command, &block)
617
+ end
618
+
619
+ # Creates a new creative.
620
+ # Returns the newly created creative if successful.
621
+ # @param [Fixnum] advertiser_id
622
+ # Output only. The unique ID of the advertiser the creative belongs to.
623
+ # @param [Google::Apis::DisplayvideoV1::Creative] creative_object
624
+ # @param [String] fields
625
+ # Selector specifying which fields to include in a partial response.
626
+ # @param [String] quota_user
627
+ # Available to use for quota purposes for server-side applications. Can be any
628
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
629
+ # @param [Google::Apis::RequestOptions] options
630
+ # Request-specific options
631
+ #
632
+ # @yield [result, err] Result & error if block supplied
633
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object
634
+ # @yieldparam err [StandardError] error object if request failed
635
+ #
636
+ # @return [Google::Apis::DisplayvideoV1::Creative]
637
+ #
638
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
639
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
640
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
641
+ def create_advertiser_creative(advertiser_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
642
+ command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/creatives', options)
643
+ command.request_representation = Google::Apis::DisplayvideoV1::Creative::Representation
644
+ command.request_object = creative_object
645
+ command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation
646
+ command.response_class = Google::Apis::DisplayvideoV1::Creative
647
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
648
+ command.query['fields'] = fields unless fields.nil?
649
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
650
+ execute_or_queue_command(command, &block)
651
+ end
652
+
653
+ # Deletes a creative.
654
+ # Returns error code `NOT_FOUND` if the creative does not exist.
655
+ # The creative should be archived first, i.e. set
656
+ # entity_status to `ENTITY_STATUS_ARCHIVED`, before
657
+ # it can be deleted.
658
+ # @param [Fixnum] advertiser_id
659
+ # The ID of the advertiser this creative belongs to.
660
+ # @param [Fixnum] creative_id
661
+ # The ID of the creative to be deleted.
662
+ # @param [String] fields
663
+ # Selector specifying which fields to include in a partial response.
664
+ # @param [String] quota_user
665
+ # Available to use for quota purposes for server-side applications. Can be any
666
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
667
+ # @param [Google::Apis::RequestOptions] options
668
+ # Request-specific options
669
+ #
670
+ # @yield [result, err] Result & error if block supplied
671
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
672
+ # @yieldparam err [StandardError] error object if request failed
673
+ #
674
+ # @return [Google::Apis::DisplayvideoV1::Empty]
675
+ #
676
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
677
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
678
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
679
+ def delete_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
680
+ command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
681
+ command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
682
+ command.response_class = Google::Apis::DisplayvideoV1::Empty
683
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
684
+ command.params['creativeId'] = creative_id unless creative_id.nil?
685
+ command.query['fields'] = fields unless fields.nil?
686
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
687
+ execute_or_queue_command(command, &block)
688
+ end
689
+
690
+ # Gets a creative.
691
+ # @param [Fixnum] advertiser_id
692
+ # Required. The ID of the advertiser this creative belongs to.
693
+ # @param [Fixnum] creative_id
694
+ # Required. The ID of the creative to fetch.
695
+ # @param [String] fields
696
+ # Selector specifying which fields to include in a partial response.
697
+ # @param [String] quota_user
698
+ # Available to use for quota purposes for server-side applications. Can be any
699
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
700
+ # @param [Google::Apis::RequestOptions] options
701
+ # Request-specific options
702
+ #
703
+ # @yield [result, err] Result & error if block supplied
704
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object
705
+ # @yieldparam err [StandardError] error object if request failed
706
+ #
707
+ # @return [Google::Apis::DisplayvideoV1::Creative]
708
+ #
709
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
710
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
711
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
712
+ def get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
713
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
714
+ command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation
715
+ command.response_class = Google::Apis::DisplayvideoV1::Creative
716
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
717
+ command.params['creativeId'] = creative_id unless creative_id.nil?
718
+ command.query['fields'] = fields unless fields.nil?
719
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
720
+ execute_or_queue_command(command, &block)
721
+ end
722
+
723
+ # Lists creatives in an advertiser.
724
+ # The order is defined by the order_by
725
+ # parameter.
726
+ # If a filter by
727
+ # entity_status is not specified, creatives with
728
+ # `ENTITY_STATUS_ARCHIVED` will not be included in the results.
729
+ # @param [Fixnum] advertiser_id
730
+ # Required. The ID of the advertiser to list creatives for.
731
+ # @param [String] filter
732
+ # Allows filtering by creative properties.
733
+ # Supported syntax:
734
+ # * Filter expressions are made up of one or more restrictions.
735
+ # * Restriction for the same field must be combined by `OR`.
736
+ # * Restriction for different fields must be combined by `AND`.
737
+ # * Between `(` and `)` there can only be restrictions combined by `OR`
738
+ # for the same field.
739
+ # * A restriction has the form of ``field` `operator` `value``.
740
+ # * The operator must be `EQUALS (=)`.
741
+ # * Supported fields:
742
+ # - `entityStatus`
743
+ # - `creativeType`.
744
+ # - `dimensions`
745
+ # - `minDuration`
746
+ # - `maxDuration`
747
+ # - `approvalStatus`
748
+ # - `exchangeReviewStatus`
749
+ # - `dynamic`
750
+ # * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may
751
+ # be at most one restriction.
752
+ # * For `dimensions`, the value is in the form of `"`width`x`height`"`.
753
+ # * For `exchangeReviewStatus`, the value is in the form of
754
+ # ``exchange`-`reviewStatus``.
755
+ # * For `minDuration` and `maxDuration`, the value is in the form of
756
+ # `"`duration`s"`. Only seconds are supported with millisecond granularity.
757
+ # Examples:
758
+ # * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"`
759
+ # * All active creatives with 300x400 or 50x100 dimensions:
760
+ # `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400"
761
+ # OR dimensions="50x100")`
762
+ # * All dynamic creatives that are approved by AdX or
763
+ # AppNexus, with a minimum duration of 5 seconds and 200ms.
764
+ # `dynamic="true" AND minDuration="5.2s" AND
765
+ # (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED"
766
+ # OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")`
767
+ # The length of this field should be no more than 500 characters.
768
+ # @param [String] order_by
769
+ # Field by which to sort the list.
770
+ # Acceptable values are:
771
+ # * `creativeId` (default)
772
+ # * `createTime`
773
+ # * `mediaDuration`
774
+ # * `dimensions` (sorts by width first, then by height)
775
+ # The default sorting order is ascending. To specify descending order for
776
+ # a field, a suffix "desc" should be added to the field name.
777
+ # Example: `createTime desc`.
778
+ # @param [Fixnum] page_size
779
+ # Requested page size. Must be between `1` and `100`. If unspecified will
780
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
781
+ # is specified.
782
+ # @param [String] page_token
783
+ # A token identifying a page of results the server should return.
784
+ # Typically, this is the value of
785
+ # next_page_token
786
+ # returned from the previous call to `ListCreatives` method.
787
+ # If not specified, the first page of results will be returned.
788
+ # @param [String] fields
789
+ # Selector specifying which fields to include in a partial response.
790
+ # @param [String] quota_user
791
+ # Available to use for quota purposes for server-side applications. Can be any
792
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
793
+ # @param [Google::Apis::RequestOptions] options
794
+ # Request-specific options
795
+ #
796
+ # @yield [result, err] Result & error if block supplied
797
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListCreativesResponse] parsed result object
798
+ # @yieldparam err [StandardError] error object if request failed
799
+ #
800
+ # @return [Google::Apis::DisplayvideoV1::ListCreativesResponse]
801
+ #
802
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
803
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
804
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
805
+ def list_advertiser_creatives(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
806
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/creatives', options)
807
+ command.response_representation = Google::Apis::DisplayvideoV1::ListCreativesResponse::Representation
808
+ command.response_class = Google::Apis::DisplayvideoV1::ListCreativesResponse
809
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
810
+ command.query['filter'] = filter unless filter.nil?
811
+ command.query['orderBy'] = order_by unless order_by.nil?
812
+ command.query['pageSize'] = page_size unless page_size.nil?
813
+ command.query['pageToken'] = page_token unless page_token.nil?
814
+ command.query['fields'] = fields unless fields.nil?
815
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
816
+ execute_or_queue_command(command, &block)
817
+ end
818
+
819
+ # Updates an existing creative.
820
+ # Returns the updated creative if successful.
821
+ # @param [Fixnum] advertiser_id
822
+ # Output only. The unique ID of the advertiser the creative belongs to.
823
+ # @param [Fixnum] creative_id
824
+ # Output only. The unique ID of the creative. Assigned by the system.
825
+ # @param [Google::Apis::DisplayvideoV1::Creative] creative_object
826
+ # @param [String] update_mask
827
+ # Required. The mask to control which fields to update.
828
+ # @param [String] fields
829
+ # Selector specifying which fields to include in a partial response.
830
+ # @param [String] quota_user
831
+ # Available to use for quota purposes for server-side applications. Can be any
832
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
833
+ # @param [Google::Apis::RequestOptions] options
834
+ # Request-specific options
835
+ #
836
+ # @yield [result, err] Result & error if block supplied
837
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Creative] parsed result object
838
+ # @yieldparam err [StandardError] error object if request failed
839
+ #
840
+ # @return [Google::Apis::DisplayvideoV1::Creative]
841
+ #
842
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
843
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
844
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
845
+ def patch_advertiser_creative(advertiser_id, creative_id, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
846
+ command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
847
+ command.request_representation = Google::Apis::DisplayvideoV1::Creative::Representation
848
+ command.request_object = creative_object
849
+ command.response_representation = Google::Apis::DisplayvideoV1::Creative::Representation
850
+ command.response_class = Google::Apis::DisplayvideoV1::Creative
851
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
852
+ command.params['creativeId'] = creative_id unless creative_id.nil?
853
+ command.query['updateMask'] = update_mask unless update_mask.nil?
854
+ command.query['fields'] = fields unless fields.nil?
855
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
856
+ execute_or_queue_command(command, &block)
857
+ end
858
+
859
+ # Creates a new insertion order.
860
+ # Returns the newly created insertion order if successful.
861
+ # @param [Fixnum] advertiser_id
862
+ # Output only. The unique ID of the advertiser the insertion order belongs to.
863
+ # @param [Google::Apis::DisplayvideoV1::InsertionOrder] insertion_order_object
864
+ # @param [String] fields
865
+ # Selector specifying which fields to include in a partial response.
866
+ # @param [String] quota_user
867
+ # Available to use for quota purposes for server-side applications. Can be any
868
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
869
+ # @param [Google::Apis::RequestOptions] options
870
+ # Request-specific options
871
+ #
872
+ # @yield [result, err] Result & error if block supplied
873
+ # @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object
874
+ # @yieldparam err [StandardError] error object if request failed
875
+ #
876
+ # @return [Google::Apis::DisplayvideoV1::InsertionOrder]
877
+ #
878
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
879
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
880
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
881
+ def create_advertiser_insertion_order(advertiser_id, insertion_order_object = nil, fields: nil, quota_user: nil, options: nil, &block)
882
+ command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/insertionOrders', options)
883
+ command.request_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
884
+ command.request_object = insertion_order_object
885
+ command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
886
+ command.response_class = Google::Apis::DisplayvideoV1::InsertionOrder
887
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
888
+ command.query['fields'] = fields unless fields.nil?
889
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
890
+ execute_or_queue_command(command, &block)
891
+ end
892
+
893
+ # Deletes an insertion order.
894
+ # Returns error code `NOT_FOUND` if the insertion order does not exist.
895
+ # The insertion order should be archived first, i.e. set
896
+ # entity_status to `ENTITY_STATUS_ARCHIVED`,
897
+ # to be able to delete it.
898
+ # @param [Fixnum] advertiser_id
899
+ # The ID of the advertiser this insertion order belongs to.
900
+ # @param [Fixnum] insertion_order_id
901
+ # The ID of the insertion order we need to delete.
902
+ # @param [String] fields
903
+ # Selector specifying which fields to include in a partial response.
904
+ # @param [String] quota_user
905
+ # Available to use for quota purposes for server-side applications. Can be any
906
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
907
+ # @param [Google::Apis::RequestOptions] options
908
+ # Request-specific options
909
+ #
910
+ # @yield [result, err] Result & error if block supplied
911
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
912
+ # @yieldparam err [StandardError] error object if request failed
913
+ #
914
+ # @return [Google::Apis::DisplayvideoV1::Empty]
915
+ #
916
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
917
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
918
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
919
+ def delete_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
920
+ command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
921
+ command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
922
+ command.response_class = Google::Apis::DisplayvideoV1::Empty
923
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
924
+ command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
925
+ command.query['fields'] = fields unless fields.nil?
926
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
927
+ execute_or_queue_command(command, &block)
928
+ end
929
+
930
+ # Gets an insertion order.
931
+ # Returns error code `NOT_FOUND` if the insertion order does not exist.
932
+ # @param [Fixnum] advertiser_id
933
+ # Required. The ID of the advertiser this insertion order belongs to.
934
+ # @param [Fixnum] insertion_order_id
935
+ # Required. The ID of the insertion order to fetch.
936
+ # @param [String] fields
937
+ # Selector specifying which fields to include in a partial response.
938
+ # @param [String] quota_user
939
+ # Available to use for quota purposes for server-side applications. Can be any
940
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
941
+ # @param [Google::Apis::RequestOptions] options
942
+ # Request-specific options
943
+ #
944
+ # @yield [result, err] Result & error if block supplied
945
+ # @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object
946
+ # @yieldparam err [StandardError] error object if request failed
947
+ #
948
+ # @return [Google::Apis::DisplayvideoV1::InsertionOrder]
949
+ #
950
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
951
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
952
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
953
+ def get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
954
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
955
+ command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
956
+ command.response_class = Google::Apis::DisplayvideoV1::InsertionOrder
957
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
958
+ command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
959
+ command.query['fields'] = fields unless fields.nil?
960
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
961
+ execute_or_queue_command(command, &block)
962
+ end
963
+
964
+ # Lists insertion orders in an advertiser.
965
+ # The order is defined by the order_by
966
+ # parameter.
967
+ # If a filter by
968
+ # entity_status is not specified, insertion
969
+ # orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
970
+ # @param [Fixnum] advertiser_id
971
+ # Required. The ID of the advertiser to list insertion orders for.
972
+ # @param [String] filter
973
+ # Allows filtering by insertion order properties.
974
+ # Supported syntax:
975
+ # * Filter expressions are made up of one or more restrictions.
976
+ # * Restrictions can be combined by `AND` or `OR` logical operators. A
977
+ # sequence of restrictions implicitly uses `AND`.
978
+ # * A restriction has the form of ``field` `operator` `value``.
979
+ # * The operator must be `EQUALS (=)`.
980
+ # * Supported fields:
981
+ # - `campaignId`
982
+ # - `entityStatus`
983
+ # Examples:
984
+ # * All insertion orders under a campaign: `campaignId="1234"`
985
+ # * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders
986
+ # under an advertiser:
987
+ # `(entityStatus="ENTITY_STATUS_ACTIVE" OR
988
+ # entityStatus="ENTITY_STATUS_PAUSED")`
989
+ # The length of this field should be no more than 500 characters.
990
+ # @param [String] order_by
991
+ # Field by which to sort the list.
992
+ # Acceptable values are:
993
+ # * "displayName" (default)
994
+ # * "entityStatus"
995
+ # The default sorting order is ascending. To specify descending order for
996
+ # a field, a suffix "desc" should be added to the field name. Example:
997
+ # `displayName desc`.
998
+ # @param [Fixnum] page_size
999
+ # Requested page size. Must be between `1` and `100`. If unspecified will
1000
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
1001
+ # is specified.
1002
+ # @param [String] page_token
1003
+ # A token identifying a page of results the server should return.
1004
+ # Typically, this is the value of
1005
+ # next_page_token returned
1006
+ # from the previous call to `ListInsertionOrders` method. If not specified,
1007
+ # the first page of results will be returned.
1008
+ # @param [String] fields
1009
+ # Selector specifying which fields to include in a partial response.
1010
+ # @param [String] quota_user
1011
+ # Available to use for quota purposes for server-side applications. Can be any
1012
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1013
+ # @param [Google::Apis::RequestOptions] options
1014
+ # Request-specific options
1015
+ #
1016
+ # @yield [result, err] Result & error if block supplied
1017
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse] parsed result object
1018
+ # @yieldparam err [StandardError] error object if request failed
1019
+ #
1020
+ # @return [Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse]
1021
+ #
1022
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1023
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1024
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1025
+ def list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1026
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders', options)
1027
+ command.response_representation = Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse::Representation
1028
+ command.response_class = Google::Apis::DisplayvideoV1::ListInsertionOrdersResponse
1029
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1030
+ command.query['filter'] = filter unless filter.nil?
1031
+ command.query['orderBy'] = order_by unless order_by.nil?
1032
+ command.query['pageSize'] = page_size unless page_size.nil?
1033
+ command.query['pageToken'] = page_token unless page_token.nil?
1034
+ command.query['fields'] = fields unless fields.nil?
1035
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1036
+ execute_or_queue_command(command, &block)
1037
+ end
1038
+
1039
+ # Updates an existing insertion order.
1040
+ # Returns the updated insertion order if successful.
1041
+ # @param [Fixnum] advertiser_id
1042
+ # Output only. The unique ID of the advertiser the insertion order belongs to.
1043
+ # @param [Fixnum] insertion_order_id
1044
+ # Output only. The unique ID of the insertion order. Assigned by the system.
1045
+ # @param [Google::Apis::DisplayvideoV1::InsertionOrder] insertion_order_object
1046
+ # @param [String] update_mask
1047
+ # Required. The mask to control which fields to update.
1048
+ # @param [String] fields
1049
+ # Selector specifying which fields to include in a partial response.
1050
+ # @param [String] quota_user
1051
+ # Available to use for quota purposes for server-side applications. Can be any
1052
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1053
+ # @param [Google::Apis::RequestOptions] options
1054
+ # Request-specific options
1055
+ #
1056
+ # @yield [result, err] Result & error if block supplied
1057
+ # @yieldparam result [Google::Apis::DisplayvideoV1::InsertionOrder] parsed result object
1058
+ # @yieldparam err [StandardError] error object if request failed
1059
+ #
1060
+ # @return [Google::Apis::DisplayvideoV1::InsertionOrder]
1061
+ #
1062
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1063
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1064
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1065
+ def patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1066
+ command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
1067
+ command.request_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
1068
+ command.request_object = insertion_order_object
1069
+ command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
1070
+ command.response_class = Google::Apis::DisplayvideoV1::InsertionOrder
1071
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1072
+ command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
1073
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1074
+ command.query['fields'] = fields unless fields.nil?
1075
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1076
+ execute_or_queue_command(command, &block)
1077
+ end
1078
+
1079
+ # Bulk edits targeting options under a single line item.
1080
+ # The operation will delete the assigned targeting options provided in
1081
+ # BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and
1082
+ # then create the assigned targeting options provided in
1083
+ # BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .
1084
+ # @param [Fixnum] advertiser_id
1085
+ # Required. The ID of the advertiser the line item belongs to.
1086
+ # @param [Fixnum] line_item_id
1087
+ # Required. The ID of the line item the assigned targeting option will belong to.
1088
+ # @param [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsRequest] bulk_edit_line_item_assigned_targeting_options_request_object
1089
+ # @param [String] fields
1090
+ # Selector specifying which fields to include in a partial response.
1091
+ # @param [String] quota_user
1092
+ # Available to use for quota purposes for server-side applications. Can be any
1093
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1094
+ # @param [Google::Apis::RequestOptions] options
1095
+ # Request-specific options
1096
+ #
1097
+ # @yield [result, err] Result & error if block supplied
1098
+ # @yieldparam result [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse] parsed result object
1099
+ # @yieldparam err [StandardError] error object if request failed
1100
+ #
1101
+ # @return [Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse]
1102
+ #
1103
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1104
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1105
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1106
+ def bulk_edit_line_item_assigned_targeting_options(advertiser_id, line_item_id, bulk_edit_line_item_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1107
+ command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkEditLineItemAssignedTargetingOptions', options)
1108
+ command.request_representation = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsRequest::Representation
1109
+ command.request_object = bulk_edit_line_item_assigned_targeting_options_request_object
1110
+ command.response_representation = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse::Representation
1111
+ command.response_class = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse
1112
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1113
+ command.params['lineItemId'] = line_item_id unless line_item_id.nil?
1114
+ command.query['fields'] = fields unless fields.nil?
1115
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1116
+ execute_or_queue_command(command, &block)
1117
+ end
1118
+
1119
+ # Lists assigned targeting options of a line item across targeting types.
1120
+ # @param [Fixnum] advertiser_id
1121
+ # Required. The ID of the advertiser the line item belongs to.
1122
+ # @param [Fixnum] line_item_id
1123
+ # Required. The ID of the line item to list assigned targeting options for.
1124
+ # @param [String] filter
1125
+ # Allows filtering by assigned targeting option properties.
1126
+ # Supported syntax:
1127
+ # * Filter expressions are made up of one or more restrictions.
1128
+ # * Restrictions can be combined by the logical operator `OR` on the same
1129
+ # field.
1130
+ # * A restriction has the form of ``field` `operator` `value``.
1131
+ # * The operator must be `EQUALS (=)`.
1132
+ # * Supported fields:
1133
+ # - `targetingType`
1134
+ # - `inheritance`
1135
+ # Examples:
1136
+ # * AssignedTargetingOptions of targeting type
1137
+ # TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL
1138
+ # `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR
1139
+ # targetingType="TARGETING_TYPE_CHANNEL"`
1140
+ # * AssignedTargetingOptions with inheritance status of NOT_INHERITED or
1141
+ # INHERITED_FROM_PARTNER
1142
+ # `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"`
1143
+ # The length of this field should be no more than 500 characters.
1144
+ # @param [String] order_by
1145
+ # Field by which to sort the list.
1146
+ # Acceptable values are:
1147
+ # * `targetingType` (default)
1148
+ # The default sorting order is ascending. To specify descending order for
1149
+ # a field, a suffix "desc" should be added to the field name. Example:
1150
+ # `targetingType desc`.
1151
+ # @param [Fixnum] page_size
1152
+ # Requested page size.
1153
+ # The size must be an integer between `1` and `5000`. If unspecified,
1154
+ # the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid
1155
+ # value is specified.
1156
+ # @param [String] page_token
1157
+ # A token that lets the client fetch the next page of results.
1158
+ # Typically, this is the value of
1159
+ # next_page_token
1160
+ # returned from the previous call to
1161
+ # `BulkListLineItemAssignedTargetingOptions` method.
1162
+ # If not specified, the first page of results will be returned.
1163
+ # @param [String] fields
1164
+ # Selector specifying which fields to include in a partial response.
1165
+ # @param [String] quota_user
1166
+ # Available to use for quota purposes for server-side applications. Can be any
1167
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1168
+ # @param [Google::Apis::RequestOptions] options
1169
+ # Request-specific options
1170
+ #
1171
+ # @yield [result, err] Result & error if block supplied
1172
+ # @yieldparam result [Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse] parsed result object
1173
+ # @yieldparam err [StandardError] error object if request failed
1174
+ #
1175
+ # @return [Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse]
1176
+ #
1177
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1178
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1179
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1180
+ def bulk_advertiser_line_item_list_line_item_assigned_targeting_options(advertiser_id, line_item_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1181
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkListLineItemAssignedTargetingOptions', options)
1182
+ command.response_representation = Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse::Representation
1183
+ command.response_class = Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse
1184
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1185
+ command.params['lineItemId'] = line_item_id unless line_item_id.nil?
1186
+ command.query['filter'] = filter unless filter.nil?
1187
+ command.query['orderBy'] = order_by unless order_by.nil?
1188
+ command.query['pageSize'] = page_size unless page_size.nil?
1189
+ command.query['pageToken'] = page_token unless page_token.nil?
1190
+ command.query['fields'] = fields unless fields.nil?
1191
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1192
+ execute_or_queue_command(command, &block)
1193
+ end
1194
+
1195
+ # Creates a new line item.
1196
+ # Returns the newly created line item if successful.
1197
+ # @param [Fixnum] advertiser_id
1198
+ # Output only. The unique ID of the advertiser the line item belongs to.
1199
+ # @param [Google::Apis::DisplayvideoV1::LineItem] line_item_object
1200
+ # @param [String] fields
1201
+ # Selector specifying which fields to include in a partial response.
1202
+ # @param [String] quota_user
1203
+ # Available to use for quota purposes for server-side applications. Can be any
1204
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1205
+ # @param [Google::Apis::RequestOptions] options
1206
+ # Request-specific options
1207
+ #
1208
+ # @yield [result, err] Result & error if block supplied
1209
+ # @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
1210
+ # @yieldparam err [StandardError] error object if request failed
1211
+ #
1212
+ # @return [Google::Apis::DisplayvideoV1::LineItem]
1213
+ #
1214
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1215
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1216
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1217
+ def create_advertiser_line_item(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1218
+ command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems', options)
1219
+ command.request_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
1220
+ command.request_object = line_item_object
1221
+ command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
1222
+ command.response_class = Google::Apis::DisplayvideoV1::LineItem
1223
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1224
+ command.query['fields'] = fields unless fields.nil?
1225
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1226
+ execute_or_queue_command(command, &block)
1227
+ end
1228
+
1229
+ # Deletes a line item.
1230
+ # Returns error code `NOT_FOUND` if the line item does not exist.
1231
+ # The line item should be archived first, i.e. set
1232
+ # entity_status to `ENTITY_STATUS_ARCHIVED`, to be
1233
+ # able to delete it.
1234
+ # @param [Fixnum] advertiser_id
1235
+ # The ID of the advertiser this line item belongs to.
1236
+ # @param [Fixnum] line_item_id
1237
+ # The ID of the line item we need to fetch.
1238
+ # @param [String] fields
1239
+ # Selector specifying which fields to include in a partial response.
1240
+ # @param [String] quota_user
1241
+ # Available to use for quota purposes for server-side applications. Can be any
1242
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1243
+ # @param [Google::Apis::RequestOptions] options
1244
+ # Request-specific options
1245
+ #
1246
+ # @yield [result, err] Result & error if block supplied
1247
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
1248
+ # @yieldparam err [StandardError] error object if request failed
1249
+ #
1250
+ # @return [Google::Apis::DisplayvideoV1::Empty]
1251
+ #
1252
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1253
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1254
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1255
+ def delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
1256
+ command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
1257
+ command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
1258
+ command.response_class = Google::Apis::DisplayvideoV1::Empty
1259
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1260
+ command.params['lineItemId'] = line_item_id unless line_item_id.nil?
1261
+ command.query['fields'] = fields unless fields.nil?
1262
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1263
+ execute_or_queue_command(command, &block)
1264
+ end
1265
+
1266
+ # Gets a line item.
1267
+ # @param [Fixnum] advertiser_id
1268
+ # Required. The ID of the advertiser this line item belongs to.
1269
+ # @param [Fixnum] line_item_id
1270
+ # Required. The ID of the line item to fetch.
1271
+ # @param [String] fields
1272
+ # Selector specifying which fields to include in a partial response.
1273
+ # @param [String] quota_user
1274
+ # Available to use for quota purposes for server-side applications. Can be any
1275
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1276
+ # @param [Google::Apis::RequestOptions] options
1277
+ # Request-specific options
1278
+ #
1279
+ # @yield [result, err] Result & error if block supplied
1280
+ # @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
1281
+ # @yieldparam err [StandardError] error object if request failed
1282
+ #
1283
+ # @return [Google::Apis::DisplayvideoV1::LineItem]
1284
+ #
1285
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1286
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1287
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1288
+ def get_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
1289
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
1290
+ command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
1291
+ command.response_class = Google::Apis::DisplayvideoV1::LineItem
1292
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1293
+ command.params['lineItemId'] = line_item_id unless line_item_id.nil?
1294
+ command.query['fields'] = fields unless fields.nil?
1295
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1296
+ execute_or_queue_command(command, &block)
1297
+ end
1298
+
1299
+ # Lists line items in an advertiser.
1300
+ # The order is defined by the order_by
1301
+ # parameter.
1302
+ # If a filter by
1303
+ # entity_status is not specified, line items with
1304
+ # `ENTITY_STATUS_ARCHIVED` will not be included in the results.
1305
+ # @param [Fixnum] advertiser_id
1306
+ # Required. The ID of the advertiser to list line items for.
1307
+ # @param [String] filter
1308
+ # Allows filtering by line item properties.
1309
+ # Supported syntax:
1310
+ # * Filter expressions are made up of one or more restrictions.
1311
+ # * Restrictions can be combined by `AND` or `OR` logical operators. A
1312
+ # sequence of restrictions implicitly uses `AND`.
1313
+ # * A restriction has the form of ``field` `operator` `value``.
1314
+ # * The operator must be `EQUALS (=)`.
1315
+ # * Supported fields:
1316
+ # - `campaignId`
1317
+ # - `insertionOrderId`
1318
+ # - `entityStatus`
1319
+ # - `lineItemType`.
1320
+ # Examples:
1321
+ # * All line items under an insertion order: `insertionOrderId="1234"`
1322
+ # * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`
1323
+ # and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser:
1324
+ # `(entityStatus="ENTITY_STATUS_ACTIVE" OR
1325
+ # entityStatus="ENTITY_STATUS_PAUSED") AND
1326
+ # lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"`
1327
+ # The length of this field should be no more than 500 characters.
1328
+ # @param [String] order_by
1329
+ # Field by which to sort the list.
1330
+ # Acceptable values are:
1331
+ # * "displayName" (default)
1332
+ # * "entityStatus"
1333
+ # The default sorting order is ascending. To specify descending order for
1334
+ # a field, a suffix "desc" should be added to the field name. Example:
1335
+ # `displayName desc`.
1336
+ # @param [Fixnum] page_size
1337
+ # Requested page size. Must be between `1` and `100`. If unspecified will
1338
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
1339
+ # is specified.
1340
+ # @param [String] page_token
1341
+ # A token identifying a page of results the server should return.
1342
+ # Typically, this is the value of
1343
+ # next_page_token
1344
+ # returned from the previous call to `ListLineItems` method.
1345
+ # If not specified, the first page of results will be returned.
1346
+ # @param [String] fields
1347
+ # Selector specifying which fields to include in a partial response.
1348
+ # @param [String] quota_user
1349
+ # Available to use for quota purposes for server-side applications. Can be any
1350
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1351
+ # @param [Google::Apis::RequestOptions] options
1352
+ # Request-specific options
1353
+ #
1354
+ # @yield [result, err] Result & error if block supplied
1355
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListLineItemsResponse] parsed result object
1356
+ # @yieldparam err [StandardError] error object if request failed
1357
+ #
1358
+ # @return [Google::Apis::DisplayvideoV1::ListLineItemsResponse]
1359
+ #
1360
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1361
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1362
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1363
+ def list_advertiser_line_items(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1364
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems', options)
1365
+ command.response_representation = Google::Apis::DisplayvideoV1::ListLineItemsResponse::Representation
1366
+ command.response_class = Google::Apis::DisplayvideoV1::ListLineItemsResponse
1367
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1368
+ command.query['filter'] = filter unless filter.nil?
1369
+ command.query['orderBy'] = order_by unless order_by.nil?
1370
+ command.query['pageSize'] = page_size unless page_size.nil?
1371
+ command.query['pageToken'] = page_token unless page_token.nil?
1372
+ command.query['fields'] = fields unless fields.nil?
1373
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1374
+ execute_or_queue_command(command, &block)
1375
+ end
1376
+
1377
+ # Updates an existing line item.
1378
+ # Returns the updated line item if successful.
1379
+ # @param [Fixnum] advertiser_id
1380
+ # Output only. The unique ID of the advertiser the line item belongs to.
1381
+ # @param [Fixnum] line_item_id
1382
+ # Output only. The unique ID of the line item. Assigned by the system.
1383
+ # @param [Google::Apis::DisplayvideoV1::LineItem] line_item_object
1384
+ # @param [String] update_mask
1385
+ # Required. The mask to control which fields to update.
1386
+ # @param [String] fields
1387
+ # Selector specifying which fields to include in a partial response.
1388
+ # @param [String] quota_user
1389
+ # Available to use for quota purposes for server-side applications. Can be any
1390
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1391
+ # @param [Google::Apis::RequestOptions] options
1392
+ # Request-specific options
1393
+ #
1394
+ # @yield [result, err] Result & error if block supplied
1395
+ # @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
1396
+ # @yieldparam err [StandardError] error object if request failed
1397
+ #
1398
+ # @return [Google::Apis::DisplayvideoV1::LineItem]
1399
+ #
1400
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1401
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1402
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1403
+ def patch_advertiser_line_item(advertiser_id, line_item_id, line_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1404
+ command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
1405
+ command.request_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
1406
+ command.request_object = line_item_object
1407
+ command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
1408
+ command.response_class = Google::Apis::DisplayvideoV1::LineItem
1409
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1410
+ command.params['lineItemId'] = line_item_id unless line_item_id.nil?
1411
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1412
+ command.query['fields'] = fields unless fields.nil?
1413
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1414
+ execute_or_queue_command(command, &block)
1415
+ end
1416
+
1417
+ # Assigns a targeting option to a line item.
1418
+ # Returns the assigned targeting option if successful.
1419
+ # @param [Fixnum] advertiser_id
1420
+ # Required. The ID of the advertiser the line item belongs to.
1421
+ # @param [Fixnum] line_item_id
1422
+ # Required. The ID of the line item the assigned targeting option will belong to.
1423
+ # @param [String] targeting_type
1424
+ # Required. Identifies the type of this assigned targeting option.
1425
+ # @param [Google::Apis::DisplayvideoV1::AssignedTargetingOption] assigned_targeting_option_object
1426
+ # @param [String] fields
1427
+ # Selector specifying which fields to include in a partial response.
1428
+ # @param [String] quota_user
1429
+ # Available to use for quota purposes for server-side applications. Can be any
1430
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1431
+ # @param [Google::Apis::RequestOptions] options
1432
+ # Request-specific options
1433
+ #
1434
+ # @yield [result, err] Result & error if block supplied
1435
+ # @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
1436
+ # @yieldparam err [StandardError] error object if request failed
1437
+ #
1438
+ # @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
1439
+ #
1440
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1441
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1442
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1443
+ def create_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1444
+ command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
1445
+ command.request_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
1446
+ command.request_object = assigned_targeting_option_object
1447
+ command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
1448
+ command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
1449
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1450
+ command.params['lineItemId'] = line_item_id unless line_item_id.nil?
1451
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
1452
+ command.query['fields'] = fields unless fields.nil?
1453
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1454
+ execute_or_queue_command(command, &block)
1455
+ end
1456
+
1457
+ # Deletes an assigned targeting option from a line item.
1458
+ # @param [Fixnum] advertiser_id
1459
+ # Required. The ID of the advertiser the line item belongs to.
1460
+ # @param [Fixnum] line_item_id
1461
+ # Required. The ID of the line item the assigned targeting option belongs to.
1462
+ # @param [String] targeting_type
1463
+ # Required. Identifies the type of this assigned targeting option.
1464
+ # @param [String] assigned_targeting_option_id
1465
+ # Required. The ID of the assigned targeting option to delete.
1466
+ # @param [String] fields
1467
+ # Selector specifying which fields to include in a partial response.
1468
+ # @param [String] quota_user
1469
+ # Available to use for quota purposes for server-side applications. Can be any
1470
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1471
+ # @param [Google::Apis::RequestOptions] options
1472
+ # Request-specific options
1473
+ #
1474
+ # @yield [result, err] Result & error if block supplied
1475
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Empty] parsed result object
1476
+ # @yieldparam err [StandardError] error object if request failed
1477
+ #
1478
+ # @return [Google::Apis::DisplayvideoV1::Empty]
1479
+ #
1480
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1481
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1482
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1483
+ def delete_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
1484
+ command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
1485
+ command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation
1486
+ command.response_class = Google::Apis::DisplayvideoV1::Empty
1487
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1488
+ command.params['lineItemId'] = line_item_id unless line_item_id.nil?
1489
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
1490
+ command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
1491
+ command.query['fields'] = fields unless fields.nil?
1492
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1493
+ execute_or_queue_command(command, &block)
1494
+ end
1495
+
1496
+ # Gets a single targeting option assigned to a line item.
1497
+ # @param [Fixnum] advertiser_id
1498
+ # Required. The ID of the advertiser the line item belongs to.
1499
+ # @param [Fixnum] line_item_id
1500
+ # Required. The ID of the line item the assigned targeting option belongs to.
1501
+ # @param [String] targeting_type
1502
+ # Required. Identifies the type of this assigned targeting option.
1503
+ # @param [String] assigned_targeting_option_id
1504
+ # Required. An identifier unique to the targeting type in this line item that
1505
+ # identifies the assigned targeting option being requested.
1506
+ # @param [String] fields
1507
+ # Selector specifying which fields to include in a partial response.
1508
+ # @param [String] quota_user
1509
+ # Available to use for quota purposes for server-side applications. Can be any
1510
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1511
+ # @param [Google::Apis::RequestOptions] options
1512
+ # Request-specific options
1513
+ #
1514
+ # @yield [result, err] Result & error if block supplied
1515
+ # @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
1516
+ # @yieldparam err [StandardError] error object if request failed
1517
+ #
1518
+ # @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
1519
+ #
1520
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1521
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1522
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1523
+ def get_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
1524
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
1525
+ command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
1526
+ command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
1527
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1528
+ command.params['lineItemId'] = line_item_id unless line_item_id.nil?
1529
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
1530
+ command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
1531
+ command.query['fields'] = fields unless fields.nil?
1532
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1533
+ execute_or_queue_command(command, &block)
1534
+ end
1535
+
1536
+ # Lists the targeting options assigned to a line item.
1537
+ # @param [Fixnum] advertiser_id
1538
+ # Required. The ID of the advertiser the line item belongs to.
1539
+ # @param [Fixnum] line_item_id
1540
+ # Required. The ID of the line item to list assigned targeting options for.
1541
+ # @param [String] targeting_type
1542
+ # Required. Identifies the type of assigned targeting options to list.
1543
+ # @param [String] filter
1544
+ # Allows filtering by assigned targeting option properties.
1545
+ # Supported syntax:
1546
+ # * Filter expressions are made up of one or more restrictions.
1547
+ # * Restrictions can be combined by the logical operator `OR`.
1548
+ # * A restriction has the form of ``field` `operator` `value``.
1549
+ # * The operator must be `EQUALS (=)`.
1550
+ # * Supported fields:
1551
+ # - `assignedTargetingOptionId`
1552
+ # - `inheritance`
1553
+ # Examples:
1554
+ # * AssignedTargetingOptions with ID 1 or 2
1555
+ # `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"`
1556
+ # * AssignedTargetingOptions with inheritance status of NOT_INHERITED or
1557
+ # INHERITED_FROM_PARTNER
1558
+ # `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"`
1559
+ # The length of this field should be no more than 500 characters.
1560
+ # @param [String] order_by
1561
+ # Field by which to sort the list.
1562
+ # Acceptable values are:
1563
+ # * `assignedTargetingOptionId` (default)
1564
+ # The default sorting order is ascending. To specify descending order for
1565
+ # a field, a suffix "desc" should be added to the field name. Example:
1566
+ # `assignedTargetingOptionId desc`.
1567
+ # @param [Fixnum] page_size
1568
+ # Requested page size. Must be between `1` and `100`. If unspecified will
1569
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
1570
+ # is specified.
1571
+ # @param [String] page_token
1572
+ # A token identifying a page of results the server should return.
1573
+ # Typically, this is the value of
1574
+ # next_page_token
1575
+ # returned from the previous call to `ListLineItemAssignedTargetingOptions`
1576
+ # method. If not specified, the first page of results will be returned.
1577
+ # @param [String] fields
1578
+ # Selector specifying which fields to include in a partial response.
1579
+ # @param [String] quota_user
1580
+ # Available to use for quota purposes for server-side applications. Can be any
1581
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1582
+ # @param [Google::Apis::RequestOptions] options
1583
+ # Request-specific options
1584
+ #
1585
+ # @yield [result, err] Result & error if block supplied
1586
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse] parsed result object
1587
+ # @yieldparam err [StandardError] error object if request failed
1588
+ #
1589
+ # @return [Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse]
1590
+ #
1591
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1592
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1593
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1594
+ def list_advertiser_line_item_targeting_type_assigned_targeting_options(advertiser_id, line_item_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1595
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
1596
+ command.response_representation = Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse::Representation
1597
+ command.response_class = Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse
1598
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1599
+ command.params['lineItemId'] = line_item_id unless line_item_id.nil?
1600
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
1601
+ command.query['filter'] = filter unless filter.nil?
1602
+ command.query['orderBy'] = order_by unless order_by.nil?
1603
+ command.query['pageSize'] = page_size unless page_size.nil?
1604
+ command.query['pageToken'] = page_token unless page_token.nil?
1605
+ command.query['fields'] = fields unless fields.nil?
1606
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1607
+ execute_or_queue_command(command, &block)
1608
+ end
1609
+
1610
+ # Gets a location list.
1611
+ # @param [Fixnum] advertiser_id
1612
+ # Required. The ID of the DV360 advertiser to which the fetched location list
1613
+ # belongs.
1614
+ # @param [Fixnum] location_list_id
1615
+ # Required. The ID of the location list to fetch.
1616
+ # @param [String] fields
1617
+ # Selector specifying which fields to include in a partial response.
1618
+ # @param [String] quota_user
1619
+ # Available to use for quota purposes for server-side applications. Can be any
1620
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1621
+ # @param [Google::Apis::RequestOptions] options
1622
+ # Request-specific options
1623
+ #
1624
+ # @yield [result, err] Result & error if block supplied
1625
+ # @yieldparam result [Google::Apis::DisplayvideoV1::LocationList] parsed result object
1626
+ # @yieldparam err [StandardError] error object if request failed
1627
+ #
1628
+ # @return [Google::Apis::DisplayvideoV1::LocationList]
1629
+ #
1630
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1631
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1632
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1633
+ def get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil, &block)
1634
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/locationLists/{+locationListId}', options)
1635
+ command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
1636
+ command.response_class = Google::Apis::DisplayvideoV1::LocationList
1637
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1638
+ command.params['locationListId'] = location_list_id unless location_list_id.nil?
1639
+ command.query['fields'] = fields unless fields.nil?
1640
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1641
+ execute_or_queue_command(command, &block)
1642
+ end
1643
+
1644
+ # Lists location lists based on a given advertiser id.
1645
+ # @param [Fixnum] advertiser_id
1646
+ # Required. The ID of the DV360 advertiser to which the fetched location lists
1647
+ # belong.
1648
+ # @param [String] filter
1649
+ # Allows filtering by location list fields.
1650
+ # Supported syntax:
1651
+ # * Filter expressions are made up of one or more restrictions.
1652
+ # * Restrictions can be combined by `AND` or `OR` logical operators. A
1653
+ # sequence of restrictions implicitly uses `AND`.
1654
+ # * A restriction has the form of ``field` `operator` `value``.
1655
+ # * The operator must be `EQUALS (=)`.
1656
+ # * Supported fields:
1657
+ # - `locationType`
1658
+ # Examples:
1659
+ # * All regional location list:
1660
+ # `locationType="TARGETING_LOCATION_TYPE_REGIONAL"`
1661
+ # * All proximity location list:
1662
+ # `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"`
1663
+ # @param [String] order_by
1664
+ # Field by which to sort the list.
1665
+ # Acceptable values are:
1666
+ # * `locationListId` (default)
1667
+ # * `displayName`
1668
+ # The default sorting order is ascending. To specify descending order for
1669
+ # a field, a suffix "desc" should be added to the field name. Example:
1670
+ # `displayName desc`.
1671
+ # @param [Fixnum] page_size
1672
+ # Requested page size. Must be between `1` and `100`.
1673
+ # Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an
1674
+ # invalid value is specified.
1675
+ # @param [String] page_token
1676
+ # A token identifying a page of results the server should return.
1677
+ # Typically, this is the value of
1678
+ # next_page_token
1679
+ # returned from the previous call to `ListLocationLists` method.
1680
+ # If not specified, the first page of results will be returned.
1681
+ # @param [String] fields
1682
+ # Selector specifying which fields to include in a partial response.
1683
+ # @param [String] quota_user
1684
+ # Available to use for quota purposes for server-side applications. Can be any
1685
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1686
+ # @param [Google::Apis::RequestOptions] options
1687
+ # Request-specific options
1688
+ #
1689
+ # @yield [result, err] Result & error if block supplied
1690
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListLocationListsResponse] parsed result object
1691
+ # @yieldparam err [StandardError] error object if request failed
1692
+ #
1693
+ # @return [Google::Apis::DisplayvideoV1::ListLocationListsResponse]
1694
+ #
1695
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1696
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1697
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1698
+ def list_advertiser_location_lists(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1699
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/locationLists', options)
1700
+ command.response_representation = Google::Apis::DisplayvideoV1::ListLocationListsResponse::Representation
1701
+ command.response_class = Google::Apis::DisplayvideoV1::ListLocationListsResponse
1702
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1703
+ command.query['filter'] = filter unless filter.nil?
1704
+ command.query['orderBy'] = order_by unless order_by.nil?
1705
+ command.query['pageSize'] = page_size unless page_size.nil?
1706
+ command.query['pageToken'] = page_token unless page_token.nil?
1707
+ command.query['fields'] = fields unless fields.nil?
1708
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1709
+ execute_or_queue_command(command, &block)
1710
+ end
1711
+
1712
+ # Gets a negative keyword list given an advertiser ID and a negative keyword
1713
+ # list ID.
1714
+ # @param [Fixnum] advertiser_id
1715
+ # Required. The ID of the DV360 advertiser to which the fetched negative keyword
1716
+ # list
1717
+ # belongs.
1718
+ # @param [Fixnum] negative_keyword_list_id
1719
+ # Required. The ID of the negative keyword list to fetch.
1720
+ # @param [String] fields
1721
+ # Selector specifying which fields to include in a partial response.
1722
+ # @param [String] quota_user
1723
+ # Available to use for quota purposes for server-side applications. Can be any
1724
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1725
+ # @param [Google::Apis::RequestOptions] options
1726
+ # Request-specific options
1727
+ #
1728
+ # @yield [result, err] Result & error if block supplied
1729
+ # @yieldparam result [Google::Apis::DisplayvideoV1::NegativeKeywordList] parsed result object
1730
+ # @yieldparam err [StandardError] error object if request failed
1731
+ #
1732
+ # @return [Google::Apis::DisplayvideoV1::NegativeKeywordList]
1733
+ #
1734
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1735
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1736
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1737
+ def get_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil, &block)
1738
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
1739
+ command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation
1740
+ command.response_class = Google::Apis::DisplayvideoV1::NegativeKeywordList
1741
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1742
+ command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
1743
+ command.query['fields'] = fields unless fields.nil?
1744
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1745
+ execute_or_queue_command(command, &block)
1746
+ end
1747
+
1748
+ # Lists negative keyword lists based on a given advertiser id.
1749
+ # @param [Fixnum] advertiser_id
1750
+ # Required. The ID of the DV360 advertiser to which the fetched negative keyword
1751
+ # lists
1752
+ # belong.
1753
+ # @param [Fixnum] page_size
1754
+ # Requested page size. Must be between `1` and `100`.
1755
+ # Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an
1756
+ # invalid value is specified.
1757
+ # @param [String] page_token
1758
+ # A token identifying a page of results the server should return.
1759
+ # Typically, this is the value of
1760
+ # next_page_token
1761
+ # returned from the previous call to `ListNegativeKeywordLists` method.
1762
+ # If not specified, the first page of results will be returned.
1763
+ # @param [String] fields
1764
+ # Selector specifying which fields to include in a partial response.
1765
+ # @param [String] quota_user
1766
+ # Available to use for quota purposes for server-side applications. Can be any
1767
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1768
+ # @param [Google::Apis::RequestOptions] options
1769
+ # Request-specific options
1770
+ #
1771
+ # @yield [result, err] Result & error if block supplied
1772
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse] parsed result object
1773
+ # @yieldparam err [StandardError] error object if request failed
1774
+ #
1775
+ # @return [Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse]
1776
+ #
1777
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1778
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1779
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1780
+ def list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1781
+ command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/negativeKeywordLists', options)
1782
+ command.response_representation = Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse::Representation
1783
+ command.response_class = Google::Apis::DisplayvideoV1::ListNegativeKeywordListsResponse
1784
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1785
+ command.query['pageSize'] = page_size unless page_size.nil?
1786
+ command.query['pageToken'] = page_token unless page_token.nil?
1787
+ command.query['fields'] = fields unless fields.nil?
1788
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1789
+ execute_or_queue_command(command, &block)
1790
+ end
1791
+
1792
+ # Gets a combined audience.
1793
+ # @param [Fixnum] combined_audience_id
1794
+ # Required. The ID of the combined audience to fetch.
1795
+ # @param [Fixnum] advertiser_id
1796
+ # The ID of the advertiser that has access to the fetched combined
1797
+ # audience.
1798
+ # @param [Fixnum] partner_id
1799
+ # The ID of the partner that has access to the fetched combined audience.
1800
+ # @param [String] fields
1801
+ # Selector specifying which fields to include in a partial response.
1802
+ # @param [String] quota_user
1803
+ # Available to use for quota purposes for server-side applications. Can be any
1804
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1805
+ # @param [Google::Apis::RequestOptions] options
1806
+ # Request-specific options
1807
+ #
1808
+ # @yield [result, err] Result & error if block supplied
1809
+ # @yieldparam result [Google::Apis::DisplayvideoV1::CombinedAudience] parsed result object
1810
+ # @yieldparam err [StandardError] error object if request failed
1811
+ #
1812
+ # @return [Google::Apis::DisplayvideoV1::CombinedAudience]
1813
+ #
1814
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1815
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1816
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1817
+ def get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1818
+ command = make_simple_command(:get, 'v1/combinedAudiences/{+combinedAudienceId}', options)
1819
+ command.response_representation = Google::Apis::DisplayvideoV1::CombinedAudience::Representation
1820
+ command.response_class = Google::Apis::DisplayvideoV1::CombinedAudience
1821
+ command.params['combinedAudienceId'] = combined_audience_id unless combined_audience_id.nil?
1822
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
1823
+ command.query['partnerId'] = partner_id unless partner_id.nil?
1824
+ command.query['fields'] = fields unless fields.nil?
1825
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1826
+ execute_or_queue_command(command, &block)
1827
+ end
1828
+
1829
+ # Lists combined audiences.
1830
+ # The order is defined by the
1831
+ # order_by parameter.
1832
+ # @param [Fixnum] advertiser_id
1833
+ # The ID of the advertiser that has access to the fetched combined
1834
+ # audiences.
1835
+ # @param [String] filter
1836
+ # Allows filtering by combined audience fields.
1837
+ # Supported syntax:
1838
+ # * Filter expressions for combined audiences currently can only contain at
1839
+ # most one restriction.
1840
+ # * A restriction has the form of ``field` `operator` `value``.
1841
+ # * The operator must be `CONTAINS (:)`.
1842
+ # * Supported fields:
1843
+ # - `displayName`
1844
+ # Examples:
1845
+ # * All combined audiences for which the display name contains "Google":
1846
+ # `displayName : "Google"`.
1847
+ # The length of this field should be no more than 500 characters.
1848
+ # @param [String] order_by
1849
+ # Field by which to sort the list.
1850
+ # Acceptable values are:
1851
+ # * `combinedAudienceId` (default)
1852
+ # * `displayName`
1853
+ # The default sorting order is ascending. To specify descending order for
1854
+ # a field, a suffix "desc" should be added to the field name. Example:
1855
+ # `displayName desc`.
1856
+ # @param [Fixnum] page_size
1857
+ # Requested page size. Must be between `1` and `100`. If unspecified will
1858
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
1859
+ # is specified.
1860
+ # @param [String] page_token
1861
+ # A token identifying a page of results the server should return.
1862
+ # Typically, this is the value of
1863
+ # next_page_token
1864
+ # returned from the previous call to `ListCombinedAudiences` method.
1865
+ # If not specified, the first page of results will be returned.
1866
+ # @param [Fixnum] partner_id
1867
+ # The ID of the partner that has access to the fetched combined audiences.
1868
+ # @param [String] fields
1869
+ # Selector specifying which fields to include in a partial response.
1870
+ # @param [String] quota_user
1871
+ # Available to use for quota purposes for server-side applications. Can be any
1872
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1873
+ # @param [Google::Apis::RequestOptions] options
1874
+ # Request-specific options
1875
+ #
1876
+ # @yield [result, err] Result & error if block supplied
1877
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse] parsed result object
1878
+ # @yieldparam err [StandardError] error object if request failed
1879
+ #
1880
+ # @return [Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse]
1881
+ #
1882
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1883
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1884
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1885
+ def list_combined_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1886
+ command = make_simple_command(:get, 'v1/combinedAudiences', options)
1887
+ command.response_representation = Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse::Representation
1888
+ command.response_class = Google::Apis::DisplayvideoV1::ListCombinedAudiencesResponse
1889
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
1890
+ command.query['filter'] = filter unless filter.nil?
1891
+ command.query['orderBy'] = order_by unless order_by.nil?
1892
+ command.query['pageSize'] = page_size unless page_size.nil?
1893
+ command.query['pageToken'] = page_token unless page_token.nil?
1894
+ command.query['partnerId'] = partner_id unless partner_id.nil?
1895
+ command.query['fields'] = fields unless fields.nil?
1896
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1897
+ execute_or_queue_command(command, &block)
1898
+ end
1899
+
1900
+ # Gets a custom list.
1901
+ # @param [Fixnum] custom_list_id
1902
+ # Required. The ID of the custom list to fetch.
1903
+ # @param [Fixnum] advertiser_id
1904
+ # The ID of the DV360 advertiser that has access to the fetched custom
1905
+ # lists.
1906
+ # @param [String] fields
1907
+ # Selector specifying which fields to include in a partial response.
1908
+ # @param [String] quota_user
1909
+ # Available to use for quota purposes for server-side applications. Can be any
1910
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1911
+ # @param [Google::Apis::RequestOptions] options
1912
+ # Request-specific options
1913
+ #
1914
+ # @yield [result, err] Result & error if block supplied
1915
+ # @yieldparam result [Google::Apis::DisplayvideoV1::CustomList] parsed result object
1916
+ # @yieldparam err [StandardError] error object if request failed
1917
+ #
1918
+ # @return [Google::Apis::DisplayvideoV1::CustomList]
1919
+ #
1920
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1921
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1922
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1923
+ def get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1924
+ command = make_simple_command(:get, 'v1/customLists/{+customListId}', options)
1925
+ command.response_representation = Google::Apis::DisplayvideoV1::CustomList::Representation
1926
+ command.response_class = Google::Apis::DisplayvideoV1::CustomList
1927
+ command.params['customListId'] = custom_list_id unless custom_list_id.nil?
1928
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
1929
+ command.query['fields'] = fields unless fields.nil?
1930
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1931
+ execute_or_queue_command(command, &block)
1932
+ end
1933
+
1934
+ # Lists custom lists.
1935
+ # The order is defined by the order_by
1936
+ # parameter.
1937
+ # @param [Fixnum] advertiser_id
1938
+ # The ID of the DV360 advertiser that has access to the fetched custom
1939
+ # lists.
1940
+ # @param [String] filter
1941
+ # Allows filtering by custom list fields.
1942
+ # Supported syntax:
1943
+ # * Filter expressions for custom lists currently can only contain at
1944
+ # most one restriction.
1945
+ # * A restriction has the form of ``field` `operator` `value``.
1946
+ # * The operator must be `CONTAINS (:)`.
1947
+ # * Supported fields:
1948
+ # - `displayName`
1949
+ # Examples:
1950
+ # * All custom lists for which the display name contains "Google":
1951
+ # `displayName : "Google"`.
1952
+ # The length of this field should be no more than 500 characters.
1953
+ # @param [String] order_by
1954
+ # Field by which to sort the list.
1955
+ # Acceptable values are:
1956
+ # * `customListId` (default)
1957
+ # * `displayName`
1958
+ # The default sorting order is ascending. To specify descending order for
1959
+ # a field, a suffix "desc" should be added to the field name. Example:
1960
+ # `displayName desc`.
1961
+ # @param [Fixnum] page_size
1962
+ # Requested page size. Must be between `1` and `100`. If unspecified will
1963
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
1964
+ # is specified.
1965
+ # @param [String] page_token
1966
+ # A token identifying a page of results the server should return.
1967
+ # Typically, this is the value of
1968
+ # next_page_token
1969
+ # returned from the previous call to `ListCustomLists` method.
1970
+ # If not specified, the first page of results will be returned.
1971
+ # @param [String] fields
1972
+ # Selector specifying which fields to include in a partial response.
1973
+ # @param [String] quota_user
1974
+ # Available to use for quota purposes for server-side applications. Can be any
1975
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1976
+ # @param [Google::Apis::RequestOptions] options
1977
+ # Request-specific options
1978
+ #
1979
+ # @yield [result, err] Result & error if block supplied
1980
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListCustomListsResponse] parsed result object
1981
+ # @yieldparam err [StandardError] error object if request failed
1982
+ #
1983
+ # @return [Google::Apis::DisplayvideoV1::ListCustomListsResponse]
1984
+ #
1985
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1986
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1987
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1988
+ def list_custom_lists(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1989
+ command = make_simple_command(:get, 'v1/customLists', options)
1990
+ command.response_representation = Google::Apis::DisplayvideoV1::ListCustomListsResponse::Representation
1991
+ command.response_class = Google::Apis::DisplayvideoV1::ListCustomListsResponse
1992
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
1993
+ command.query['filter'] = filter unless filter.nil?
1994
+ command.query['orderBy'] = order_by unless order_by.nil?
1995
+ command.query['pageSize'] = page_size unless page_size.nil?
1996
+ command.query['pageToken'] = page_token unless page_token.nil?
1997
+ command.query['fields'] = fields unless fields.nil?
1998
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1999
+ execute_or_queue_command(command, &block)
2000
+ end
2001
+
2002
+ # Gets a first and third party audience.
2003
+ # @param [Fixnum] first_and_third_party_audience_id
2004
+ # Required. The ID of the first and third party audience to fetch.
2005
+ # @param [Fixnum] advertiser_id
2006
+ # The ID of the advertiser that has access to the fetched first and
2007
+ # third party audience.
2008
+ # @param [Fixnum] partner_id
2009
+ # The ID of the partner that has access to the fetched first and
2010
+ # third party audience.
2011
+ # @param [String] fields
2012
+ # Selector specifying which fields to include in a partial response.
2013
+ # @param [String] quota_user
2014
+ # Available to use for quota purposes for server-side applications. Can be any
2015
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2016
+ # @param [Google::Apis::RequestOptions] options
2017
+ # Request-specific options
2018
+ #
2019
+ # @yield [result, err] Result & error if block supplied
2020
+ # @yieldparam result [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience] parsed result object
2021
+ # @yieldparam err [StandardError] error object if request failed
2022
+ #
2023
+ # @return [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience]
2024
+ #
2025
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2026
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2027
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2028
+ def get_first_and_third_party_audience(first_and_third_party_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2029
+ command = make_simple_command(:get, 'v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
2030
+ command.response_representation = Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience::Representation
2031
+ command.response_class = Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience
2032
+ command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_audience_id.nil?
2033
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2034
+ command.query['partnerId'] = partner_id unless partner_id.nil?
2035
+ command.query['fields'] = fields unless fields.nil?
2036
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2037
+ execute_or_queue_command(command, &block)
2038
+ end
2039
+
2040
+ # Lists first and third party audiences.
2041
+ # The order is defined by the
2042
+ # order_by parameter.
2043
+ # @param [Fixnum] advertiser_id
2044
+ # The ID of the advertiser that has access to the fetched first and
2045
+ # third party audiences.
2046
+ # @param [String] filter
2047
+ # Allows filtering by first and third party audience fields.
2048
+ # Supported syntax:
2049
+ # * Filter expressions for first and third party audiences currently can
2050
+ # only contain at most one restriction.
2051
+ # * A restriction has the form of ``field` `operator` `value``.
2052
+ # * The operator must be `CONTAINS (:)`.
2053
+ # * Supported fields:
2054
+ # - `displayName`
2055
+ # Examples:
2056
+ # * All first and third party audiences for which the display name contains
2057
+ # "Google": `displayName : "Google"`.
2058
+ # The length of this field should be no more than 500 characters.
2059
+ # @param [String] order_by
2060
+ # Field by which to sort the list.
2061
+ # Acceptable values are:
2062
+ # * `firstAndThirdPartyAudienceId` (default)
2063
+ # * `displayName`
2064
+ # The default sorting order is ascending. To specify descending order for
2065
+ # a field, a suffix "desc" should be added to the field name. Example:
2066
+ # `displayName desc`.
2067
+ # @param [Fixnum] page_size
2068
+ # Requested page size. Must be between `1` and `100`. If unspecified will
2069
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
2070
+ # is specified.
2071
+ # @param [String] page_token
2072
+ # A token identifying a page of results the server should return.
2073
+ # Typically, this is the value of
2074
+ # next_page_token
2075
+ # returned from the previous call to `ListFirstAndThirdPartyAudiences`
2076
+ # method. If not specified, the first page of results will be returned.
2077
+ # @param [Fixnum] partner_id
2078
+ # The ID of the partner that has access to the fetched first and
2079
+ # third party audiences.
2080
+ # @param [String] fields
2081
+ # Selector specifying which fields to include in a partial response.
2082
+ # @param [String] quota_user
2083
+ # Available to use for quota purposes for server-side applications. Can be any
2084
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2085
+ # @param [Google::Apis::RequestOptions] options
2086
+ # Request-specific options
2087
+ #
2088
+ # @yield [result, err] Result & error if block supplied
2089
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse] parsed result object
2090
+ # @yieldparam err [StandardError] error object if request failed
2091
+ #
2092
+ # @return [Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse]
2093
+ #
2094
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2095
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2096
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2097
+ def list_first_and_third_party_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2098
+ command = make_simple_command(:get, 'v1/firstAndThirdPartyAudiences', options)
2099
+ command.response_representation = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse::Representation
2100
+ command.response_class = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse
2101
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2102
+ command.query['filter'] = filter unless filter.nil?
2103
+ command.query['orderBy'] = order_by unless order_by.nil?
2104
+ command.query['pageSize'] = page_size unless page_size.nil?
2105
+ command.query['pageToken'] = page_token unless page_token.nil?
2106
+ command.query['partnerId'] = partner_id unless partner_id.nil?
2107
+ command.query['fields'] = fields unless fields.nil?
2108
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2109
+ execute_or_queue_command(command, &block)
2110
+ end
2111
+
2112
+ # Gets a Floodlight group.
2113
+ # @param [Fixnum] floodlight_group_id
2114
+ # Required. The ID of the Floodlight group to fetch.
2115
+ # @param [Fixnum] partner_id
2116
+ # Required. The partner context by which the Floodlight group is being accessed.
2117
+ # @param [String] fields
2118
+ # Selector specifying which fields to include in a partial response.
2119
+ # @param [String] quota_user
2120
+ # Available to use for quota purposes for server-side applications. Can be any
2121
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2122
+ # @param [Google::Apis::RequestOptions] options
2123
+ # Request-specific options
2124
+ #
2125
+ # @yield [result, err] Result & error if block supplied
2126
+ # @yieldparam result [Google::Apis::DisplayvideoV1::FloodlightGroup] parsed result object
2127
+ # @yieldparam err [StandardError] error object if request failed
2128
+ #
2129
+ # @return [Google::Apis::DisplayvideoV1::FloodlightGroup]
2130
+ #
2131
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2132
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2133
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2134
+ def get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2135
+ command = make_simple_command(:get, 'v1/floodlightGroups/{+floodlightGroupId}', options)
2136
+ command.response_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
2137
+ command.response_class = Google::Apis::DisplayvideoV1::FloodlightGroup
2138
+ command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
2139
+ command.query['partnerId'] = partner_id unless partner_id.nil?
2140
+ command.query['fields'] = fields unless fields.nil?
2141
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2142
+ execute_or_queue_command(command, &block)
2143
+ end
2144
+
2145
+ # Updates an existing Floodlight group.
2146
+ # Returns the updated Floodlight group if successful.
2147
+ # @param [Fixnum] floodlight_group_id
2148
+ # Output only. The unique ID of the Floodlight group. Assigned by the system.
2149
+ # @param [Google::Apis::DisplayvideoV1::FloodlightGroup] floodlight_group_object
2150
+ # @param [Fixnum] partner_id
2151
+ # Required. The partner context by which the Floodlight group is being accessed.
2152
+ # @param [String] update_mask
2153
+ # Required. The mask to control which fields to update.
2154
+ # @param [String] fields
2155
+ # Selector specifying which fields to include in a partial response.
2156
+ # @param [String] quota_user
2157
+ # Available to use for quota purposes for server-side applications. Can be any
2158
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2159
+ # @param [Google::Apis::RequestOptions] options
2160
+ # Request-specific options
2161
+ #
2162
+ # @yield [result, err] Result & error if block supplied
2163
+ # @yieldparam result [Google::Apis::DisplayvideoV1::FloodlightGroup] parsed result object
2164
+ # @yieldparam err [StandardError] error object if request failed
2165
+ #
2166
+ # @return [Google::Apis::DisplayvideoV1::FloodlightGroup]
2167
+ #
2168
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2169
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2170
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2171
+ def patch_floodlight_group(floodlight_group_id, floodlight_group_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2172
+ command = make_simple_command(:patch, 'v1/floodlightGroups/{floodlightGroupId}', options)
2173
+ command.request_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
2174
+ command.request_object = floodlight_group_object
2175
+ command.response_representation = Google::Apis::DisplayvideoV1::FloodlightGroup::Representation
2176
+ command.response_class = Google::Apis::DisplayvideoV1::FloodlightGroup
2177
+ command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
2178
+ command.query['partnerId'] = partner_id unless partner_id.nil?
2179
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2180
+ command.query['fields'] = fields unless fields.nil?
2181
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2182
+ execute_or_queue_command(command, &block)
2183
+ end
2184
+
2185
+ # Gets a Google audience.
2186
+ # @param [Fixnum] google_audience_id
2187
+ # Required. The ID of the Google audience to fetch.
2188
+ # @param [Fixnum] advertiser_id
2189
+ # The ID of the advertiser that has access to the fetched Google audience.
2190
+ # @param [Fixnum] partner_id
2191
+ # The ID of the partner that has access to the fetched Google audience.
2192
+ # @param [String] fields
2193
+ # Selector specifying which fields to include in a partial response.
2194
+ # @param [String] quota_user
2195
+ # Available to use for quota purposes for server-side applications. Can be any
2196
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2197
+ # @param [Google::Apis::RequestOptions] options
2198
+ # Request-specific options
2199
+ #
2200
+ # @yield [result, err] Result & error if block supplied
2201
+ # @yieldparam result [Google::Apis::DisplayvideoV1::GoogleAudience] parsed result object
2202
+ # @yieldparam err [StandardError] error object if request failed
2203
+ #
2204
+ # @return [Google::Apis::DisplayvideoV1::GoogleAudience]
2205
+ #
2206
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2207
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2208
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2209
+ def get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2210
+ command = make_simple_command(:get, 'v1/googleAudiences/{+googleAudienceId}', options)
2211
+ command.response_representation = Google::Apis::DisplayvideoV1::GoogleAudience::Representation
2212
+ command.response_class = Google::Apis::DisplayvideoV1::GoogleAudience
2213
+ command.params['googleAudienceId'] = google_audience_id unless google_audience_id.nil?
2214
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2215
+ command.query['partnerId'] = partner_id unless partner_id.nil?
2216
+ command.query['fields'] = fields unless fields.nil?
2217
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2218
+ execute_or_queue_command(command, &block)
2219
+ end
2220
+
2221
+ # Lists Google audiences.
2222
+ # The order is defined by the order_by
2223
+ # parameter.
2224
+ # @param [Fixnum] advertiser_id
2225
+ # The ID of the advertiser that has access to the fetched Google audiences.
2226
+ # @param [String] filter
2227
+ # Allows filtering by Google audience fields.
2228
+ # Supported syntax:
2229
+ # * Filter expressions for Google audiences currently can only contain at
2230
+ # most one restriction.
2231
+ # * A restriction has the form of ``field` `operator` `value``.
2232
+ # * The operator must be `CONTAINS (:)`.
2233
+ # * Supported fields:
2234
+ # - `displayName`
2235
+ # Examples:
2236
+ # * All Google audiences for which the display name contains "Google":
2237
+ # `displayName : "Google"`.
2238
+ # The length of this field should be no more than 500 characters.
2239
+ # @param [String] order_by
2240
+ # Field by which to sort the list.
2241
+ # Acceptable values are:
2242
+ # * `googleAudienceId` (default)
2243
+ # * `displayName`
2244
+ # The default sorting order is ascending. To specify descending order for
2245
+ # a field, a suffix "desc" should be added to the field name. Example:
2246
+ # `displayName desc`.
2247
+ # @param [Fixnum] page_size
2248
+ # Requested page size. Must be between `1` and `100`. If unspecified will
2249
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
2250
+ # is specified.
2251
+ # @param [String] page_token
2252
+ # A token identifying a page of results the server should return.
2253
+ # Typically, this is the value of
2254
+ # next_page_token
2255
+ # returned from the previous call to `ListGoogleAudiences` method.
2256
+ # If not specified, the first page of results will be returned.
2257
+ # @param [Fixnum] partner_id
2258
+ # The ID of the partner that has access to the fetched Google audiences.
2259
+ # @param [String] fields
2260
+ # Selector specifying which fields to include in a partial response.
2261
+ # @param [String] quota_user
2262
+ # Available to use for quota purposes for server-side applications. Can be any
2263
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2264
+ # @param [Google::Apis::RequestOptions] options
2265
+ # Request-specific options
2266
+ #
2267
+ # @yield [result, err] Result & error if block supplied
2268
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse] parsed result object
2269
+ # @yieldparam err [StandardError] error object if request failed
2270
+ #
2271
+ # @return [Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse]
2272
+ #
2273
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2274
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2275
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2276
+ def list_google_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2277
+ command = make_simple_command(:get, 'v1/googleAudiences', options)
2278
+ command.response_representation = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse::Representation
2279
+ command.response_class = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse
2280
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2281
+ command.query['filter'] = filter unless filter.nil?
2282
+ command.query['orderBy'] = order_by unless order_by.nil?
2283
+ command.query['pageSize'] = page_size unless page_size.nil?
2284
+ command.query['pageToken'] = page_token unless page_token.nil?
2285
+ command.query['partnerId'] = partner_id unless partner_id.nil?
2286
+ command.query['fields'] = fields unless fields.nil?
2287
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2288
+ execute_or_queue_command(command, &block)
2289
+ end
2290
+
2291
+ # Gets an inventory source group.
2292
+ # @param [Fixnum] inventory_source_group_id
2293
+ # Required. The ID of the inventory source group to fetch.
2294
+ # @param [Fixnum] advertiser_id
2295
+ # The ID of the advertiser that has access to the inventory source group.
2296
+ # If an inventory source group is partner-owned, only advertisers to which
2297
+ # the group is explicitly shared can access the group.
2298
+ # @param [Fixnum] partner_id
2299
+ # The ID of the partner that has access to the inventory source group.
2300
+ # A partner cannot access an advertiser-owned inventory source group.
2301
+ # @param [String] fields
2302
+ # Selector specifying which fields to include in a partial response.
2303
+ # @param [String] quota_user
2304
+ # Available to use for quota purposes for server-side applications. Can be any
2305
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2306
+ # @param [Google::Apis::RequestOptions] options
2307
+ # Request-specific options
2308
+ #
2309
+ # @yield [result, err] Result & error if block supplied
2310
+ # @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceGroup] parsed result object
2311
+ # @yieldparam err [StandardError] error object if request failed
2312
+ #
2313
+ # @return [Google::Apis::DisplayvideoV1::InventorySourceGroup]
2314
+ #
2315
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2316
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2317
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2318
+ def get_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2319
+ command = make_simple_command(:get, 'v1/inventorySourceGroups/{+inventorySourceGroupId}', options)
2320
+ command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation
2321
+ command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup
2322
+ command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
2323
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2324
+ command.query['partnerId'] = partner_id unless partner_id.nil?
2325
+ command.query['fields'] = fields unless fields.nil?
2326
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2327
+ execute_or_queue_command(command, &block)
2328
+ end
2329
+
2330
+ # Lists inventory source groups that are accessible to the current user.
2331
+ # The order is defined by the
2332
+ # order_by parameter.
2333
+ # @param [Fixnum] advertiser_id
2334
+ # The ID of the advertiser that has access to the inventory source group.
2335
+ # If an inventory source group is partner-owned, only advertisers to which
2336
+ # the group is explicitly shared can access the group.
2337
+ # @param [String] filter
2338
+ # Allows filtering by inventory source group properties.
2339
+ # Supported syntax:
2340
+ # * Filter expressions are made up of one or more restrictions.
2341
+ # * Restrictions can be combined by the logical operator `OR`.
2342
+ # * A restriction has the form of ``field` `operator` `value``.
2343
+ # * The operator must be `EQUALS (=)`.
2344
+ # * Supported fields:
2345
+ # - `inventorySourceGroupId`
2346
+ # The length of this field should be no more than 500 characters.
2347
+ # @param [String] order_by
2348
+ # Field by which to sort the list.
2349
+ # Acceptable values are:
2350
+ # * `displayName` (default)
2351
+ # * `inventorySourceGroupId`
2352
+ # The default sorting order is ascending. To specify descending order for
2353
+ # a field, a suffix "desc" should be added to the field name. For example,
2354
+ # `displayName desc`.
2355
+ # @param [Fixnum] page_size
2356
+ # Requested page size. Must be between `1` and `100`. If unspecified will
2357
+ # default to `100`.
2358
+ # @param [String] page_token
2359
+ # A token identifying a page of results the server should return.
2360
+ # Typically, this is the value of
2361
+ # next_page_token
2362
+ # returned from the previous call to `ListInventorySources` method.
2363
+ # If not specified, the first page of results will be returned.
2364
+ # @param [Fixnum] partner_id
2365
+ # The ID of the partner that has access to the inventory source group.
2366
+ # A partner cannot access advertiser-owned inventory source groups.
2367
+ # @param [String] fields
2368
+ # Selector specifying which fields to include in a partial response.
2369
+ # @param [String] quota_user
2370
+ # Available to use for quota purposes for server-side applications. Can be any
2371
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2372
+ # @param [Google::Apis::RequestOptions] options
2373
+ # Request-specific options
2374
+ #
2375
+ # @yield [result, err] Result & error if block supplied
2376
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse] parsed result object
2377
+ # @yieldparam err [StandardError] error object if request failed
2378
+ #
2379
+ # @return [Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse]
2380
+ #
2381
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2382
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2383
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2384
+ def list_inventory_source_groups(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2385
+ command = make_simple_command(:get, 'v1/inventorySourceGroups', options)
2386
+ command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse::Representation
2387
+ command.response_class = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse
2388
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2389
+ command.query['filter'] = filter unless filter.nil?
2390
+ command.query['orderBy'] = order_by unless order_by.nil?
2391
+ command.query['pageSize'] = page_size unless page_size.nil?
2392
+ command.query['pageToken'] = page_token unless page_token.nil?
2393
+ command.query['partnerId'] = partner_id unless partner_id.nil?
2394
+ command.query['fields'] = fields unless fields.nil?
2395
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2396
+ execute_or_queue_command(command, &block)
2397
+ end
2398
+
2399
+ # Gets an inventory source.
2400
+ # @param [Fixnum] inventory_source_id
2401
+ # Required. The ID of the inventory source to fetch.
2402
+ # @param [Fixnum] partner_id
2403
+ # Required. The ID of the DV360 partner to which the fetched inventory source
2404
+ # is permissioned.
2405
+ # @param [String] fields
2406
+ # Selector specifying which fields to include in a partial response.
2407
+ # @param [String] quota_user
2408
+ # Available to use for quota purposes for server-side applications. Can be any
2409
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2410
+ # @param [Google::Apis::RequestOptions] options
2411
+ # Request-specific options
2412
+ #
2413
+ # @yield [result, err] Result & error if block supplied
2414
+ # @yieldparam result [Google::Apis::DisplayvideoV1::InventorySource] parsed result object
2415
+ # @yieldparam err [StandardError] error object if request failed
2416
+ #
2417
+ # @return [Google::Apis::DisplayvideoV1::InventorySource]
2418
+ #
2419
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2420
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2421
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2422
+ def get_inventory_source(inventory_source_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2423
+ command = make_simple_command(:get, 'v1/inventorySources/{+inventorySourceId}', options)
2424
+ command.response_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
2425
+ command.response_class = Google::Apis::DisplayvideoV1::InventorySource
2426
+ command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
2427
+ command.query['partnerId'] = partner_id unless partner_id.nil?
2428
+ command.query['fields'] = fields unless fields.nil?
2429
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2430
+ execute_or_queue_command(command, &block)
2431
+ end
2432
+
2433
+ # Lists inventory sources that are accessible to the current user.
2434
+ # The order is defined by the
2435
+ # order_by parameter.
2436
+ # If a filter by
2437
+ # entity_status is not
2438
+ # specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED`
2439
+ # will not be included in the results.
2440
+ # @param [Fixnum] advertiser_id
2441
+ # The ID of the advertiser that has access to the inventory source.
2442
+ # @param [String] filter
2443
+ # Allows filtering by inventory source properties.
2444
+ # Supported syntax:
2445
+ # * Filter expressions are made up of one or more restrictions.
2446
+ # * Restrictions can be combined by `AND` or `OR` logical operators. A
2447
+ # sequence of restrictions implicitly uses `AND`.
2448
+ # * A restriction has the form of ``field` `operator` `value``.
2449
+ # * The operator must be `EQUALS (=)`.
2450
+ # * Supported fields:
2451
+ # - `status.entityStatus`
2452
+ # - `commitment`
2453
+ # - `deliveryMethod`
2454
+ # - `rateDetails.rateType`
2455
+ # - `exchange`
2456
+ # Examples:
2457
+ # * All active inventory sources:
2458
+ # `status.entityStatus="ENTITY_STATUS_ACTIVE"`
2459
+ # * Inventory sources belonging to Google Ad Manager or Rubicon exchanges:
2460
+ # `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"`
2461
+ # The length of this field should be no more than 500 characters.
2462
+ # @param [String] order_by
2463
+ # Field by which to sort the list.
2464
+ # Acceptable values are:
2465
+ # * `displayName` (default)
2466
+ # The default sorting order is ascending. To specify descending order for
2467
+ # a field, a suffix "desc" should be added to the field name. For example,
2468
+ # `displayName desc`.
2469
+ # @param [Fixnum] page_size
2470
+ # Requested page size. Must be between `1` and `100`. If unspecified will
2471
+ # default to `100`.
2472
+ # @param [String] page_token
2473
+ # A token identifying a page of results the server should return.
2474
+ # Typically, this is the value of
2475
+ # next_page_token
2476
+ # returned from the previous call to `ListInventorySources` method.
2477
+ # If not specified, the first page of results will be returned.
2478
+ # @param [Fixnum] partner_id
2479
+ # The ID of the partner that has access to the inventory source.
2480
+ # @param [String] fields
2481
+ # Selector specifying which fields to include in a partial response.
2482
+ # @param [String] quota_user
2483
+ # Available to use for quota purposes for server-side applications. Can be any
2484
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2485
+ # @param [Google::Apis::RequestOptions] options
2486
+ # Request-specific options
2487
+ #
2488
+ # @yield [result, err] Result & error if block supplied
2489
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListInventorySourcesResponse] parsed result object
2490
+ # @yieldparam err [StandardError] error object if request failed
2491
+ #
2492
+ # @return [Google::Apis::DisplayvideoV1::ListInventorySourcesResponse]
2493
+ #
2494
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2495
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2496
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2497
+ def list_inventory_sources(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2498
+ command = make_simple_command(:get, 'v1/inventorySources', options)
2499
+ command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourcesResponse::Representation
2500
+ command.response_class = Google::Apis::DisplayvideoV1::ListInventorySourcesResponse
2501
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2502
+ command.query['filter'] = filter unless filter.nil?
2503
+ command.query['orderBy'] = order_by unless order_by.nil?
2504
+ command.query['pageSize'] = page_size unless page_size.nil?
2505
+ command.query['pageToken'] = page_token unless page_token.nil?
2506
+ command.query['partnerId'] = partner_id unless partner_id.nil?
2507
+ command.query['fields'] = fields unless fields.nil?
2508
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2509
+ execute_or_queue_command(command, &block)
2510
+ end
2511
+
51
2512
  # Downloads media. Download is supported on the URI `/download/`resource_name=**`
52
2513
  # ?alt=media.`
53
2514
  # **Note**: Download requests will not be successful without including `alt=
@@ -89,6 +2550,110 @@ module Google
89
2550
  execute_or_queue_command(command, &block)
90
2551
  end
91
2552
 
2553
+ # Gets a channel for a partner or advertiser.
2554
+ # @param [Fixnum] partner_id
2555
+ # The ID of the partner that owns the fetched channel.
2556
+ # @param [Fixnum] channel_id
2557
+ # Required. The ID of the channel to fetch.
2558
+ # @param [Fixnum] advertiser_id
2559
+ # The ID of the advertiser that owns the fetched channel.
2560
+ # @param [String] fields
2561
+ # Selector specifying which fields to include in a partial response.
2562
+ # @param [String] quota_user
2563
+ # Available to use for quota purposes for server-side applications. Can be any
2564
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2565
+ # @param [Google::Apis::RequestOptions] options
2566
+ # Request-specific options
2567
+ #
2568
+ # @yield [result, err] Result & error if block supplied
2569
+ # @yieldparam result [Google::Apis::DisplayvideoV1::Channel] parsed result object
2570
+ # @yieldparam err [StandardError] error object if request failed
2571
+ #
2572
+ # @return [Google::Apis::DisplayvideoV1::Channel]
2573
+ #
2574
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2575
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2576
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2577
+ def get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2578
+ command = make_simple_command(:get, 'v1/partners/{+partnerId}/channels/{+channelId}', options)
2579
+ command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation
2580
+ command.response_class = Google::Apis::DisplayvideoV1::Channel
2581
+ command.params['partnerId'] = partner_id unless partner_id.nil?
2582
+ command.params['channelId'] = channel_id unless channel_id.nil?
2583
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2584
+ command.query['fields'] = fields unless fields.nil?
2585
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2586
+ execute_or_queue_command(command, &block)
2587
+ end
2588
+
2589
+ # Lists channels for a partner or advertiser.
2590
+ # @param [Fixnum] partner_id
2591
+ # The ID of the partner that owns the channels.
2592
+ # @param [Fixnum] advertiser_id
2593
+ # The ID of the advertiser that owns the channels.
2594
+ # @param [String] filter
2595
+ # Allows filtering by channel fields.
2596
+ # Supported syntax:
2597
+ # * Filter expressions for channel currently can only contain at most one
2598
+ # * restriction.
2599
+ # * A restriction has the form of ``field` `operator` `value``.
2600
+ # * The operator must be `CONTAINS (:)`.
2601
+ # * Supported fields:
2602
+ # - `displayName`
2603
+ # Examples:
2604
+ # * All channels for which the display name contains "google":
2605
+ # `displayName : "google"`.
2606
+ # The length of this field should be no more than 500 characters.
2607
+ # @param [String] order_by
2608
+ # Field by which to sort the list.
2609
+ # Acceptable values are:
2610
+ # * `displayName` (default)
2611
+ # * `channelId`
2612
+ # The default sorting order is ascending. To specify descending order for a
2613
+ # field, a suffix " desc" should be added to the field name. Example:
2614
+ # `displayName desc`.
2615
+ # @param [Fixnum] page_size
2616
+ # Requested page size. Must be between `1` and `100`. If unspecified will
2617
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
2618
+ # is specified.
2619
+ # @param [String] page_token
2620
+ # A token identifying a page of results the server should return.
2621
+ # Typically, this is the value of
2622
+ # next_page_token returned from the
2623
+ # previous call to `ListChannels` method. If not specified, the first page
2624
+ # of results will be returned.
2625
+ # @param [String] fields
2626
+ # Selector specifying which fields to include in a partial response.
2627
+ # @param [String] quota_user
2628
+ # Available to use for quota purposes for server-side applications. Can be any
2629
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2630
+ # @param [Google::Apis::RequestOptions] options
2631
+ # Request-specific options
2632
+ #
2633
+ # @yield [result, err] Result & error if block supplied
2634
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListChannelsResponse] parsed result object
2635
+ # @yieldparam err [StandardError] error object if request failed
2636
+ #
2637
+ # @return [Google::Apis::DisplayvideoV1::ListChannelsResponse]
2638
+ #
2639
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2640
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2641
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2642
+ def list_partner_channels(partner_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2643
+ command = make_simple_command(:get, 'v1/partners/{+partnerId}/channels', options)
2644
+ command.response_representation = Google::Apis::DisplayvideoV1::ListChannelsResponse::Representation
2645
+ command.response_class = Google::Apis::DisplayvideoV1::ListChannelsResponse
2646
+ command.params['partnerId'] = partner_id unless partner_id.nil?
2647
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2648
+ command.query['filter'] = filter unless filter.nil?
2649
+ command.query['orderBy'] = order_by unless order_by.nil?
2650
+ command.query['pageSize'] = page_size unless page_size.nil?
2651
+ command.query['pageToken'] = page_token unless page_token.nil?
2652
+ command.query['fields'] = fields unless fields.nil?
2653
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2654
+ execute_or_queue_command(command, &block)
2655
+ end
2656
+
92
2657
  # Creates an SDF Download Task. Returns an
93
2658
  # Operation.
94
2659
  # An SDF Download Task is a long-running, asynchronous operation. The
@@ -163,6 +2728,106 @@ module Google
163
2728
  command.query['quotaUser'] = quota_user unless quota_user.nil?
164
2729
  execute_or_queue_command(command, &block)
165
2730
  end
2731
+
2732
+ # Gets a single targeting option.
2733
+ # @param [String] targeting_type
2734
+ # Required. The type of targeting option to retrieve.
2735
+ # @param [String] targeting_option_id
2736
+ # Required. The ID of the of targeting option to retrieve.
2737
+ # @param [Fixnum] advertiser_id
2738
+ # Required. The Advertiser this request is being made in the context of.
2739
+ # @param [String] fields
2740
+ # Selector specifying which fields to include in a partial response.
2741
+ # @param [String] quota_user
2742
+ # Available to use for quota purposes for server-side applications. Can be any
2743
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2744
+ # @param [Google::Apis::RequestOptions] options
2745
+ # Request-specific options
2746
+ #
2747
+ # @yield [result, err] Result & error if block supplied
2748
+ # @yieldparam result [Google::Apis::DisplayvideoV1::TargetingOption] parsed result object
2749
+ # @yieldparam err [StandardError] error object if request failed
2750
+ #
2751
+ # @return [Google::Apis::DisplayvideoV1::TargetingOption]
2752
+ #
2753
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2754
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2755
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2756
+ def get_targeting_type_targeting_option(targeting_type, targeting_option_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2757
+ command = make_simple_command(:get, 'v1/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}', options)
2758
+ command.response_representation = Google::Apis::DisplayvideoV1::TargetingOption::Representation
2759
+ command.response_class = Google::Apis::DisplayvideoV1::TargetingOption
2760
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
2761
+ command.params['targetingOptionId'] = targeting_option_id unless targeting_option_id.nil?
2762
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2763
+ command.query['fields'] = fields unless fields.nil?
2764
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2765
+ execute_or_queue_command(command, &block)
2766
+ end
2767
+
2768
+ # Lists targeting options of a given type.
2769
+ # @param [String] targeting_type
2770
+ # Required. The type of targeting option to be listed.
2771
+ # @param [Fixnum] advertiser_id
2772
+ # Required. The Advertiser this request is being made in the context of.
2773
+ # @param [String] filter
2774
+ # Allows filtering by targeting option properties.
2775
+ # Supported syntax:
2776
+ # * Filter expressions are made up of one or more restrictions.
2777
+ # * Restrictions can be combined by `OR` logical operators.
2778
+ # * A restriction has the form of ``field` `operator` `value``.
2779
+ # * The operator must be "=" (equal sign).
2780
+ # * Supported fields:
2781
+ # - `targetingOptionId`
2782
+ # The length of this field should be no more than 500 characters.
2783
+ # @param [String] order_by
2784
+ # Field by which to sort the list.
2785
+ # Acceptable values are:
2786
+ # * `targetingOptionId` (default)
2787
+ # The default sorting order is ascending. To specify descending order for
2788
+ # a field, a suffix "desc" should be added to the field name.
2789
+ # Example: `targetingOptionId desc`.
2790
+ # @param [Fixnum] page_size
2791
+ # Requested page size. Must be between `1` and `100`. If unspecified will
2792
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
2793
+ # is specified.
2794
+ # @param [String] page_token
2795
+ # A token identifying a page of results the server should return.
2796
+ # Typically, this is the value of
2797
+ # next_page_token
2798
+ # returned from the previous call to `ListTargetingOptions` method.
2799
+ # If not specified, the first page of results will be returned.
2800
+ # @param [String] fields
2801
+ # Selector specifying which fields to include in a partial response.
2802
+ # @param [String] quota_user
2803
+ # Available to use for quota purposes for server-side applications. Can be any
2804
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2805
+ # @param [Google::Apis::RequestOptions] options
2806
+ # Request-specific options
2807
+ #
2808
+ # @yield [result, err] Result & error if block supplied
2809
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse] parsed result object
2810
+ # @yieldparam err [StandardError] error object if request failed
2811
+ #
2812
+ # @return [Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse]
2813
+ #
2814
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2815
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2816
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2817
+ def list_targeting_type_targeting_options(targeting_type, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2818
+ command = make_simple_command(:get, 'v1/targetingTypes/{+targetingType}/targetingOptions', options)
2819
+ command.response_representation = Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse::Representation
2820
+ command.response_class = Google::Apis::DisplayvideoV1::ListTargetingOptionsResponse
2821
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
2822
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
2823
+ command.query['filter'] = filter unless filter.nil?
2824
+ command.query['orderBy'] = order_by unless order_by.nil?
2825
+ command.query['pageSize'] = page_size unless page_size.nil?
2826
+ command.query['pageToken'] = page_token unless page_token.nil?
2827
+ command.query['fields'] = fields unless fields.nil?
2828
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2829
+ execute_or_queue_command(command, &block)
2830
+ end
166
2831
 
167
2832
  protected
168
2833