google-dfp-api 0.2.5 → 0.2.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (258) hide show
  1. data/ChangeLog +5 -0
  2. data/README +8 -7
  3. data/Rakefile +2 -2
  4. data/examples/v201111/common/error_handling.rb +76 -0
  5. data/examples/v201111/common/oauth_handling.rb +128 -0
  6. data/examples/v201111/company_service/create_companies.rb +81 -0
  7. data/examples/v201111/company_service/get_all_companies.rb +92 -0
  8. data/examples/v201111/company_service/get_companies_by_statement.rb +88 -0
  9. data/examples/v201111/company_service/get_company.rb +72 -0
  10. data/examples/v201111/company_service/update_companies.rb +95 -0
  11. data/examples/v201111/content_service/get_all_content.rb +94 -0
  12. data/examples/v201111/content_service/get_content_by_category.rb +136 -0
  13. data/examples/v201111/creative_service/copy_image_creatives.rb +115 -0
  14. data/examples/v201111/creative_service/create_creative_from_template.rb +139 -0
  15. data/examples/v201111/creative_service/create_creatives.rb +106 -0
  16. data/examples/v201111/creative_service/create_custom_creative.rb +104 -0
  17. data/examples/v201111/creative_service/get_all_creatives.rb +93 -0
  18. data/examples/v201111/creative_service/get_creative.rb +72 -0
  19. data/examples/v201111/creative_service/get_creatives_by_statement.rb +87 -0
  20. data/examples/v201111/creative_service/update_creatives.rb +96 -0
  21. data/examples/v201111/creative_template_service/get_all_creative_templates.rb +94 -0
  22. data/examples/v201111/creative_template_service/get_creative_template.rb +74 -0
  23. data/examples/v201111/creative_template_service/get_creative_templates_by_statement.rb +80 -0
  24. data/examples/v201111/custom_targeting_service/create_custom_targeting_keys_and_values.rb +140 -0
  25. data/examples/v201111/custom_targeting_service/delete_custom_targeting_keys.rb +121 -0
  26. data/examples/v201111/custom_targeting_service/delete_custom_targeting_values.rb +125 -0
  27. data/examples/v201111/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb +148 -0
  28. data/examples/v201111/custom_targeting_service/get_custom_targeting_keys_by_statement.rb +92 -0
  29. data/examples/v201111/custom_targeting_service/get_custom_targeting_values_by_statement.rb +98 -0
  30. data/examples/v201111/custom_targeting_service/update_custom_targeting_keys.rb +94 -0
  31. data/examples/v201111/custom_targeting_service/update_custom_targeting_values.rb +106 -0
  32. data/examples/v201111/forecast_service/get_forecast.rb +107 -0
  33. data/examples/v201111/forecast_service/get_forecast_by_id.rb +80 -0
  34. data/examples/v201111/inventory_service/create_ad_units.rb +101 -0
  35. data/examples/v201111/inventory_service/create_mobile_ad_unit.rb +100 -0
  36. data/examples/v201111/inventory_service/create_video_ad_unit.rb +108 -0
  37. data/examples/v201111/inventory_service/deactivate_ad_units.rb +119 -0
  38. data/examples/v201111/inventory_service/get_ad_unit.rb +72 -0
  39. data/examples/v201111/inventory_service/get_ad_unit_sizes.rb +73 -0
  40. data/examples/v201111/inventory_service/get_ad_units_by_statement.rb +96 -0
  41. data/examples/v201111/inventory_service/get_all_ad_units.rb +93 -0
  42. data/examples/v201111/inventory_service/update_ad_units.rb +94 -0
  43. data/examples/v201111/label_service/create_labels.rb +83 -0
  44. data/examples/v201111/label_service/deactivate_labels.rb +118 -0
  45. data/examples/v201111/label_service/get_all_labels.rb +94 -0
  46. data/examples/v201111/label_service/get_label.rb +76 -0
  47. data/examples/v201111/label_service/get_labels_by_statement.rb +91 -0
  48. data/examples/v201111/label_service/update_labels.rb +104 -0
  49. data/examples/v201111/line_item_creative_association_service/create_licas.rb +94 -0
  50. data/examples/v201111/line_item_creative_association_service/deactivate_licas.rb +127 -0
  51. data/examples/v201111/line_item_creative_association_service/get_all_licas.rb +95 -0
  52. data/examples/v201111/line_item_creative_association_service/get_lica.rb +77 -0
  53. data/examples/v201111/line_item_creative_association_service/get_licas_by_statement.rb +91 -0
  54. data/examples/v201111/line_item_creative_association_service/update_licas.rb +92 -0
  55. data/examples/v201111/line_item_service/activate_line_items.rb +131 -0
  56. data/examples/v201111/line_item_service/create_line_items.rb +177 -0
  57. data/examples/v201111/line_item_service/create_mobile_line_item.rb +135 -0
  58. data/examples/v201111/line_item_service/create_video_line_item.rb +156 -0
  59. data/examples/v201111/line_item_service/get_all_line_items.rb +94 -0
  60. data/examples/v201111/line_item_service/get_line_item.rb +74 -0
  61. data/examples/v201111/line_item_service/get_line_items_by_statement.rb +89 -0
  62. data/examples/v201111/line_item_service/target_custom_criteria.rb +129 -0
  63. data/examples/v201111/line_item_service/update_line_items.rb +109 -0
  64. data/examples/v201111/network_service/get_all_networks.rb +74 -0
  65. data/examples/v201111/network_service/get_current_network.rb +66 -0
  66. data/examples/v201111/order_service/approve_orders.rb +116 -0
  67. data/examples/v201111/order_service/create_orders.rb +92 -0
  68. data/examples/v201111/order_service/get_all_orders.rb +93 -0
  69. data/examples/v201111/order_service/get_order.rb +74 -0
  70. data/examples/v201111/order_service/get_orders_by_statement.rb +90 -0
  71. data/examples/v201111/order_service/update_orders.rb +95 -0
  72. data/examples/v201111/placement_service/create_placements.rb +129 -0
  73. data/examples/v201111/placement_service/deactivate_placements.rb +118 -0
  74. data/examples/v201111/placement_service/get_all_placements.rb +93 -0
  75. data/examples/v201111/placement_service/get_placement.rb +74 -0
  76. data/examples/v201111/placement_service/get_placements_by_statement.rb +86 -0
  77. data/examples/v201111/placement_service/update_placements.rb +97 -0
  78. data/examples/v201111/publisher_query_language_service/get_all_bandwidth_groups.rb +85 -0
  79. data/examples/v201111/publisher_query_language_service/get_all_browser_languages.rb +85 -0
  80. data/examples/v201111/publisher_query_language_service/get_all_browsers.rb +85 -0
  81. data/examples/v201111/publisher_query_language_service/get_all_cities.rb +85 -0
  82. data/examples/v201111/publisher_query_language_service/get_all_countries.rb +85 -0
  83. data/examples/v201111/publisher_query_language_service/get_all_device_manufacturers.rb +85 -0
  84. data/examples/v201111/publisher_query_language_service/get_all_metros.rb +85 -0
  85. data/examples/v201111/publisher_query_language_service/get_all_mobile_carriers.rb +85 -0
  86. data/examples/v201111/publisher_query_language_service/get_all_mobile_device_submodels.rb +85 -0
  87. data/examples/v201111/publisher_query_language_service/get_all_mobile_devices.rb +85 -0
  88. data/examples/v201111/publisher_query_language_service/get_all_operating_system_versions.rb +85 -0
  89. data/examples/v201111/publisher_query_language_service/get_all_operating_systems.rb +85 -0
  90. data/examples/v201111/publisher_query_language_service/get_all_postal_codes.rb +85 -0
  91. data/examples/v201111/publisher_query_language_service/get_all_regions.rb +85 -0
  92. data/examples/v201111/report_service/download_report.rb +81 -0
  93. data/examples/v201111/report_service/run_delivery_report.rb +91 -0
  94. data/examples/v201111/report_service/run_inventory_report.rb +90 -0
  95. data/examples/v201111/report_service/run_merged_delivery_report.rb +94 -0
  96. data/examples/v201111/report_service/run_sales_report.rb +89 -0
  97. data/examples/v201111/suggested_ad_unit_service/approve_suggested_ad_units.rb +116 -0
  98. data/examples/v201111/suggested_ad_unit_service/get_all_suggested_ad_units.rb +96 -0
  99. data/examples/v201111/suggested_ad_unit_service/get_suggested_ad_unit.rb +75 -0
  100. data/examples/v201111/suggested_ad_unit_service/get_suggested_ad_units_by_statement.rb +91 -0
  101. data/examples/v201111/user_service/create_users.rb +89 -0
  102. data/examples/v201111/user_service/deactivate_users.rb +99 -0
  103. data/examples/v201111/user_service/get_all_roles.rb +73 -0
  104. data/examples/v201111/user_service/get_all_users.rb +92 -0
  105. data/examples/v201111/user_service/get_current_user.rb +66 -0
  106. data/examples/v201111/user_service/get_user.rb +73 -0
  107. data/examples/v201111/user_service/get_users_by_statement.rb +79 -0
  108. data/examples/v201111/user_service/update_users.rb +89 -0
  109. data/lib/dfp_api.rb +1 -1
  110. data/lib/dfp_api/api_config.rb +15 -6
  111. data/lib/dfp_api/v201103/company_service.rb +5 -5
  112. data/lib/dfp_api/v201103/company_service_registry.rb +3 -3
  113. data/lib/dfp_api/v201103/creative_service.rb +9 -9
  114. data/lib/dfp_api/v201103/creative_service_registry.rb +3 -3
  115. data/lib/dfp_api/v201103/custom_targeting_service.rb +17 -17
  116. data/lib/dfp_api/v201103/custom_targeting_service_registry.rb +3 -3
  117. data/lib/dfp_api/v201103/forecast_service.rb +1 -1
  118. data/lib/dfp_api/v201103/forecast_service_registry.rb +3 -3
  119. data/lib/dfp_api/v201103/inventory_service.rb +9 -9
  120. data/lib/dfp_api/v201103/inventory_service_registry.rb +3 -3
  121. data/lib/dfp_api/v201103/line_item_creative_association_service.rb +13 -13
  122. data/lib/dfp_api/v201103/line_item_creative_association_service_registry.rb +3 -3
  123. data/lib/dfp_api/v201103/line_item_service.rb +5 -5
  124. data/lib/dfp_api/v201103/line_item_service_registry.rb +3 -3
  125. data/lib/dfp_api/v201103/network_service.rb +1 -1
  126. data/lib/dfp_api/v201103/network_service_registry.rb +3 -3
  127. data/lib/dfp_api/v201103/order_service.rb +13 -13
  128. data/lib/dfp_api/v201103/order_service_registry.rb +3 -3
  129. data/lib/dfp_api/v201103/placement_service.rb +5 -5
  130. data/lib/dfp_api/v201103/placement_service_registry.rb +3 -3
  131. data/lib/dfp_api/v201103/publisher_query_language_service.rb +1 -1
  132. data/lib/dfp_api/v201103/publisher_query_language_service_registry.rb +3 -3
  133. data/lib/dfp_api/v201103/report_service.rb +5 -5
  134. data/lib/dfp_api/v201103/report_service_registry.rb +3 -3
  135. data/lib/dfp_api/v201103/user_service.rb +13 -13
  136. data/lib/dfp_api/v201103/user_service_registry.rb +3 -3
  137. data/lib/dfp_api/v201104/company_service.rb +5 -5
  138. data/lib/dfp_api/v201104/company_service_registry.rb +3 -3
  139. data/lib/dfp_api/v201104/creative_service.rb +9 -9
  140. data/lib/dfp_api/v201104/creative_service_registry.rb +3 -3
  141. data/lib/dfp_api/v201104/custom_targeting_service.rb +17 -17
  142. data/lib/dfp_api/v201104/custom_targeting_service_registry.rb +3 -3
  143. data/lib/dfp_api/v201104/forecast_service.rb +1 -1
  144. data/lib/dfp_api/v201104/forecast_service_registry.rb +3 -3
  145. data/lib/dfp_api/v201104/inventory_service.rb +9 -9
  146. data/lib/dfp_api/v201104/inventory_service_registry.rb +3 -3
  147. data/lib/dfp_api/v201104/line_item_creative_association_service.rb +13 -13
  148. data/lib/dfp_api/v201104/line_item_creative_association_service_registry.rb +3 -3
  149. data/lib/dfp_api/v201104/line_item_service.rb +5 -5
  150. data/lib/dfp_api/v201104/line_item_service_registry.rb +3 -3
  151. data/lib/dfp_api/v201104/network_service.rb +1 -1
  152. data/lib/dfp_api/v201104/network_service_registry.rb +3 -3
  153. data/lib/dfp_api/v201104/order_service.rb +13 -13
  154. data/lib/dfp_api/v201104/order_service_registry.rb +3 -3
  155. data/lib/dfp_api/v201104/placement_service.rb +5 -5
  156. data/lib/dfp_api/v201104/placement_service_registry.rb +3 -3
  157. data/lib/dfp_api/v201104/publisher_query_language_service.rb +1 -1
  158. data/lib/dfp_api/v201104/publisher_query_language_service_registry.rb +3 -3
  159. data/lib/dfp_api/v201104/report_service.rb +5 -5
  160. data/lib/dfp_api/v201104/report_service_registry.rb +3 -3
  161. data/lib/dfp_api/v201104/user_service.rb +13 -13
  162. data/lib/dfp_api/v201104/user_service_registry.rb +3 -3
  163. data/lib/dfp_api/v201107/company_service.rb +5 -5
  164. data/lib/dfp_api/v201107/company_service_registry.rb +3 -3
  165. data/lib/dfp_api/v201107/creative_service.rb +9 -9
  166. data/lib/dfp_api/v201107/creative_service_registry.rb +3 -3
  167. data/lib/dfp_api/v201107/custom_targeting_service.rb +17 -17
  168. data/lib/dfp_api/v201107/custom_targeting_service_registry.rb +3 -3
  169. data/lib/dfp_api/v201107/forecast_service.rb +1 -1
  170. data/lib/dfp_api/v201107/forecast_service_registry.rb +3 -3
  171. data/lib/dfp_api/v201107/inventory_service.rb +9 -9
  172. data/lib/dfp_api/v201107/inventory_service_registry.rb +3 -3
  173. data/lib/dfp_api/v201107/label_service.rb +5 -5
  174. data/lib/dfp_api/v201107/label_service_registry.rb +3 -3
  175. data/lib/dfp_api/v201107/line_item_creative_association_service.rb +13 -13
  176. data/lib/dfp_api/v201107/line_item_creative_association_service_registry.rb +3 -3
  177. data/lib/dfp_api/v201107/line_item_service.rb +5 -5
  178. data/lib/dfp_api/v201107/line_item_service_registry.rb +3 -3
  179. data/lib/dfp_api/v201107/network_service.rb +1 -1
  180. data/lib/dfp_api/v201107/network_service_registry.rb +3 -3
  181. data/lib/dfp_api/v201107/order_service.rb +13 -13
  182. data/lib/dfp_api/v201107/order_service_registry.rb +3 -3
  183. data/lib/dfp_api/v201107/placement_service.rb +5 -5
  184. data/lib/dfp_api/v201107/placement_service_registry.rb +3 -3
  185. data/lib/dfp_api/v201107/publisher_query_language_service.rb +1 -1
  186. data/lib/dfp_api/v201107/publisher_query_language_service_registry.rb +3 -3
  187. data/lib/dfp_api/v201107/report_service.rb +5 -5
  188. data/lib/dfp_api/v201107/report_service_registry.rb +3 -3
  189. data/lib/dfp_api/v201107/user_service.rb +13 -13
  190. data/lib/dfp_api/v201107/user_service_registry.rb +3 -3
  191. data/lib/dfp_api/v201108/company_service.rb +5 -5
  192. data/lib/dfp_api/v201108/company_service_registry.rb +3 -3
  193. data/lib/dfp_api/v201108/creative_service.rb +9 -9
  194. data/lib/dfp_api/v201108/creative_service_registry.rb +3 -3
  195. data/lib/dfp_api/v201108/custom_targeting_service.rb +17 -17
  196. data/lib/dfp_api/v201108/custom_targeting_service_registry.rb +3 -3
  197. data/lib/dfp_api/v201108/forecast_service.rb +1 -1
  198. data/lib/dfp_api/v201108/forecast_service_registry.rb +3 -3
  199. data/lib/dfp_api/v201108/inventory_service.rb +9 -9
  200. data/lib/dfp_api/v201108/inventory_service_registry.rb +3 -3
  201. data/lib/dfp_api/v201108/label_service.rb +5 -5
  202. data/lib/dfp_api/v201108/label_service_registry.rb +3 -3
  203. data/lib/dfp_api/v201108/line_item_creative_association_service.rb +13 -13
  204. data/lib/dfp_api/v201108/line_item_creative_association_service_registry.rb +3 -3
  205. data/lib/dfp_api/v201108/line_item_service.rb +5 -5
  206. data/lib/dfp_api/v201108/line_item_service_registry.rb +3 -3
  207. data/lib/dfp_api/v201108/network_service.rb +1 -1
  208. data/lib/dfp_api/v201108/network_service_registry.rb +3 -3
  209. data/lib/dfp_api/v201108/order_service.rb +13 -13
  210. data/lib/dfp_api/v201108/order_service_registry.rb +3 -3
  211. data/lib/dfp_api/v201108/placement_service.rb +5 -5
  212. data/lib/dfp_api/v201108/placement_service_registry.rb +3 -3
  213. data/lib/dfp_api/v201108/publisher_query_language_service.rb +1 -1
  214. data/lib/dfp_api/v201108/publisher_query_language_service_registry.rb +3 -3
  215. data/lib/dfp_api/v201108/report_service.rb +5 -5
  216. data/lib/dfp_api/v201108/report_service_registry.rb +3 -3
  217. data/lib/dfp_api/v201108/third_party_slot_service.rb +5 -5
  218. data/lib/dfp_api/v201108/third_party_slot_service_registry.rb +3 -3
  219. data/lib/dfp_api/v201108/user_service.rb +13 -13
  220. data/lib/dfp_api/v201108/user_service_registry.rb +3 -3
  221. data/lib/dfp_api/v201111/company_service.rb +52 -0
  222. data/lib/dfp_api/v201111/company_service_registry.rb +44 -0
  223. data/lib/dfp_api/v201111/content_service.rb +40 -0
  224. data/lib/dfp_api/v201111/content_service_registry.rb +44 -0
  225. data/lib/dfp_api/v201111/creative_service.rb +52 -0
  226. data/lib/dfp_api/v201111/creative_service_registry.rb +44 -0
  227. data/lib/dfp_api/v201111/creative_template_service.rb +36 -0
  228. data/lib/dfp_api/v201111/creative_template_service_registry.rb +44 -0
  229. data/lib/dfp_api/v201111/custom_targeting_service.rb +60 -0
  230. data/lib/dfp_api/v201111/custom_targeting_service_registry.rb +44 -0
  231. data/lib/dfp_api/v201111/forecast_service.rb +36 -0
  232. data/lib/dfp_api/v201111/forecast_service_registry.rb +44 -0
  233. data/lib/dfp_api/v201111/inventory_service.rb +60 -0
  234. data/lib/dfp_api/v201111/inventory_service_registry.rb +44 -0
  235. data/lib/dfp_api/v201111/label_service.rb +56 -0
  236. data/lib/dfp_api/v201111/label_service_registry.rb +44 -0
  237. data/lib/dfp_api/v201111/line_item_creative_association_service.rb +60 -0
  238. data/lib/dfp_api/v201111/line_item_creative_association_service_registry.rb +44 -0
  239. data/lib/dfp_api/v201111/line_item_service.rb +56 -0
  240. data/lib/dfp_api/v201111/line_item_service_registry.rb +44 -0
  241. data/lib/dfp_api/v201111/network_service.rb +40 -0
  242. data/lib/dfp_api/v201111/network_service_registry.rb +44 -0
  243. data/lib/dfp_api/v201111/order_service.rb +56 -0
  244. data/lib/dfp_api/v201111/order_service_registry.rb +44 -0
  245. data/lib/dfp_api/v201111/placement_service.rb +56 -0
  246. data/lib/dfp_api/v201111/placement_service_registry.rb +44 -0
  247. data/lib/dfp_api/v201111/publisher_query_language_service.rb +32 -0
  248. data/lib/dfp_api/v201111/publisher_query_language_service_registry.rb +44 -0
  249. data/lib/dfp_api/v201111/report_service.rb +40 -0
  250. data/lib/dfp_api/v201111/report_service_registry.rb +44 -0
  251. data/lib/dfp_api/v201111/suggested_ad_unit_service.rb +40 -0
  252. data/lib/dfp_api/v201111/suggested_ad_unit_service_registry.rb +44 -0
  253. data/lib/dfp_api/v201111/third_party_slot_service.rb +44 -0
  254. data/lib/dfp_api/v201111/third_party_slot_service_registry.rb +44 -0
  255. data/lib/dfp_api/v201111/user_service.rb +64 -0
  256. data/lib/dfp_api/v201111/user_service_registry.rb +44 -0
  257. data/test/bugs/test_issue_00000016.rb +3 -3
  258. metadata +149 -8
