google-dfp-api 0.3.3 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (413) hide show
  1. data/ChangeLog +4 -0
  2. data/dfp_api.yml +4 -1
  3. data/examples/v201208/audience_segment_service/get_all_audience_segments.rb +93 -0
  4. data/examples/v201208/common/error_handling.rb +76 -0
  5. data/examples/v201208/common/oauth2_handling.rb +128 -0
  6. data/examples/v201208/common/oauth_handling.rb +131 -0
  7. data/examples/v201208/company_service/create_companies.rb +81 -0
  8. data/examples/v201208/company_service/get_all_companies.rb +92 -0
  9. data/examples/v201208/company_service/get_companies_by_statement.rb +88 -0
  10. data/examples/v201208/company_service/get_company.rb +72 -0
  11. data/examples/v201208/company_service/update_companies.rb +95 -0
  12. data/examples/v201208/content_service/get_all_content.rb +94 -0
  13. data/examples/v201208/content_service/get_content_by_category.rb +136 -0
  14. data/examples/v201208/creative_service/copy_image_creatives.rb +115 -0
  15. data/examples/v201208/creative_service/create_creative_from_template.rb +139 -0
  16. data/examples/v201208/creative_service/create_creatives.rb +106 -0
  17. data/examples/v201208/creative_service/create_custom_creative.rb +104 -0
  18. data/examples/v201208/creative_service/get_all_creatives.rb +93 -0
  19. data/examples/v201208/creative_service/get_creative.rb +72 -0
  20. data/examples/v201208/creative_service/get_creatives_by_statement.rb +87 -0
  21. data/examples/v201208/creative_service/update_creatives.rb +96 -0
  22. data/examples/v201208/creative_set_service/associate_creative_set_to_line_item.rb +77 -0
  23. data/examples/v201208/creative_set_service/create_creative_set.rb +83 -0
  24. data/examples/v201208/creative_set_service/get_all_creative_sets.rb +94 -0
  25. data/examples/v201208/creative_set_service/get_creative_sets_by_statement.rb +90 -0
  26. data/examples/v201208/creative_set_service/update_creative_sets.rb +85 -0
  27. data/examples/v201208/creative_template_service/get_all_creative_templates.rb +94 -0
  28. data/examples/v201208/creative_template_service/get_creative_template.rb +74 -0
  29. data/examples/v201208/creative_template_service/get_creative_templates_by_statement.rb +80 -0
  30. data/examples/v201208/custom_field_service/create_custom_field_options.rb +87 -0
  31. data/examples/v201208/custom_field_service/create_custom_fields.rb +86 -0
  32. data/examples/v201208/custom_field_service/deactivate_all_line_item_custom_fields.rb +112 -0
  33. data/examples/v201208/custom_field_service/get_all_custom_fields.rb +102 -0
  34. data/examples/v201208/custom_field_service/get_all_line_item_custom_fields.rb +86 -0
  35. data/examples/v201208/custom_field_service/set_line_item_custom_field_value.rb +135 -0
  36. data/examples/v201208/custom_field_service/update_custom_fields.rb +83 -0
  37. data/examples/v201208/custom_targeting_service/create_custom_targeting_keys_and_values.rb +140 -0
  38. data/examples/v201208/custom_targeting_service/delete_custom_targeting_keys.rb +121 -0
  39. data/examples/v201208/custom_targeting_service/delete_custom_targeting_values.rb +125 -0
  40. data/examples/v201208/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb +148 -0
  41. data/examples/v201208/custom_targeting_service/get_custom_targeting_keys_by_statement.rb +92 -0
  42. data/examples/v201208/custom_targeting_service/get_custom_targeting_values_by_statement.rb +98 -0
  43. data/examples/v201208/custom_targeting_service/update_custom_targeting_keys.rb +94 -0
  44. data/examples/v201208/custom_targeting_service/update_custom_targeting_values.rb +106 -0
  45. data/examples/v201208/forecast_service/get_forecast.rb +107 -0
  46. data/examples/v201208/forecast_service/get_forecast_by_id.rb +80 -0
  47. data/examples/v201208/inventory_service/create_ad_units.rb +101 -0
  48. data/examples/v201208/inventory_service/create_mobile_ad_unit.rb +101 -0
  49. data/examples/v201208/inventory_service/create_video_ad_unit.rb +108 -0
  50. data/examples/v201208/inventory_service/deactivate_ad_units.rb +119 -0
  51. data/examples/v201208/inventory_service/get_ad_unit.rb +72 -0
  52. data/examples/v201208/inventory_service/get_ad_unit_sizes.rb +85 -0
  53. data/examples/v201208/inventory_service/get_ad_units_by_statement.rb +96 -0
  54. data/examples/v201208/inventory_service/get_all_ad_units.rb +93 -0
  55. data/examples/v201208/inventory_service/update_ad_units.rb +94 -0
  56. data/examples/v201208/label_service/create_labels.rb +83 -0
  57. data/examples/v201208/label_service/deactivate_labels.rb +118 -0
  58. data/examples/v201208/label_service/get_all_labels.rb +95 -0
  59. data/examples/v201208/label_service/get_label.rb +76 -0
  60. data/examples/v201208/label_service/get_labels_by_statement.rb +81 -0
  61. data/examples/v201208/label_service/update_labels.rb +102 -0
  62. data/examples/v201208/line_item_creative_association_service/create_licas.rb +94 -0
  63. data/examples/v201208/line_item_creative_association_service/deactivate_licas.rb +127 -0
  64. data/examples/v201208/line_item_creative_association_service/get_all_licas.rb +98 -0
  65. data/examples/v201208/line_item_creative_association_service/get_lica.rb +77 -0
  66. data/examples/v201208/line_item_creative_association_service/get_licas_by_statement.rb +91 -0
  67. data/examples/v201208/line_item_creative_association_service/update_licas.rb +91 -0
  68. data/examples/v201208/line_item_service/activate_line_items.rb +131 -0
  69. data/examples/v201208/line_item_service/create_line_items.rb +177 -0
  70. data/examples/v201208/line_item_service/create_mobile_line_item.rb +135 -0
  71. data/examples/v201208/line_item_service/create_video_line_item.rb +156 -0
  72. data/examples/v201208/line_item_service/get_all_line_items.rb +94 -0
  73. data/examples/v201208/line_item_service/get_line_item.rb +74 -0
  74. data/examples/v201208/line_item_service/get_line_items_by_statement.rb +93 -0
  75. data/examples/v201208/line_item_service/get_recently_updated_line_items.rb +98 -0
  76. data/examples/v201208/line_item_service/target_custom_criteria.rb +129 -0
  77. data/examples/v201208/line_item_service/update_line_items.rb +109 -0
  78. data/examples/v201208/network_service/get_all_networks.rb +74 -0
  79. data/examples/v201208/network_service/get_current_network.rb +66 -0
  80. data/examples/v201208/network_service/make_test_network.rb +79 -0
  81. data/examples/v201208/order_service/approve_orders.rb +122 -0
  82. data/examples/v201208/order_service/create_orders.rb +92 -0
  83. data/examples/v201208/order_service/get_all_orders.rb +93 -0
  84. data/examples/v201208/order_service/get_order.rb +74 -0
  85. data/examples/v201208/order_service/get_orders_by_statement.rb +90 -0
  86. data/examples/v201208/order_service/update_orders.rb +95 -0
  87. data/examples/v201208/placement_service/create_placements.rb +131 -0
  88. data/examples/v201208/placement_service/deactivate_placements.rb +118 -0
  89. data/examples/v201208/placement_service/get_all_placements.rb +93 -0
  90. data/examples/v201208/placement_service/get_placement.rb +74 -0
  91. data/examples/v201208/placement_service/get_placements_by_statement.rb +86 -0
  92. data/examples/v201208/placement_service/update_placements.rb +97 -0
  93. data/examples/v201208/publisher_query_language_service/get_all_cities.rb +90 -0
  94. data/examples/v201208/report_service/download_report.rb +81 -0
  95. data/examples/v201208/report_service/run_delivery_report.rb +103 -0
  96. data/examples/v201208/report_service/run_inventory_report.rb +96 -0
  97. data/examples/v201208/report_service/run_merged_delivery_report.rb +94 -0
  98. data/examples/v201208/report_service/run_report_with_custom_fields.rb +135 -0
  99. data/examples/v201208/report_service/run_sales_report.rb +92 -0
  100. data/examples/v201208/suggested_ad_unit_service/approve_all_suggested_ad_units.rb +109 -0
  101. data/examples/v201208/suggested_ad_unit_service/get_all_suggested_ad_units.rb +96 -0
  102. data/examples/v201208/suggested_ad_unit_service/get_suggested_ad_unit.rb +75 -0
  103. data/examples/v201208/suggested_ad_unit_service/get_suggested_ad_units_by_statement.rb +92 -0
  104. data/examples/v201208/team_service/create_teams.rb +83 -0
  105. data/examples/v201208/team_service/get_all_teams.rb +92 -0
  106. data/examples/v201208/team_service/get_team.rb +74 -0
  107. data/examples/v201208/team_service/get_teams_by_statement.rb +78 -0
  108. data/examples/v201208/team_service/update_teams.rb +95 -0
  109. data/examples/v201208/third_party_slot_service/archive_third_party_slots.rb +125 -0
  110. data/examples/v201208/third_party_slot_service/create_third_party_slot.rb +91 -0
  111. data/examples/v201208/third_party_slot_service/get_all_third_party_slots.rb +93 -0
  112. data/examples/v201208/third_party_slot_service/get_third_party_slot_by_statement.rb +86 -0
  113. data/examples/v201208/third_party_slot_service/update_third_party_slots.rb +95 -0
  114. data/examples/v201208/user_service/create_users.rb +89 -0
  115. data/examples/v201208/user_service/deactivate_users.rb +97 -0
  116. data/examples/v201208/user_service/get_all_roles.rb +73 -0
  117. data/examples/v201208/user_service/get_all_users.rb +93 -0
  118. data/examples/v201208/user_service/get_current_user.rb +66 -0
  119. data/examples/v201208/user_service/get_user.rb +73 -0
  120. data/examples/v201208/user_service/get_users_by_statement.rb +79 -0
  121. data/examples/v201208/user_service/update_users.rb +89 -0
  122. data/examples/v201208/user_team_association_service/create_user_team_associations.rb +86 -0
  123. data/examples/v201208/user_team_association_service/delete_user_team_associations.rb +111 -0
  124. data/examples/v201208/user_team_association_service/get_all_user_team_associations.rb +94 -0
  125. data/examples/v201208/user_team_association_service/get_user_team_association.rb +76 -0
  126. data/examples/v201208/user_team_association_service/get_user_team_associations_by_statement.rb +94 -0
  127. data/examples/v201208/user_team_association_service/update_user_team_associations.rb +102 -0
  128. data/lib/dfp_api.rb +6 -9
  129. data/lib/dfp_api/api_config.rb +14 -5
  130. data/lib/dfp_api/credential_handler.rb +5 -17
  131. data/lib/dfp_api/errors.rb +7 -3
  132. data/lib/dfp_api/v201108/company_service.rb +1 -1
  133. data/lib/dfp_api/v201108/company_service_registry.rb +3 -3
  134. data/lib/dfp_api/v201108/creative_service.rb +1 -1
  135. data/lib/dfp_api/v201108/creative_service_registry.rb +3 -3
  136. data/lib/dfp_api/v201108/custom_targeting_service.rb +1 -1
  137. data/lib/dfp_api/v201108/custom_targeting_service_registry.rb +3 -3
  138. data/lib/dfp_api/v201108/forecast_service.rb +1 -1
  139. data/lib/dfp_api/v201108/forecast_service_registry.rb +3 -3
  140. data/lib/dfp_api/v201108/inventory_service.rb +1 -1
  141. data/lib/dfp_api/v201108/inventory_service_registry.rb +3 -3
  142. data/lib/dfp_api/v201108/label_service.rb +1 -1
  143. data/lib/dfp_api/v201108/label_service_registry.rb +3 -3
  144. data/lib/dfp_api/v201108/line_item_creative_association_service.rb +1 -1
  145. data/lib/dfp_api/v201108/line_item_creative_association_service_registry.rb +3 -3
  146. data/lib/dfp_api/v201108/line_item_service.rb +1 -1
  147. data/lib/dfp_api/v201108/line_item_service_registry.rb +3 -3
  148. data/lib/dfp_api/v201108/network_service.rb +1 -1
  149. data/lib/dfp_api/v201108/network_service_registry.rb +3 -3
  150. data/lib/dfp_api/v201108/order_service.rb +1 -1
  151. data/lib/dfp_api/v201108/order_service_registry.rb +3 -3
  152. data/lib/dfp_api/v201108/placement_service.rb +1 -1
  153. data/lib/dfp_api/v201108/placement_service_registry.rb +3 -3
  154. data/lib/dfp_api/v201108/publisher_query_language_service.rb +1 -1
  155. data/lib/dfp_api/v201108/publisher_query_language_service_registry.rb +3 -3
  156. data/lib/dfp_api/v201108/report_service.rb +1 -1
  157. data/lib/dfp_api/v201108/report_service_registry.rb +3 -3
  158. data/lib/dfp_api/v201108/third_party_slot_service.rb +1 -1
  159. data/lib/dfp_api/v201108/third_party_slot_service_registry.rb +3 -3
  160. data/lib/dfp_api/v201108/user_service.rb +1 -1
  161. data/lib/dfp_api/v201108/user_service_registry.rb +3 -3
  162. data/lib/dfp_api/v201111/company_service.rb +1 -1
  163. data/lib/dfp_api/v201111/company_service_registry.rb +3 -3
  164. data/lib/dfp_api/v201111/content_service.rb +1 -1
  165. data/lib/dfp_api/v201111/content_service_registry.rb +3 -3
  166. data/lib/dfp_api/v201111/creative_service.rb +1 -1
  167. data/lib/dfp_api/v201111/creative_service_registry.rb +3 -3
  168. data/lib/dfp_api/v201111/creative_template_service.rb +1 -1
  169. data/lib/dfp_api/v201111/creative_template_service_registry.rb +3 -3
  170. data/lib/dfp_api/v201111/custom_targeting_service.rb +1 -1
  171. data/lib/dfp_api/v201111/custom_targeting_service_registry.rb +3 -3
  172. data/lib/dfp_api/v201111/forecast_service.rb +1 -1
  173. data/lib/dfp_api/v201111/forecast_service_registry.rb +3 -3
  174. data/lib/dfp_api/v201111/inventory_service.rb +1 -1
  175. data/lib/dfp_api/v201111/inventory_service_registry.rb +3 -3
  176. data/lib/dfp_api/v201111/label_service.rb +1 -1
  177. data/lib/dfp_api/v201111/label_service_registry.rb +3 -3
  178. data/lib/dfp_api/v201111/line_item_creative_association_service.rb +1 -1
  179. data/lib/dfp_api/v201111/line_item_creative_association_service_registry.rb +3 -3
  180. data/lib/dfp_api/v201111/line_item_service.rb +1 -1
  181. data/lib/dfp_api/v201111/line_item_service_registry.rb +3 -3
  182. data/lib/dfp_api/v201111/network_service.rb +1 -1
  183. data/lib/dfp_api/v201111/network_service_registry.rb +3 -3
  184. data/lib/dfp_api/v201111/order_service.rb +1 -1
  185. data/lib/dfp_api/v201111/order_service_registry.rb +3 -3
  186. data/lib/dfp_api/v201111/placement_service.rb +1 -1
  187. data/lib/dfp_api/v201111/placement_service_registry.rb +3 -3
  188. data/lib/dfp_api/v201111/publisher_query_language_service.rb +1 -1
  189. data/lib/dfp_api/v201111/publisher_query_language_service_registry.rb +3 -3
  190. data/lib/dfp_api/v201111/report_service.rb +1 -1
  191. data/lib/dfp_api/v201111/report_service_registry.rb +3 -3
  192. data/lib/dfp_api/v201111/suggested_ad_unit_service.rb +1 -1
  193. data/lib/dfp_api/v201111/suggested_ad_unit_service_registry.rb +3 -3
  194. data/lib/dfp_api/v201111/third_party_slot_service.rb +1 -1
  195. data/lib/dfp_api/v201111/third_party_slot_service_registry.rb +3 -3
  196. data/lib/dfp_api/v201111/user_service.rb +1 -1
  197. data/lib/dfp_api/v201111/user_service_registry.rb +3 -3
  198. data/lib/dfp_api/v201201/company_service.rb +1 -1
  199. data/lib/dfp_api/v201201/company_service_registry.rb +3 -3
  200. data/lib/dfp_api/v201201/content_service.rb +1 -1
  201. data/lib/dfp_api/v201201/content_service_registry.rb +3 -3
  202. data/lib/dfp_api/v201201/creative_service.rb +1 -1
  203. data/lib/dfp_api/v201201/creative_service_registry.rb +3 -3
  204. data/lib/dfp_api/v201201/creative_template_service.rb +1 -1
  205. data/lib/dfp_api/v201201/creative_template_service_registry.rb +3 -3
  206. data/lib/dfp_api/v201201/custom_targeting_service.rb +1 -1
  207. data/lib/dfp_api/v201201/custom_targeting_service_registry.rb +3 -3
  208. data/lib/dfp_api/v201201/forecast_service.rb +1 -1
  209. data/lib/dfp_api/v201201/forecast_service_registry.rb +3 -3
  210. data/lib/dfp_api/v201201/inventory_service.rb +1 -1
  211. data/lib/dfp_api/v201201/inventory_service_registry.rb +3 -3
  212. data/lib/dfp_api/v201201/label_service.rb +1 -1
  213. data/lib/dfp_api/v201201/label_service_registry.rb +3 -3
  214. data/lib/dfp_api/v201201/line_item_creative_association_service.rb +1 -1
  215. data/lib/dfp_api/v201201/line_item_creative_association_service_registry.rb +3 -3
  216. data/lib/dfp_api/v201201/line_item_service.rb +1 -1
  217. data/lib/dfp_api/v201201/line_item_service_registry.rb +3 -3
  218. data/lib/dfp_api/v201201/network_service.rb +1 -1
  219. data/lib/dfp_api/v201201/network_service_registry.rb +3 -3
  220. data/lib/dfp_api/v201201/order_service.rb +1 -1
  221. data/lib/dfp_api/v201201/order_service_registry.rb +3 -3
  222. data/lib/dfp_api/v201201/placement_service.rb +1 -1
  223. data/lib/dfp_api/v201201/placement_service_registry.rb +3 -3
  224. data/lib/dfp_api/v201201/publisher_query_language_service.rb +1 -1
  225. data/lib/dfp_api/v201201/publisher_query_language_service_registry.rb +3 -3
  226. data/lib/dfp_api/v201201/report_service.rb +1 -1
  227. data/lib/dfp_api/v201201/report_service_registry.rb +3 -3
  228. data/lib/dfp_api/v201201/suggested_ad_unit_service.rb +1 -1
  229. data/lib/dfp_api/v201201/suggested_ad_unit_service_registry.rb +3 -3
  230. data/lib/dfp_api/v201201/team_service.rb +1 -1
  231. data/lib/dfp_api/v201201/team_service_registry.rb +3 -3
  232. data/lib/dfp_api/v201201/third_party_slot_service.rb +1 -1
  233. data/lib/dfp_api/v201201/third_party_slot_service_registry.rb +3 -3
  234. data/lib/dfp_api/v201201/user_service.rb +1 -1
  235. data/lib/dfp_api/v201201/user_service_registry.rb +3 -3
  236. data/lib/dfp_api/v201203/audience_segment_service.rb +1 -1
  237. data/lib/dfp_api/v201203/audience_segment_service_registry.rb +3 -3
  238. data/lib/dfp_api/v201203/company_service.rb +1 -1
  239. data/lib/dfp_api/v201203/company_service_registry.rb +3 -3
  240. data/lib/dfp_api/v201203/content_service.rb +1 -1
  241. data/lib/dfp_api/v201203/content_service_registry.rb +3 -3
  242. data/lib/dfp_api/v201203/creative_service.rb +1 -1
  243. data/lib/dfp_api/v201203/creative_service_registry.rb +3 -3
  244. data/lib/dfp_api/v201203/creative_template_service.rb +1 -1
  245. data/lib/dfp_api/v201203/creative_template_service_registry.rb +3 -3
  246. data/lib/dfp_api/v201203/custom_targeting_service.rb +1 -1
  247. data/lib/dfp_api/v201203/custom_targeting_service_registry.rb +3 -3
  248. data/lib/dfp_api/v201203/forecast_service.rb +1 -1
  249. data/lib/dfp_api/v201203/forecast_service_registry.rb +3 -3
  250. data/lib/dfp_api/v201203/inventory_service.rb +1 -1
  251. data/lib/dfp_api/v201203/inventory_service_registry.rb +3 -3
  252. data/lib/dfp_api/v201203/label_service.rb +1 -1
  253. data/lib/dfp_api/v201203/label_service_registry.rb +3 -3
  254. data/lib/dfp_api/v201203/line_item_creative_association_service.rb +1 -1
  255. data/lib/dfp_api/v201203/line_item_creative_association_service_registry.rb +3 -3
  256. data/lib/dfp_api/v201203/line_item_service.rb +1 -1
  257. data/lib/dfp_api/v201203/line_item_service_registry.rb +3 -3
  258. data/lib/dfp_api/v201203/network_service.rb +1 -1
  259. data/lib/dfp_api/v201203/network_service_registry.rb +3 -3
  260. data/lib/dfp_api/v201203/order_service.rb +1 -1
  261. data/lib/dfp_api/v201203/order_service_registry.rb +3 -3
  262. data/lib/dfp_api/v201203/placement_service.rb +1 -1
  263. data/lib/dfp_api/v201203/placement_service_registry.rb +3 -3
  264. data/lib/dfp_api/v201203/publisher_query_language_service.rb +1 -1
  265. data/lib/dfp_api/v201203/publisher_query_language_service_registry.rb +3 -3
  266. data/lib/dfp_api/v201203/report_service.rb +1 -1
  267. data/lib/dfp_api/v201203/report_service_registry.rb +3 -3
  268. data/lib/dfp_api/v201203/suggested_ad_unit_service.rb +1 -1
  269. data/lib/dfp_api/v201203/suggested_ad_unit_service_registry.rb +3 -3
  270. data/lib/dfp_api/v201203/team_service.rb +1 -1
  271. data/lib/dfp_api/v201203/team_service_registry.rb +3 -3
  272. data/lib/dfp_api/v201203/third_party_slot_service.rb +1 -1
  273. data/lib/dfp_api/v201203/third_party_slot_service_registry.rb +3 -3
  274. data/lib/dfp_api/v201203/user_service.rb +1 -1
  275. data/lib/dfp_api/v201203/user_service_registry.rb +3 -3
  276. data/lib/dfp_api/v201204/audience_segment_service.rb +1 -1
  277. data/lib/dfp_api/v201204/audience_segment_service_registry.rb +3 -3
  278. data/lib/dfp_api/v201204/company_service.rb +1 -1
  279. data/lib/dfp_api/v201204/company_service_registry.rb +3 -3
  280. data/lib/dfp_api/v201204/content_service.rb +1 -1
  281. data/lib/dfp_api/v201204/content_service_registry.rb +3 -3
  282. data/lib/dfp_api/v201204/creative_service.rb +1 -1
  283. data/lib/dfp_api/v201204/creative_service_registry.rb +3 -3
  284. data/lib/dfp_api/v201204/creative_template_service.rb +1 -1
  285. data/lib/dfp_api/v201204/creative_template_service_registry.rb +3 -3
  286. data/lib/dfp_api/v201204/custom_field_service.rb +1 -1
  287. data/lib/dfp_api/v201204/custom_field_service_registry.rb +3 -3
  288. data/lib/dfp_api/v201204/custom_targeting_service.rb +1 -1
  289. data/lib/dfp_api/v201204/custom_targeting_service_registry.rb +3 -3
  290. data/lib/dfp_api/v201204/forecast_service.rb +1 -1
  291. data/lib/dfp_api/v201204/forecast_service_registry.rb +3 -3
  292. data/lib/dfp_api/v201204/inventory_service.rb +1 -1
  293. data/lib/dfp_api/v201204/inventory_service_registry.rb +3 -3
  294. data/lib/dfp_api/v201204/label_service.rb +1 -1
  295. data/lib/dfp_api/v201204/label_service_registry.rb +3 -3
  296. data/lib/dfp_api/v201204/line_item_creative_association_service.rb +1 -1
  297. data/lib/dfp_api/v201204/line_item_creative_association_service_registry.rb +3 -3
  298. data/lib/dfp_api/v201204/line_item_service.rb +1 -1
  299. data/lib/dfp_api/v201204/line_item_service_registry.rb +3 -3
  300. data/lib/dfp_api/v201204/network_service.rb +1 -1
  301. data/lib/dfp_api/v201204/network_service_registry.rb +3 -3
  302. data/lib/dfp_api/v201204/order_service.rb +1 -1
  303. data/lib/dfp_api/v201204/order_service_registry.rb +3 -3
  304. data/lib/dfp_api/v201204/placement_service.rb +1 -1
  305. data/lib/dfp_api/v201204/placement_service_registry.rb +3 -3
  306. data/lib/dfp_api/v201204/publisher_query_language_service.rb +1 -1
  307. data/lib/dfp_api/v201204/publisher_query_language_service_registry.rb +3 -3
  308. data/lib/dfp_api/v201204/report_service.rb +1 -1
  309. data/lib/dfp_api/v201204/report_service_registry.rb +3 -3
  310. data/lib/dfp_api/v201204/suggested_ad_unit_service.rb +1 -1
  311. data/lib/dfp_api/v201204/suggested_ad_unit_service_registry.rb +3 -3
  312. data/lib/dfp_api/v201204/team_service.rb +1 -1
  313. data/lib/dfp_api/v201204/team_service_registry.rb +3 -3
  314. data/lib/dfp_api/v201204/third_party_slot_service.rb +1 -1
  315. data/lib/dfp_api/v201204/third_party_slot_service_registry.rb +3 -3
  316. data/lib/dfp_api/v201204/user_service.rb +1 -1
  317. data/lib/dfp_api/v201204/user_service_registry.rb +3 -3
  318. data/lib/dfp_api/v201204/user_team_association_service.rb +1 -1
  319. data/lib/dfp_api/v201204/user_team_association_service_registry.rb +3 -3
  320. data/lib/dfp_api/v201206/audience_segment_service.rb +1 -1
  321. data/lib/dfp_api/v201206/audience_segment_service_registry.rb +3 -3
  322. data/lib/dfp_api/v201206/company_service.rb +1 -1
  323. data/lib/dfp_api/v201206/company_service_registry.rb +3 -3
  324. data/lib/dfp_api/v201206/content_service.rb +1 -1
  325. data/lib/dfp_api/v201206/content_service_registry.rb +3 -3
  326. data/lib/dfp_api/v201206/creative_service.rb +1 -1
  327. data/lib/dfp_api/v201206/creative_service_registry.rb +3 -3
  328. data/lib/dfp_api/v201206/creative_set_service.rb +1 -1
  329. data/lib/dfp_api/v201206/creative_set_service_registry.rb +3 -3
  330. data/lib/dfp_api/v201206/creative_template_service.rb +1 -1
  331. data/lib/dfp_api/v201206/creative_template_service_registry.rb +3 -3
  332. data/lib/dfp_api/v201206/custom_field_service.rb +1 -1
  333. data/lib/dfp_api/v201206/custom_field_service_registry.rb +3 -3
  334. data/lib/dfp_api/v201206/custom_targeting_service.rb +1 -1
  335. data/lib/dfp_api/v201206/custom_targeting_service_registry.rb +3 -3
  336. data/lib/dfp_api/v201206/forecast_service.rb +1 -1
  337. data/lib/dfp_api/v201206/forecast_service_registry.rb +3 -3
  338. data/lib/dfp_api/v201206/inventory_service.rb +1 -1
  339. data/lib/dfp_api/v201206/inventory_service_registry.rb +3 -3
  340. data/lib/dfp_api/v201206/label_service.rb +1 -1
  341. data/lib/dfp_api/v201206/label_service_registry.rb +3 -3
  342. data/lib/dfp_api/v201206/line_item_creative_association_service.rb +1 -1
  343. data/lib/dfp_api/v201206/line_item_creative_association_service_registry.rb +3 -3
  344. data/lib/dfp_api/v201206/line_item_service.rb +1 -1
  345. data/lib/dfp_api/v201206/line_item_service_registry.rb +3 -3
  346. data/lib/dfp_api/v201206/network_service.rb +1 -1
  347. data/lib/dfp_api/v201206/network_service_registry.rb +3 -3
  348. data/lib/dfp_api/v201206/order_service.rb +1 -1
  349. data/lib/dfp_api/v201206/order_service_registry.rb +3 -3
  350. data/lib/dfp_api/v201206/placement_service.rb +1 -1
  351. data/lib/dfp_api/v201206/placement_service_registry.rb +3 -3
  352. data/lib/dfp_api/v201206/publisher_query_language_service.rb +1 -1
  353. data/lib/dfp_api/v201206/publisher_query_language_service_registry.rb +3 -3
  354. data/lib/dfp_api/v201206/report_service.rb +1 -1
  355. data/lib/dfp_api/v201206/report_service_registry.rb +3 -3
  356. data/lib/dfp_api/v201206/suggested_ad_unit_service.rb +1 -1
  357. data/lib/dfp_api/v201206/suggested_ad_unit_service_registry.rb +3 -3
  358. data/lib/dfp_api/v201206/team_service.rb +1 -1
  359. data/lib/dfp_api/v201206/team_service_registry.rb +3 -3
  360. data/lib/dfp_api/v201206/third_party_slot_service.rb +1 -1
  361. data/lib/dfp_api/v201206/third_party_slot_service_registry.rb +3 -3
  362. data/lib/dfp_api/v201206/user_service.rb +1 -1
  363. data/lib/dfp_api/v201206/user_service_registry.rb +3 -3
  364. data/lib/dfp_api/v201206/user_team_association_service.rb +1 -1
  365. data/lib/dfp_api/v201206/user_team_association_service_registry.rb +3 -3
  366. data/lib/dfp_api/v201208/audience_segment_service.rb +34 -0
  367. data/lib/dfp_api/v201208/audience_segment_service_registry.rb +46 -0
  368. data/lib/dfp_api/v201208/company_service.rb +54 -0
  369. data/lib/dfp_api/v201208/company_service_registry.rb +46 -0
  370. data/lib/dfp_api/v201208/content_service.rb +42 -0
  371. data/lib/dfp_api/v201208/content_service_registry.rb +46 -0
  372. data/lib/dfp_api/v201208/creative_service.rb +54 -0
  373. data/lib/dfp_api/v201208/creative_service_registry.rb +46 -0
  374. data/lib/dfp_api/v201208/creative_set_service.rb +46 -0
  375. data/lib/dfp_api/v201208/creative_set_service_registry.rb +46 -0
  376. data/lib/dfp_api/v201208/creative_template_service.rb +38 -0
  377. data/lib/dfp_api/v201208/creative_template_service_registry.rb +46 -0
  378. data/lib/dfp_api/v201208/custom_field_service.rb +78 -0
  379. data/lib/dfp_api/v201208/custom_field_service_registry.rb +46 -0
  380. data/lib/dfp_api/v201208/custom_targeting_service.rb +62 -0
  381. data/lib/dfp_api/v201208/custom_targeting_service_registry.rb +46 -0
  382. data/lib/dfp_api/v201208/forecast_service.rb +38 -0
  383. data/lib/dfp_api/v201208/forecast_service_registry.rb +46 -0
  384. data/lib/dfp_api/v201208/inventory_service.rb +62 -0
  385. data/lib/dfp_api/v201208/inventory_service_registry.rb +46 -0
  386. data/lib/dfp_api/v201208/label_service.rb +58 -0
  387. data/lib/dfp_api/v201208/label_service_registry.rb +46 -0
  388. data/lib/dfp_api/v201208/line_item_creative_association_service.rb +62 -0
  389. data/lib/dfp_api/v201208/line_item_creative_association_service_registry.rb +46 -0
  390. data/lib/dfp_api/v201208/line_item_service.rb +58 -0
  391. data/lib/dfp_api/v201208/line_item_service_registry.rb +46 -0
  392. data/lib/dfp_api/v201208/network_service.rb +46 -0
  393. data/lib/dfp_api/v201208/network_service_registry.rb +46 -0
  394. data/lib/dfp_api/v201208/order_service.rb +58 -0
  395. data/lib/dfp_api/v201208/order_service_registry.rb +46 -0
  396. data/lib/dfp_api/v201208/placement_service.rb +58 -0
  397. data/lib/dfp_api/v201208/placement_service_registry.rb +46 -0
  398. data/lib/dfp_api/v201208/publisher_query_language_service.rb +34 -0
  399. data/lib/dfp_api/v201208/publisher_query_language_service_registry.rb +46 -0
  400. data/lib/dfp_api/v201208/report_service.rb +46 -0
  401. data/lib/dfp_api/v201208/report_service_registry.rb +46 -0
  402. data/lib/dfp_api/v201208/suggested_ad_unit_service.rb +42 -0
  403. data/lib/dfp_api/v201208/suggested_ad_unit_service_registry.rb +46 -0
  404. data/lib/dfp_api/v201208/team_service.rb +54 -0
  405. data/lib/dfp_api/v201208/team_service_registry.rb +46 -0
  406. data/lib/dfp_api/v201208/third_party_slot_service.rb +46 -0
  407. data/lib/dfp_api/v201208/third_party_slot_service_registry.rb +46 -0
  408. data/lib/dfp_api/v201208/user_service.rb +66 -0
  409. data/lib/dfp_api/v201208/user_service_registry.rb +46 -0
  410. data/lib/dfp_api/v201208/user_team_association_service.rb +58 -0
  411. data/lib/dfp_api/v201208/user_team_association_service_registry.rb +46 -0
  412. data/lib/dfp_api/version.rb +1 -1
  413. metadata +175 -4
