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,115 @@
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 copies a given set of image creatives. This would typically be
21
+ # done to reuse creatives in a small business network. To determine which
22
+ # creatives exist, run get_all_creatives.rb.
23
+ #
24
+ # Tags: CreativeService.getCreativesByStatement, CreativeService.createCreatives
25
+
26
+ require 'rubygems'
27
+ require 'dfp_api'
28
+
29
+ require 'base64'
30
+
31
+ API_VERSION = :v201111
32
+
33
+ def copy_image_creatives()
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 CreativeService.
42
+ creative_service = dfp.service(:CreativeService, API_VERSION)
43
+
44
+ # Create a list of creative ids to copy.
45
+ image_creative_ids = [
46
+ 'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
47
+ 'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
48
+ 'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
49
+ 'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i
50
+ ]
51
+
52
+ # Create the statement to filter image creatives by ID.
53
+ statement = {
54
+ :query => "WHERE id IN (%s) AND creativeType = :creative_type" %
55
+ image_creative_ids.join(', '),
56
+ :values => [
57
+ {:key => 'creative_type',
58
+ :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
59
+ ]
60
+ }
61
+
62
+ # Get creatives by statement.
63
+ page = creative_service.get_creatives_by_statement(statement)
64
+
65
+ if page[:results]
66
+ creatives = page[:results]
67
+
68
+ # Copy each local creative object and change its name.
69
+ new_creatives = creatives.map do |creative|
70
+ new_creative = creative.dup()
71
+ old_id = new_creative.delete(:id)
72
+ new_creative[:name] += " (Copy of %d)" % old_id
73
+ image_url = new_creative.delete(:image_url)
74
+ new_creative[:image_byte_array] =
75
+ Base64.encode64(AdsCommon::Http.get(image_url))
76
+ new_creative
77
+ end
78
+
79
+ # Create the creatives on the server.
80
+ return_creatives = creative_service.create_creatives(new_creatives)
81
+
82
+ # Display copied creatives.
83
+ if return_creatives
84
+ return_creatives.each_with_index do |creative, index|
85
+ puts "A creative with ID [%d] was copied to ID [%d], name: %s" %
86
+ [creatives[index][:id], creative[:id], creative[:name]]
87
+ end
88
+ else
89
+ raise 'No creatives were copied.'
90
+ end
91
+ else
92
+ puts 'No creatives found to copy.'
93
+ end
94
+ end
95
+
96
+ if __FILE__ == $0
97
+ begin
98
+ copy_image_creatives()
99
+
100
+ # HTTP errors.
101
+ rescue AdsCommon::Errors::HttpError => e
102
+ puts "HTTP Error: %s" % e
103
+
104
+ # API errors.
105
+ rescue DfpApi::Errors::ApiException => e
106
+ puts "Message: %s" % e.message
107
+ puts 'Errors:'
108
+ e.errors.each_with_index do |error, index|
109
+ puts "\tError [%d]:" % (index + 1)
110
+ error.each do |field, value|
111
+ puts "\t\t%s: %s" % [field, value]
112
+ end
113
+ end
114
+ end
115
+ end
@@ -0,0 +1,139 @@
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 a new template creative for a given advertiser. To
21
+ # determine which companies are advertisers, run get_companies_by_statement.rb.
22
+ # To determine which creatives already exist, run get_all_creatives.rb. To
23
+ # determine which creative templates run get_all_creative_templates.rb.
24
+ #
25
+ # Tags: CreativeService.createCreative
26
+
27
+ require 'rubygems'
28
+ require 'base64'
29
+ require 'dfp_api'
30
+
31
+ API_VERSION = :v201111
32
+
33
+ def create_creative_from_template()
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 CreativeService.
42
+ creative_service = dfp.service(:CreativeService, API_VERSION)
43
+
44
+ # Set the ID of the advertiser (company) that all creatives will be assigned
45
+ # to.
46
+ advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
47
+
48
+ # Use the image banner with optional third party tracking template.
49
+ creative_template_id = 10000680
50
+
51
+ # Create the local custom creative object.
52
+ creative = {
53
+ :xsi_type => 'TemplateCreative',
54
+ :name => 'Template creative',
55
+ :advertiser_id => advertiser_id,
56
+ :creative_template_id => creative_template_id,
57
+ :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
58
+ }
59
+
60
+ # Prepare image data for asset value.
61
+ image_url =
62
+ 'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
63
+ image_data = AdsCommon::Http.get(image_url)
64
+ image_data_base64 = Base64.encode64(image_data)
65
+
66
+ # Create the asset variable value.
67
+ asset_variable_value = {
68
+ :xsi_type => 'AssetCreativeTemplateVariableValue',
69
+ :unique_name => 'Imagefile',
70
+ :asset_byte_array => image_data_base64,
71
+ # Filenames must be unique.
72
+ :file_name => "image%d.jpg" % Time.new.to_i
73
+ }
74
+
75
+ # Create the image width variable value.
76
+ image_width_variable_value = {
77
+ :xsi_type => 'LongCreativeTemplateVariableValue',
78
+ :unique_name => 'Imagewidth',
79
+ :value => 300
80
+ }
81
+
82
+ # Create the image height variable value.
83
+ image_height_variable_value = {
84
+ :xsi_type => 'LongCreativeTemplateVariableValue',
85
+ :unique_name => 'Imageheight',
86
+ :value => 250
87
+ }
88
+
89
+ # Create the URL variable value.
90
+ url_variable_value = {
91
+ :xsi_type => 'UrlCreativeTemplateVariableValue',
92
+ :unique_name => 'ClickthroughURL',
93
+ :value => 'www.google.com'
94
+ }
95
+
96
+ # Create the target window variable value.
97
+ target_window_variable_value = {
98
+ :xsi_type => 'StringCreativeTemplateVariableValue',
99
+ :unique_name => 'Targetwindow',
100
+ :value => '__blank'
101
+ }
102
+
103
+ creative[:creative_template_variable_values] = [asset_variable_value,
104
+ image_width_variable_value, image_height_variable_value,
105
+ url_variable_value, target_window_variable_value]
106
+
107
+ # Create the creatives on the server.
108
+ return_creative = creative_service.create_creative(creative)
109
+
110
+ if return_creative
111
+ puts(("Template creative with ID: %d, name: %s and type '%s' was " +
112
+ "created and can be previewed at: '%s'") %
113
+ [return_creative[:id], return_creative[:name],
114
+ return_creative[:creative_type], return_creative[:preview_url]])
115
+ else
116
+ raise 'No creatives were created.'
117
+ end
118
+ end
119
+
120
+ if __FILE__ == $0
121
+ begin
122
+ create_creative_from_template()
123
+
124
+ # HTTP errors.
125
+ rescue AdsCommon::Errors::HttpError => e
126
+ puts "HTTP Error: %s" % e
127
+
128
+ # API errors.
129
+ rescue DfpApi::Errors::ApiException => e
130
+ puts "Message: %s" % e.message
131
+ puts 'Errors:'
132
+ e.errors.each_with_index do |error, index|
133
+ puts "\tError [%d]:" % (index + 1)
134
+ error.each do |field, value|
135
+ puts "\t\t%s: %s" % [field, value]
136
+ end
137
+ end
138
+ end
139
+ end
@@ -0,0 +1,106 @@
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 image creatives for a given advertiser. To determine
21
+ # which companies are advertisers, run get_companies_by_statement.rb. To
22
+ # determine which creatives already exist, run get_all_creatives.rb.
23
+ #
24
+ # Tags: CreativeService.createCreatives
25
+
26
+ require 'rubygems'
27
+ require 'base64'
28
+ require 'dfp_api'
29
+
30
+ API_VERSION = :v201111
31
+ # Number of creatives to create.
32
+ ITEM_COUNT = 5
33
+
34
+ def create_creatives()
35
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
36
+ dfp = DfpApi::Api.new
37
+
38
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
39
+ # the configuration file or provide your own logger:
40
+ # dfp.logger = Logger.new('dfp_xml.log')
41
+
42
+ # Get the CreativeService.
43
+ creative_service = dfp.service(:CreativeService, API_VERSION)
44
+
45
+ # Set the ID of the advertiser (company) that all creatives will be assigned
46
+ # to.
47
+ advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
48
+
49
+ # Prepare image data for creative.
50
+ image_url =
51
+ 'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
52
+ image_data = AdsCommon::Http.get(image_url)
53
+ image_data_base64 = Base64.encode64(image_data)
54
+
55
+ # Create an array to store local creative objects.
56
+ creatives = (1..ITEM_COUNT).map do |index|
57
+ {:xsi_type => 'ImageCreative',
58
+ :name => "Image creative #%d" % index,
59
+ :advertiser_id => advertiser_id,
60
+ :destination_url => 'http://www.google.com',
61
+ :image_name => 'image.jpg',
62
+ :size => {:width => 300, :height => 250, :is_aspect_ratio => false},
63
+ :image_byte_array => image_data_base64}
64
+ end
65
+
66
+ # Create the creatives on the server.
67
+ return_creatives = creative_service.create_creatives(creatives)
68
+
69
+ if return_creatives
70
+ return_creatives.each do |creative|
71
+ if creative[:creative_type] == 'ImageCreative'
72
+ puts ("Image creative with ID: %d, name: %s, size: %dx%d was " +
73
+ "created and can be previewed at: [%s]") %
74
+ [creative[:id], creative[:name],
75
+ creative[:size][:width], creative[:size][:height],
76
+ creative[:preview_url]]
77
+ else
78
+ puts "Creative with ID: %d, name: %s and type: %s was created." %
79
+ [creative[:id], creative[:name], creative[:creative_type]]
80
+ end
81
+ end
82
+ else
83
+ raise 'No creatives were created.'
84
+ end
85
+ end
86
+
87
+ if __FILE__ == $0
88
+ begin
89
+ create_creatives()
90
+
91
+ # HTTP errors.
92
+ rescue AdsCommon::Errors::HttpError => e
93
+ puts "HTTP Error: %s" % e
94
+
95
+ # API errors.
96
+ rescue DfpApi::Errors::ApiException => e
97
+ puts "Message: %s" % e.message
98
+ puts 'Errors:'
99
+ e.errors.each_with_index do |error, index|
100
+ puts "\tError [%d]:" % (index + 1)
101
+ error.each do |field, value|
102
+ puts "\t\t%s: %s" % [field, value]
103
+ end
104
+ end
105
+ end
106
+ end
@@ -0,0 +1,104 @@
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 a custom creative for a given advertiser. To determine
21
+ # which companies are advertisers, run get_companies_by_statement.rb. To
22
+ # determine which creatives already exist, run get_all_creatives.rb.
23
+ #
24
+ # This feature is only available to DFP premium solution networks.
25
+ #
26
+ # Tags: CreativeService.createCreative
27
+
28
+ require 'rubygems'
29
+ require 'base64'
30
+ require 'dfp_api'
31
+
32
+ API_VERSION = :v201111
33
+
34
+ def create_custom_creative()
35
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
36
+ dfp = DfpApi::Api.new
37
+
38
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
39
+ # the configuration file or provide your own logger:
40
+ # dfp.logger = Logger.new('dfp_xml.log')
41
+
42
+ # Get the CreativeService.
43
+ creative_service = dfp.service(:CreativeService, API_VERSION)
44
+
45
+ # Set the ID of the advertiser (company) that all creatives will be assigned
46
+ # to.
47
+ advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
48
+
49
+ # Prepare image data for creative.
50
+ image_url =
51
+ 'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
52
+ image_data = AdsCommon::Http.get(image_url)
53
+ image_data_base64 = Base64.encode64(image_data)
54
+
55
+ # Create an array to store local creative objects.
56
+ custom_creative = {
57
+ :xsi_type => 'CustomCreative',
58
+ :name => 'Custom creative',
59
+ :advertiser_id => advertiser_id,
60
+ :destination_url => 'http://www.google.com',
61
+ :custom_creative_assets => [
62
+ {:macro_name => 'IMAGE_ASSET',
63
+ :file_name => "image%d.jpg" % Time.new.to_i,
64
+ :asset_byte_array => image_data_base64}
65
+ ],
66
+ # Set the HTML snippet using the custom creative asset macro.
67
+ :html_snippet => "<a href='%%CLICK_URL_UNESC%%%%DEST_URL%%'>" +
68
+ "<img src='%%FILE:IMAGE_ASSET%%'/></a><br>Click above for great deals!",
69
+ # Set the creative size.
70
+ :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
71
+ }
72
+
73
+ # Create the creatives on the server.
74
+ return_creative = creative_service.create_creative(custom_creative)
75
+
76
+ if return_creative
77
+ puts "Custom creative with ID: %d, name: '%s' and type: '%s' was created." %
78
+ [return_creative[:id], return_creative[:name],
79
+ return_creative[:creative_type]]
80
+ else
81
+ raise 'No creatives were created.'
82
+ end
83
+ end
84
+
85
+ if __FILE__ == $0
86
+ begin
87
+ create_custom_creative()
88
+
89
+ # HTTP errors.
90
+ rescue AdsCommon::Errors::HttpError => e
91
+ puts "HTTP Error: %s" % e
92
+
93
+ # API errors.
94
+ rescue DfpApi::Errors::ApiException => e
95
+ puts "Message: %s" % e.message
96
+ puts 'Errors:'
97
+ e.errors.each_with_index do |error, index|
98
+ puts "\tError [%d]:" % (index + 1)
99
+ error.each do |field, value|
100
+ puts "\t\t%s: %s" % [field, value]
101
+ end
102
+ end
103
+ end
104
+ end