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,74 @@
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 a creative template by its ID. To determine which creative
22
+ # templates exist, run get_all_creative_templates.rb.
23
+ #
24
+ # Tags: CreativeTemplateService.getCreativeTemplate
25
+
26
+ require 'dfp_api'
27
+
28
+ API_VERSION = :v201208
29
+
30
+ def get_creative_template()
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 CreativeTemplateService.
39
+ creative_template_service = dfp.service(:CreativeTemplateService, API_VERSION)
40
+
41
+ # Set the ID of the creative_template to get.
42
+ creative_template_id = 'INSERT_CREATIVE_ID_HERE'.to_i
43
+
44
+ # Get the creative_template.
45
+ creative_template =
46
+ creative_template_service.get_creative_template(creative_template_id)
47
+
48
+ if creative_template
49
+ puts "Creative template with ID: %d, name: '%s' and type: '%s' was found." %
50
+ [creative_template[:id], creative_template[:name],
51
+ creative_template[:type]]
52
+ end
53
+ end
54
+
55
+ if __FILE__ == $0
56
+ begin
57
+ get_creative_template()
58
+
59
+ # HTTP errors.
60
+ rescue AdsCommon::Errors::HttpError => e
61
+ puts "HTTP Error: %s" % e
62
+
63
+ # API errors.
64
+ rescue DfpApi::Errors::ApiException => e
65
+ puts "Message: %s" % e.message
66
+ puts 'Errors:'
67
+ e.errors.each_with_index do |error, index|
68
+ puts "\tError [%d]:" % (index + 1)
69
+ error.each do |field, value|
70
+ puts "\t\t%s: %s" % [field, value]
71
+ end
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,80 @@
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 up to 500 system defined creative templates.
22
+ #
23
+ # Tags: CreativeTemplateService.getCreativeTemplatesByStatement
24
+
25
+ require 'dfp_api'
26
+
27
+ API_VERSION = :v201208
28
+
29
+ def get_creative_templates_by_statement()
30
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
31
+ dfp = DfpApi::Api.new
32
+
33
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
+ # the configuration file or provide your own logger:
35
+ # dfp.logger = Logger.new('dfp_xml.log')
36
+
37
+ # Get the CreativeTemplateService.
38
+ creative_template_service = dfp.service(:CreativeTemplateService, API_VERSION)
39
+
40
+ # Create a statement to only select image creative_templates.
41
+ statement = {:query => 'LIMIT 500'}
42
+
43
+ # Get creative templates by statement.
44
+ page =
45
+ creative_template_service.get_creative_templates_by_statement(statement)
46
+
47
+ if page[:results]
48
+ # Print details about each creative template in results.
49
+ page[:results].each_with_index do |template, index|
50
+ puts "%d) Creative template ID: %d, name: %s, type: %s" %
51
+ [index, template[:id], template[:name], template[:type]]
52
+ end
53
+ end
54
+
55
+ # Print a footer.
56
+ if page.include?(:total_result_set_size)
57
+ puts "Total number of creative templates: %d" % page[:total_result_set_size]
58
+ end
59
+ end
60
+
61
+ if __FILE__ == $0
62
+ begin
63
+ get_creative_templates_by_statement()
64
+
65
+ # HTTP errors.
66
+ rescue AdsCommon::Errors::HttpError => e
67
+ puts "HTTP Error: %s" % e
68
+
69
+ # API errors.
70
+ rescue DfpApi::Errors::ApiException => e
71
+ puts "Message: %s" % e.message
72
+ puts 'Errors:'
73
+ e.errors.each_with_index do |error, index|
74
+ puts "\tError [%d]:" % (index + 1)
75
+ error.each do |field, value|
76
+ puts "\t\t%s: %s" % [field, value]
77
+ end
78
+ end
79
+ end
80
+ end
@@ -0,0 +1,87 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2012, 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 custom field options for a drop-down custom field. Once
22
+ # created, custom field options can be found under the options fields of the
23
+ # drop-down custom field and they cannot be deleted. To determine which custom
24
+ # fields exist, run get_all_custom_fields.rb.
25
+ #
26
+ # Tags: CustomFieldService.createCustomFieldOptions
27
+
28
+ require 'dfp_api'
29
+
30
+ API_VERSION = :v201208
31
+
32
+ def create_custom_field_options()
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 CustomFieldService.
41
+ custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
42
+
43
+ # Set the ID of the drop-down custom field to create options for.
44
+ custom_field_id = 'INSERT_DROP_DOWN_CUSTOM_FIELD_ID_HERE'.to_i
45
+
46
+ # Create local custom field options.
47
+ custom_field_options = [
48
+ {
49
+ :display_name => 'Approved',
50
+ :custom_field_id => custom_field_id
51
+ },
52
+ {
53
+ :display_name => 'Unapproved',
54
+ :custom_field_id => custom_field_id
55
+ }
56
+ ]
57
+
58
+ # Create the custom field options on the server.
59
+ return_custom_field_options =
60
+ custom_field_service.create_custom_field_options(custom_field_options)
61
+
62
+ return_custom_field_options.each do |option|
63
+ puts "Custom field option with ID: %d and name: '%s' was created." %
64
+ [option[:id], option[:display_name]]
65
+ end
66
+ end
67
+
68
+ if __FILE__ == $0
69
+ begin
70
+ create_custom_field_options()
71
+
72
+ # HTTP errors.
73
+ rescue AdsCommon::Errors::HttpError => e
74
+ puts "HTTP Error: %s" % e
75
+
76
+ # API errors.
77
+ rescue DfpApi::Errors::ApiException => e
78
+ puts "Message: %s" % e.message
79
+ puts 'Errors:'
80
+ e.errors.each_with_index do |error, index|
81
+ puts "\tError [%d]:" % (index + 1)
82
+ error.each do |field, value|
83
+ puts "\t\t%s: %s" % [field, value]
84
+ end
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,86 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2012, 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 custom fields. To determine which custom fields exist,
22
+ # run get_all_custom_fields.rb.
23
+ #
24
+ # Tags: CustomFieldService.createCustomFields
25
+
26
+ require 'dfp_api'
27
+
28
+ API_VERSION = :v201208
29
+
30
+ def create_custom_fields()
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 CustomFieldService.
39
+ custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
40
+
41
+ # Create local custom field objects.
42
+ custom_fields = [
43
+ {
44
+ :name => 'Customer comments',
45
+ :entity_type => 'LINE_ITEM',
46
+ :data_type => 'STRING',
47
+ :visibility => 'FULL'
48
+ },
49
+ {
50
+ :name => 'Internal approval status',
51
+ :entity_type => 'LINE_ITEM',
52
+ :data_type => 'DROP_DOWN',
53
+ :visibility => 'FULL'
54
+ }
55
+ ]
56
+
57
+ # Create the custom fields on the server.
58
+ return_custom_fields =
59
+ custom_field_service.create_custom_fields(custom_fields)
60
+
61
+ return_custom_fields.each do |custom_field|
62
+ puts "Custom field with ID: %d and name: %s was created." %
63
+ [custom_field[:id], custom_field[:name]]
64
+ end
65
+ end
66
+
67
+ if __FILE__ == $0
68
+ begin
69
+ create_custom_fields()
70
+
71
+ # HTTP errors.
72
+ rescue AdsCommon::Errors::HttpError => e
73
+ puts "HTTP Error: %s" % e
74
+
75
+ # API errors.
76
+ rescue DfpApi::Errors::ApiException => e
77
+ puts "Message: %s" % e.message
78
+ puts 'Errors:'
79
+ e.errors.each_with_index do |error, index|
80
+ puts "\tError [%d]:" % (index + 1)
81
+ error.each do |field, value|
82
+ puts "\t\t%s: %s" % [field, value]
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,112 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2012, 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 deactivates all active line item custom fields. To determine
22
+ # which custom fields exist, run get_all_custom_fields.rb.
23
+ #
24
+ # Tags: CustomFieldService.getCustomFieldsByStatement
25
+ # Tags: CustomFieldService.performCustomFieldAction
26
+
27
+ require 'dfp_api'
28
+
29
+ API_VERSION = :v201208
30
+ PAGE_SIZE = 500
31
+
32
+ def deactivate_all_line_item_custom_fields()
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 CustomFieldService.
41
+ custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
42
+
43
+ # Create statement text to select active ad units.
44
+ statement_text = 'WHERE entityType = :entity_type AND isActive = :is_active'
45
+ statement = {
46
+ :values => [
47
+ {:key => 'entity_type',
48
+ :value => {:value => 'LINE_ITEM', :xsi_type => 'TextValue'}},
49
+ {:key => 'is_active',
50
+ :value => {:value => true, :xsi_type => 'BooleanValue'}}
51
+ ]
52
+ }
53
+
54
+ # Define initial values.
55
+ offset = 0
56
+ page = {}
57
+
58
+ begin
59
+ # Create a statement to get one page with the current offset.
60
+ statement[:query] = statement_text +
61
+ " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
62
+
63
+ # Get custom fields by statement.
64
+ page = custom_field_service.get_custom_fields_by_statement(statement)
65
+
66
+ if page[:results]
67
+ # Increase query offset by page size.
68
+ offset += PAGE_SIZE
69
+ start_index = page[:start_index]
70
+
71
+ page[:results].each_with_index do |custom_field, index|
72
+ puts "%d) Custom field with ID: %d and name: '%s' will be deactivated" %
73
+ [index + start_index, custom_field[:id], custom_field[:name]]
74
+ end
75
+ end
76
+ end while offset < page[:total_result_set_size]
77
+
78
+ # Update statement for action.
79
+ statement[:query] = statement_text
80
+
81
+ # Perform action.
82
+ result = custom_field_service.perform_custom_field_action(
83
+ {:xsi_type => 'DeactivateCustomFields'}, statement)
84
+
85
+ # Display results.
86
+ if result and result[:num_changes] > 0
87
+ puts "Number of custom fields deactivated: %d" % result[:num_changes]
88
+ else
89
+ puts 'No custom fields were deactivated.'
90
+ end
91
+ end
92
+
93
+ if __FILE__ == $0
94
+ begin
95
+ deactivate_all_line_item_custom_fields()
96
+
97
+ # HTTP errors.
98
+ rescue AdsCommon::Errors::HttpError => e
99
+ puts "HTTP Error: %s" % e
100
+
101
+ # API errors.
102
+ rescue DfpApi::Errors::ApiException => e
103
+ puts "Message: %s" % e.message
104
+ puts 'Errors:'
105
+ e.errors.each_with_index do |error, index|
106
+ puts "\tError [%d]:" % (index + 1)
107
+ error.each do |field, value|
108
+ puts "\t\t%s: %s" % [field, value]
109
+ end
110
+ end
111
+ end
112
+ end
@@ -0,0 +1,102 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2012, 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 custom fields. To create custom fields, run
22
+ # create_custom_fields.rb.
23
+ #
24
+ # Tags: CustomFieldService.getCustomFieldsByStatement
25
+
26
+ require 'dfp_api'
27
+
28
+ API_VERSION = :v201208
29
+ PAGE_SIZE = 500
30
+
31
+ def get_all_custom_fields()
32
+ # Get DfpApi instance and load configuration from ~/dfp_api.yml.
33
+ dfp = DfpApi::Api.new
34
+
35
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
36
+ # the configuration file or provide your own logger:
37
+ # dfp.logger = Logger.new('dfp_xml.log')
38
+
39
+ # Get the CustomFieldService.
40
+ custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
41
+
42
+ # Define initial values.
43
+ offset = 0
44
+ page = {}
45
+
46
+ begin
47
+ # Create a statement to get one page with current offset.
48
+ statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
49
+
50
+ # Get custom fields by statement.
51
+ page = custom_field_service.get_custom_fields_by_statement(statement)
52
+
53
+ if page[:results]
54
+ # Increase query offset by page size.
55
+ offset += PAGE_SIZE
56
+
57
+ # Get the start index for printout.
58
+ start_index = page[:start_index]
59
+
60
+ # Print details about each custom field in results.
61
+ page[:results].each_with_index do |custom_field, index|
62
+ if custom_field[:custom_field_type].eql?('DropDownCustomField')
63
+ drop_down_custom_field_string = custom_field.include?(:options) ?
64
+ custom_field[:options].map {|option| option[:display_name]} : []
65
+ print ("%d) Drop-down custom field with ID %d, name '%s', and " +
66
+ "options [%s] was found.") %
67
+ [index + start_index, custom_field[:id], custom_field[:name],
68
+ drop_down_custom_field_strings.join(', ')]
69
+ else
70
+ puts "%d) Custom field ID: %d and name: '%s' was found" %
71
+ [index + start_index, custom_field[:id], custom_field[:name]]
72
+ end
73
+ end
74
+ end
75
+ end while offset < page[:total_result_set_size]
76
+
77
+ # Print a footer.
78
+ if page.include?(:total_result_set_size)
79
+ puts "Total number of custom fields: %d" % page[:total_result_set_size]
80
+ end
81
+ end
82
+
83
+ if __FILE__ == $0
84
+ begin
85
+ get_all_custom_fields()
86
+
87
+ # HTTP errors.
88
+ rescue AdsCommon::Errors::HttpError => e
89
+ puts "HTTP Error: %s" % e
90
+
91
+ # API errors.
92
+ rescue DfpApi::Errors::ApiException => e
93
+ puts "Message: %s" % e.message
94
+ puts 'Errors:'
95
+ e.errors.each_with_index do |error, index|
96
+ puts "\tError [%d]:" % (index + 1)
97
+ error.each do |field, value|
98
+ puts "\t\t%s: %s" % [field, value]
99
+ end
100
+ end
101
+ end
102
+ end