@@ -0,0 +1,75 @@
1
+ #!/usr/bin/ruby
2
+ #
3
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
4
+ #
5
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
+ #
7
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
+ # implied.
17
+ # See the License for the specific language governing permissions and
18
+ # limitations under the License.
19
+ #
20
+ # This example gets a suggested ad unit by its ID. To determine which suggested
21
+ # ad units exist, run get_all_suggested_ad_units.rb.
22
+ #
23
+ # This feature is only available to DFP premium solution networks.
24
+ #
25
+ # Tags: SuggestedAdUnitService.getSuggestedAdUnit
26
+
27
+ require 'rubygems'
28
+ require 'dfp_api'
29
+
30
+ API_VERSION = :v201111
31
+
32
+ def get_suggested_ad_unit()
33
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
34
+ dfp = DfpApi::Api.new
35
+
36
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
+ # the configuration file or provide your own logger:
38
+ # dfp.logger = Logger.new('dfp_xml.log')
39
+
40
+ # Get the SuggestedAdUnitService.
41
+ suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
42
+
43
+ # Set the ID of the ad unit to get.
44
+ suggested_ad_unit_id = 'INSERT_SUGGESTED_AD_UNIT_ID_HERE'
45
+
46
+ # Get the suggested ad unit.
47
+ suggested_ad_unit =
48
+ suggested_ad_unit_service.get_suggested_ad_unit(suggested_ad_unit_id)
49
+
50
+ if suggested_ad_unit
51
+ puts "Suggested ad unit with ID: '%s' and number of requests: %d" %
52
+ [suggested_ad_unit[:id], suggested_ad_unit[:num_requests]]
53
+ end
54
+ end
55
+
56
+ if __FILE__ == $0
57
+ begin
58
+ get_suggested_ad_unit()
59
+
60
+ # HTTP errors.
61
+ rescue AdsCommon::Errors::HttpError => e
62
+ puts "HTTP Error: %s" % e
63
+
64
+ # API errors.
65
+ rescue DfpApi::Errors::ApiException => e
66
+ puts "Message: %s" % e.message
67
+ puts 'Errors:'
68
+ e.errors.each_with_index do |error, index|
69
+ puts "\tError [%d]:" % (index + 1)
70
+ error.each do |field, value|
71
+ puts "\t\t%s: %s" % [field, value]
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,91 @@
1
+ #!/usr/bin/ruby
2
+ #
3
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
4
+ #
5
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
+ #
7
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
+ # implied.
17
+ # See the License for the specific language governing permissions and
18
+ # limitations under the License.
19
+ #
20
+ # This example gets suggested ad units that have exactly 10 requests. The
21
+ # statement retrieves up to the maximum page size limit of 500.
22
+ #
23
+ # This feature is only available to DFP premium solution networks.
24
+ #
25
+ # Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
26
+
27
+ require 'rubygems'
28
+ require 'dfp_api'
29
+
30
+ API_VERSION = :v201111
31
+
32
+ def get_suggested_ad_units_by_statement()
33
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
34
+ dfp = DfpApi::Api.new
35
+
36
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
+ # the configuration file or provide your own logger:
38
+ # dfp.logger = Logger.new('dfp_xml.log')
39
+
40
+ # Get the SuggestedAdUnitService.
41
+ suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
42
+
43
+ # Create a statement to only select suggested ad units with exactly 10
44
+ # requests (with maximum limit of 500).
45
+ statement = {
46
+ :query => 'WHERE numRequests = :num_requests LIMIT 500',
47
+ :values => [
48
+ {:key => 'num_requests',
49
+ :value => {:value => 10,
50
+ :xsi_type => 'NumberValue'}}
51
+ ]
52
+ }
53
+
54
+ # Get ad units by statement.
55
+ page =
56
+ suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
57
+
58
+ if page[:results]
59
+ # Print details about each suggested ad unit in results.
60
+ page[:results].each_with_index do |ad_unit, index|
61
+ puts "%d) Suggested ad unit ID: '%s', number of requests: %d" %
62
+ [index, ad_unit[:id], ad_unit[:num_requests]]
63
+ end
64
+ end
65
+
66
+ # Print a footer.
67
+ if page.include?(:total_result_set_size)
68
+ puts "Total number of suggested ad units: %d" % page[:total_result_set_size]
69
+ end
70
+ end
71
+
72
+ if __FILE__ == $0
73
+ begin
74
+ get_suggested_ad_units_by_statement()
75
+
76
+ # HTTP errors.
77
+ rescue AdsCommon::Errors::HttpError => e
78
+ puts "HTTP Error: %s" % e
79
+
80
+ # API errors.
81
+ rescue DfpApi::Errors::ApiException => e
82
+ puts "Message: %s" % e.message
83
+ puts 'Errors:'
84
+ e.errors.each_with_index do |error, index|
85
+ puts "\tError [%d]:" % (index + 1)
86
+ error.each do |field, value|
87
+ puts "\t\t%s: %s" % [field, value]
88
+ end
89
+ end
90
+ end
91
+ end
@@ -0,0 +1,89 @@
1
+ #!/usr/bin/ruby
2
+ #
3
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
4
+ #
5
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
+ #
7
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
+ # implied.
17
+ # See the License for the specific language governing permissions and
18
+ # limitations under the License.
19
+ #
20
+ # This example creates new users. To determine which users exist, run
21
+ # get_all_users.rb. To determine which roles exist, run get_all_roles.rb.
22
+ #
23
+ # Tags: UserService.createUsers
24
+
25
+ require 'rubygems'
26
+ require 'dfp_api'
27
+
28
+ API_VERSION = :v201111
29
+
30
+ def create_users()
31
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
32
+ dfp = DfpApi::Api.new
33
+
34
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
35
+ # the configuration file or provide your own logger:
36
+ # dfp.logger = Logger.new('dfp_xml.log')
37
+
38
+ # Get the UserService.
39
+ user_service = dfp.service(:UserService, API_VERSION)
40
+
41
+ # Set the user's email addresses and names.
42
+ emails_and_names = [
43
+ {:name => 'INSERT_NAME_HERE',
44
+ :email => 'INSERT_EMAIL_ADDRESS_HERE'},
45
+ {:name => 'INSERT_NAME_HERE',
46
+ :email => 'INSERT_EMAIL_ADDRESS_HERE'}
47
+ ]
48
+
49
+ # Set the role ID for new users.
50
+ role_id = 'INSERT_ROLE_ID_HERE'.to_i
51
+
52
+ # Create an array to store local user objects.
53
+ users = emails_and_names.map do |email_and_name|
54
+ email_and_name.merge({:role_id => role_id, :preferred_locale => 'en_US'})
55
+ end
56
+
57
+ # Create the users on the server.
58
+ return_users = user_service.create_users(users)
59
+
60
+ if return_users
61
+ return_users.each do |user|
62
+ puts "User with ID: %d, name: %s and email: %s was created." %
63
+ [user[:id], user[:name], user[:email]]
64
+ end
65
+ else
66
+ raise 'No users were created.'
67
+ end
68
+ end
69
+
70
+ if __FILE__ == $0
71
+ begin
72
+ create_users()
73
+
74
+ # HTTP errors.
75
+ rescue AdsCommon::Errors::HttpError => e
76
+ puts "HTTP Error: %s" % e
77
+
78
+ # API errors.
79
+ rescue DfpApi::Errors::ApiException => e
80
+ puts "Message: %s" % e.message
81
+ puts 'Errors:'
82
+ e.errors.each_with_index do |error, index|
83
+ puts "\tError [%d]:" % (index + 1)
84
+ error.each do |field, value|
85
+ puts "\t\t%s: %s" % [field, value]
86
+ end
87
+ end
88
+ end
89
+ end
@@ -0,0 +1,99 @@
1
+ #!/usr/bin/ruby
2
+ #
3
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
4
+ #
5
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
+ #
7
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
+ # implied.
17
+ # See the License for the specific language governing permissions and
18
+ # limitations under the License.
19
+ #
20
+ # This example deactivates a user. Deactivated users can no longer make requests
21
+ # to the API. The user making the request cannot deactivate itself. To determine
22
+ # which users exist, run get_all_users.rb.
23
+ #
24
+ # Tags: UserService.getUsersByStatement,
25
+ # UserService.performUserAction
26
+
27
+ require 'rubygems'
28
+ require 'dfp_api'
29
+
30
+ API_VERSION = :v201111
31
+ PAGE_SIZE = 500
32
+
33
+ def deactivate_users()
34
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
35
+ dfp = DfpApi::Api.new
36
+
37
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
38
+ # the configuration file or provide your own logger:
39
+ # dfp.logger = Logger.new('dfp_xml.log')
40
+
41
+ # Get the UserService.
42
+ user_service = dfp.service(:UserService, API_VERSION)
43
+
44
+ # Set the ID of the user to deactivate
45
+ user_id = 'INSERT_USER_ID_HERE'
46
+
47
+ # Create filter text to select user by id.
48
+ statement = {
49
+ :query => 'WHERE id = :user_id',
50
+ :values => [
51
+ {:key => 'user_id',
52
+ :value => {:value => user_id, :xsi_type => 'NumberValue'}}
53
+ ]
54
+ }
55
+
56
+ # Get users by statement.
57
+ page = user_service.get_users_by_statement(statement)
58
+
59
+ if page[:results]
60
+ page[:results].each do |user|
61
+ puts "User ID: %d, name: %s and status: %s will be deactivated." %
62
+ [user[:id], user[:name], user[:status]]
63
+ end
64
+
65
+ # Perform action.
66
+ result = user_service.perform_user_action(
67
+ {:xsi_type => 'DeactivateUsers'}, statement)
68
+
69
+ # Display results.
70
+ if result and result[:num_changes] > 0
71
+ puts "Number of users deactivated: %d" % result[:num_changes]
72
+ else
73
+ puts 'No users were deactivated.'
74
+ end
75
+ else
76
+ puts 'No user found to deactivate.'
77
+ end
78
+ end
79
+
80
+ if __FILE__ == $0
81
+ begin
82
+ deactivate_users()
83
+
84
+ # HTTP errors.
85
+ rescue AdsCommon::Errors::HttpError => e
86
+ puts "HTTP Error: %s" % e
87
+
88
+ # API errors.
89
+ rescue DfpApi::Errors::ApiException => e
90
+ puts "Message: %s" % e.message
91
+ puts 'Errors:'
92
+ e.errors.each_with_index do |error, index|
93
+ puts "\tError [%d]:" % (index + 1)
94
+ error.each do |field, value|
95
+ puts "\t\t%s: %s" % [field, value]
96
+ end
97
+ end
98
+ end
99
+ end
@@ -0,0 +1,73 @@
1
+ #!/usr/bin/ruby
2
+ #
3
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
4
+ #
5
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
+ #
7
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
+ # implied.
17
+ # See the License for the specific language governing permissions and
18
+ # limitations under the License.
19
+ #
20
+ # This example gets all roles. This example can be used to determine which role
21
+ # ID is needed when getting and creating users.
22
+ #
23
+ # Tags: UserService.getAllRoles
24
+
25
+ require 'rubygems'
26
+ require 'dfp_api'
27
+
28
+ API_VERSION = :v201111
29
+
30
+ def get_all_roles()
31
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
32
+ dfp = DfpApi::Api.new
33
+
34
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
35
+ # the configuration file or provide your own logger:
36
+ # dfp.logger = Logger.new('dfp_xml.log')
37
+
38
+ # Get the UserService.
39
+ user_service = dfp.service(:UserService, API_VERSION)
40
+
41
+ # Get all roles.
42
+ roles = user_service.get_all_roles()
43
+
44
+ if roles
45
+ # Print details about each role in results page.
46
+ roles.each_with_index do |role, index|
47
+ puts "%d) Role ID: %d, name: %s" % [index, role[:id], role[:name]]
48
+ end
49
+ # Print a footer
50
+ puts "Total number of roles: %d" % roles.size
51
+ end
52
+ end
53
+
54
+ if __FILE__ == $0
55
+ begin
56
+ get_all_roles()
57
+
58
+ # HTTP errors.
59
+ rescue AdsCommon::Errors::HttpError => e
60
+ puts "HTTP Error: %s" % e
61
+
62
+ # API errors.
63
+ rescue DfpApi::Errors::ApiException => e
64
+ puts "Message: %s" % e.message
65
+ puts 'Errors:'
66
+ e.errors.each_with_index do |error, index|
67
+ puts "\tError [%d]:" % (index + 1)
68
+ error.each do |field, value|
69
+ puts "\t\t%s: %s" % [field, value]
70
+ end
71
+ end
72
+ end
73
+ end
@@ -0,0 +1,92 @@
1
+ #!/usr/bin/ruby
2
+ #
3
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
4
+ #
5
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
+ #
7
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
+ # implied.
17
+ # See the License for the specific language governing permissions and
18
+ # limitations under the License.
19
+ #
20
+ # This example gets all users for an account. To create users run create_user.rb
21
+ #
22
+ # Tags: UserService.getUsersByStatement
23
+
24
+ require 'rubygems'
25
+ require 'dfp_api'
26
+
27
+ API_VERSION = :v201111
28
+ PAGE_SIZE = 500
29
+
30
+ def get_all_users()
31
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
32
+ dfp = DfpApi::Api.new
33
+
34
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
35
+ # the configuration file or provide your own logger:
36
+ # dfp.logger = Logger.new('dfp_xml.log')
37
+
38
+ # Get the UserService.
39
+ user_service = dfp.service(:UserService, API_VERSION)
40
+
41
+ # Define initial values.
42
+ offset = 0
43
+ page = {}
44
+
45
+ begin
46
+ # Create statement for one page with current offset.
47
+ statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
48
+
49
+ # Get users by statement.
50
+ page = user_service.get_users_by_statement(statement)
51
+
52
+ if page[:results]
53
+ # Increase query offset by page size.
54
+ offset += PAGE_SIZE
55
+
56
+ # Get the start index for printout.
57
+ start_index = page[:start_index]
58
+
59
+ # Print details about each user in results page.
60
+ page[:results].each_with_index do |user, index|
61
+ puts "%d) User ID: %d, name: %s, email: %s" %
62
+ [index + start_index, user[:id], user[:name], user[:email]]
63
+ end
64
+ end
65
+ end while offset < page[:total_result_set_size]
66
+
67
+ # Print a footer
68
+ if page.include?(:total_result_set_size)
69
+ puts "Total number of users: %d" % page[:total_result_set_size]
70
+ end
71
+ end
72
+
73
+ if __FILE__ == $0
74
+ begin
75
+ get_all_users()
76
+
77
+ # HTTP errors.
78
+ rescue AdsCommon::Errors::HttpError => e
79
+ puts "HTTP Error: %s" % e
80
+
81
+ # API errors.
82
+ rescue DfpApi::Errors::ApiException => e
83
+ puts "Message: %s" % e.message
84
+ puts 'Errors:'
85
+ e.errors.each_with_index do |error, index|
86
+ puts "\tError [%d]:" % (index + 1)
87
+ error.each do |field, value|
88
+ puts "\t\t%s: %s" % [field, value]
89
+ end
90
+ end
91
+ end
92
+ end