@@ -0,0 +1,136 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example gets all active content categorized as "comedy" using the
22
+ # network's content browse custom targeting key.
23
+ #
24
+ # This feature is only available to DFP video publishers.
25
+ #
26
+ # Tags: NetworkService.getCurrentNetwork
27
+ # Tags: ContentService.getContentByStatementAndCustomTargetingValue
28
+ # Tags: CustomTargetingService.getCustomTargetingValuesByStatement
29
+
30
+ require 'dfp_api'
31
+
32
+ API_VERSION = :v201208
33
+ PAGE_SIZE = 500
34
+
35
+ def get_content_by_statement()
36
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
37
+ dfp = DfpApi::Api.new
38
+
39
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
40
+ # the configuration file or provide your own logger:
41
+ # dfp.logger = Logger.new('dfp_xml.log')
42
+
43
+ # Get the NetworkService.
44
+ network_service = dfp.service(:NetworkService, API_VERSION)
45
+
46
+ # Get content browse custom targeting key ID.
47
+ current_network = network_service.get_current_network
48
+ content_browse_custom_targeting_key_id =
49
+ current_network[:content_browse_custom_targeting_key_id]
50
+
51
+ # Get the CustomTargetingService.
52
+ custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
53
+
54
+ # Create a statement to select the categories matching the name comedy.
55
+ statement = {
56
+ :query => 'WHERE customTargetingKeyId = :targeting_key_id' +
57
+ ' and name = :category LIMIT 1',
58
+ :values => [
59
+ {:key => 'targeting_key_id',
60
+ :value => {:value => content_browse_custom_targeting_key_id,
61
+ :xsi_type => 'NumberValue'}},
62
+ {:key => 'category',
63
+ :value => {:value => 'comedy',
64
+ :xsi_type => 'TextValue'}},
65
+ ]
66
+ }
67
+
68
+ # Get categories matching the filter statement.
69
+ page = custom_targeting_service.get_custom_targeting_values_by_statement(
70
+ statement)
71
+
72
+ # Get the custom targeting value ID for the comedy category.
73
+ category_custom_targeting_value_id = page[:results].first()[:id]
74
+
75
+ # Get the ContentService.
76
+ content_service = dfp.service(:ContentService, API_VERSION)
77
+
78
+ # Define initial values.
79
+ offset = 0
80
+ page = {}
81
+
82
+ statement_text = 'WHERE status = :status'
83
+ statement = {
84
+ :query => statement_text,
85
+ :values => [
86
+ {:key => 'status',
87
+ :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
88
+ ]
89
+ }
90
+
91
+ begin
92
+ # Create a statement to get one page with current offset.
93
+ statement[:query] = statement_text +
94
+ " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
95
+
96
+ # Get content by statement.
97
+ page = content_service.get_content_by_statement_and_custom_targeting_value(
98
+ statement, category_custom_targeting_value_id)
99
+
100
+ if page[:results]
101
+ # Increase query offset by page size.
102
+ offset += PAGE_SIZE
103
+
104
+ page[:results].each_with_index do |content, index|
105
+ puts "%d) Content ID: %d, name: %s, status: %s." % [index + start_index,
106
+ content[:id], content[:name], content[:status]]
107
+ end
108
+ end
109
+ end while offset < page[:total_result_set_size]
110
+
111
+ # Print a footer.
112
+ if page.include?(:total_result_set_size)
113
+ puts "Number of results found: %d" % page[:total_result_set_size]
114
+ end
115
+ end
116
+
117
+ if __FILE__ == $0
118
+ begin
119
+ get_content_by_statement()
120
+
121
+ # HTTP errors.
122
+ rescue AdsCommon::Errors::HttpError => e
123
+ puts "HTTP Error: %s" % e
124
+
125
+ # API errors.
126
+ rescue DfpApi::Errors::ApiException => e
127
+ puts "Message: %s" % e.message
128
+ puts 'Errors:'
129
+ e.errors.each_with_index do |error, index|
130
+ puts "\tError [%d]:" % (index + 1)
131
+ error.each do |field, value|
132
+ puts "\t\t%s: %s" % [field, value]
133
+ end
134
+ end
135
+ end
136
+ end
@@ -0,0 +1,115 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example copies a given set of image creatives. This would typically be
22
+ # done to reuse creatives in a small business network. To determine which
23
+ # creatives exist, run get_all_creatives.rb.
24
+ #
25
+ # Tags: CreativeService.getCreativesByStatement, CreativeService.createCreatives
26
+
27
+ require 'dfp_api'
28
+
29
+ require 'base64'
30
+
31
+ API_VERSION = :v201208
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/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example creates a new template creative for a given advertiser. To
22
+ # determine which companies are advertisers, run get_companies_by_statement.rb.
23
+ # To determine which creatives already exist, run get_all_creatives.rb. To
24
+ # determine which creative templates run get_all_creative_templates.rb.
25
+ #
26
+ # Tags: CreativeService.createCreative
27
+
28
+ require 'base64'
29
+ require 'dfp_api'
30
+
31
+ API_VERSION = :v201208
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/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example creates new image creatives for a given advertiser. To determine
22
+ # which companies are advertisers, run get_companies_by_statement.rb. To
23
+ # determine which creatives already exist, run get_all_creatives.rb.
24
+ #
25
+ # Tags: CreativeService.createCreatives
26
+
27
+ require 'base64'
28
+ require 'dfp_api'
29
+
30
+ API_VERSION = :v201208
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