google-dfp-api 0.9.2 → 0.9.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (370) hide show
  1. checksums.yaml +15 -0
  2. data/ChangeLog +6 -0
  3. data/examples/{v201311 → v201411}/activity_group_service/create_activity_groups.rb +1 -1
  4. data/examples/{v201311 → v201411}/activity_group_service/get_active_activity_groups.rb +18 -27
  5. data/examples/{v201311 → v201411}/activity_group_service/get_all_activity_groups.rb +13 -23
  6. data/examples/{v201311 → v201411}/activity_group_service/update_activity_groups.rb +25 -14
  7. data/examples/{v201311 → v201411}/activity_service/create_activities.rb +1 -1
  8. data/examples/{v201311 → v201411}/activity_service/get_active_activities.rb +15 -27
  9. data/examples/{v201311 → v201411}/activity_service/get_all_activities.rb +10 -21
  10. data/examples/{v201311 → v201411}/activity_service/update_activities.rb +32 -16
  11. data/examples/{v201311 → v201411}/audience_segment_service/create_audience_segments.rb +1 -1
  12. data/examples/{v201311 → v201411}/audience_segment_service/get_all_audience_segments.rb +10 -19
  13. data/examples/{v201311 → v201411}/audience_segment_service/get_first_party_audience_segments.rb +14 -21
  14. data/examples/{v201311 → v201411}/audience_segment_service/populate_first_party_audience_segments.rb +16 -13
  15. data/examples/{v201311 → v201411}/audience_segment_service/update_audience_segments.rb +12 -11
  16. data/examples/{v201311 → v201411}/common/error_handling.rb +1 -1
  17. data/examples/{v201311 → v201411}/common/oauth2_jwt_handling.rb +9 -17
  18. data/examples/{v201311 → v201411}/common/setup_oauth2.rb +1 -1
  19. data/examples/{v201311 → v201411}/company_service/create_companies.rb +1 -1
  20. data/examples/{v201311 → v201411}/company_service/get_all_companies.rb +10 -18
  21. data/examples/{v201311 → v201411}/company_service/get_companies_by_statement.rb +21 -16
  22. data/examples/{v201311 → v201411}/company_service/update_companies.rb +17 -11
  23. data/examples/{v201311 → v201411}/contact_service/create_contacts.rb +1 -1
  24. data/examples/{v201311 → v201411}/contact_service/get_all_contacts.rb +11 -19
  25. data/examples/{v201311 → v201411}/contact_service/get_uninvited_contacts.rb +18 -22
  26. data/examples/{v201311 → v201411}/contact_service/update_contacts.rb +33 -17
  27. data/examples/v201411/content_metadata_key_hierarchy_service/create_content_metadata_key_hierarchies.rb +96 -0
  28. data/examples/v201411/content_metadata_key_hierarchy_service/delete_content_metadata_key_hierarchies.rb +106 -0
  29. data/examples/v201411/content_metadata_key_hierarchy_service/get_all_content_metadata_key_hierarchies.rb +89 -0
  30. data/examples/v201411/content_metadata_key_hierarchy_service/update_content_metadata_key_hierarchies.rb +115 -0
  31. data/examples/{v201311 → v201411}/content_service/get_all_content.rb +9 -18
  32. data/examples/{v201311 → v201411}/content_service/get_content_by_category.rb +18 -28
  33. data/examples/{v201311 → v201411}/creative_service/copy_image_creatives.rb +7 -7
  34. data/examples/{v201311 → v201411}/creative_service/create_creative_from_template.rb +1 -1
  35. data/examples/{v201311 → v201411}/creative_service/create_creatives.rb +1 -1
  36. data/examples/{v201311 → v201411}/creative_service/create_custom_creative.rb +1 -1
  37. data/examples/{v201311 → v201411}/creative_service/get_all_creatives.rb +8 -17
  38. data/examples/{v201311 → v201411}/creative_service/get_creatives_by_statement.rb +18 -13
  39. data/examples/{v201311 → v201411}/creative_service/update_creatives.rb +16 -11
  40. data/examples/{v201311 → v201411}/creative_set_service/associate_creative_set_to_line_item.rb +1 -1
  41. data/examples/{v201311 → v201411}/creative_set_service/create_creative_set.rb +1 -1
  42. data/examples/{v201311 → v201411}/creative_set_service/get_all_creative_sets.rb +9 -17
  43. data/examples/{v201311 → v201411}/creative_set_service/get_creative_sets_by_statement.rb +20 -14
  44. data/examples/{v201311 → v201411}/creative_set_service/update_creative_sets.rb +33 -15
  45. data/examples/{v201311 → v201411}/creative_template_service/get_all_creative_templates.rb +9 -17
  46. data/examples/{v201311/creative_template_service/get_creative_templates_by_statement.rb → v201411/creative_template_service/get_system_defined_creative_templates.rb} +24 -13
  47. data/examples/{v201311 → v201411}/creative_wrapper_service/create_creative_wrappers.rb +1 -1
  48. data/examples/{v201311 → v201411}/creative_wrapper_service/deactivate_creative_wrapper.rb +9 -7
  49. data/examples/{v201311 → v201411}/creative_wrapper_service/get_all_creative_wrappers.rb +10 -18
  50. data/examples/{v201311 → v201411}/creative_wrapper_service/get_creative_wrappers_by_statement.rb +17 -12
  51. data/examples/{v201311 → v201411}/creative_wrapper_service/update_creative_wrappers.rb +34 -16
  52. data/examples/{v201311 → v201411}/custom_field_service/create_custom_field_options.rb +1 -1
  53. data/examples/{v201311 → v201411}/custom_field_service/create_custom_fields.rb +1 -1
  54. data/examples/{v201311 → v201411}/custom_field_service/deactivate_all_line_item_custom_fields.rb +13 -23
  55. data/examples/{v201311 → v201411}/custom_field_service/get_all_custom_fields.rb +11 -19
  56. data/examples/{v201311 → v201411}/custom_field_service/get_all_line_item_custom_fields.rb +19 -14
  57. data/examples/{v201311 → v201411}/custom_field_service/set_line_item_custom_field_value.rb +59 -11
  58. data/examples/{v201311 → v201411}/custom_field_service/update_custom_fields.rb +33 -15
  59. data/examples/{v201311 → v201411}/custom_targeting_service/create_custom_targeting_keys_and_values.rb +1 -1
  60. data/examples/{v201311 → v201411}/custom_targeting_service/delete_custom_targeting_keys.rb +16 -20
  61. data/examples/{v201311 → v201411}/custom_targeting_service/delete_custom_targeting_values.rb +23 -21
  62. data/examples/{v201311 → v201411}/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb +15 -36
  63. data/examples/{v201311 → v201411}/custom_targeting_service/get_custom_targeting_keys_by_statement.rb +20 -16
  64. data/examples/{v201311 → v201411}/custom_targeting_service/get_custom_targeting_values_by_statement.rb +19 -15
  65. data/examples/{v201311 → v201411}/custom_targeting_service/update_custom_targeting_keys.rb +4 -3
  66. data/examples/{v201311 → v201411}/custom_targeting_service/update_custom_targeting_values.rb +34 -30
  67. data/examples/{v201311 → v201411}/forecast_service/get_forecast.rb +6 -3
  68. data/examples/{v201311 → v201411}/forecast_service/get_forecast_by_id.rb +1 -1
  69. data/examples/{v201311 → v201411}/inventory_service/create_ad_units.rb +1 -1
  70. data/examples/{v201311 → v201411}/inventory_service/create_mobile_ad_unit.rb +1 -1
  71. data/examples/{v201311 → v201411}/inventory_service/create_video_ad_unit.rb +1 -1
  72. data/examples/{v201311 → v201411}/inventory_service/deactivate_ad_units.rb +19 -23
  73. data/examples/{v201311 → v201411}/inventory_service/get_ad_unit_sizes.rb +7 -14
  74. data/examples/{v201311 → v201411}/inventory_service/get_ad_units_by_statement.rb +18 -13
  75. data/examples/{v201311 → v201411}/inventory_service/get_all_ad_units.rb +8 -17
  76. data/examples/{v201311 → v201411}/inventory_service/update_ad_units.rb +23 -11
  77. data/examples/{v201311 → v201411}/label_service/create_labels.rb +1 -1
  78. data/examples/{v201311 → v201411}/label_service/deactivate_labels.rb +15 -22
  79. data/examples/{v201311 → v201411}/label_service/get_all_labels.rb +9 -18
  80. data/examples/{v201311 → v201411}/label_service/get_labels_by_statement.rb +16 -11
  81. data/examples/{v201311 → v201411}/label_service/update_labels.rb +24 -26
  82. data/examples/{v201311 → v201411}/line_item_creative_association_service/create_licas.rb +1 -1
  83. data/examples/{v201311 → v201411}/line_item_creative_association_service/deactivate_licas.rb +15 -24
  84. data/examples/{v201311 → v201411}/line_item_creative_association_service/get_all_licas.rb +8 -17
  85. data/examples/{v201311 → v201411}/line_item_creative_association_service/get_licas_by_statement.rb +10 -8
  86. data/examples/{v201311 → v201411}/line_item_creative_association_service/update_licas.rb +16 -7
  87. data/examples/{v201311 → v201411}/line_item_service/activate_line_items.rb +13 -21
  88. data/examples/{v201311 → v201411}/line_item_service/create_line_items.rb +6 -3
  89. data/examples/{v201311 → v201411}/line_item_service/create_video_line_item.rb +8 -2
  90. data/examples/{v201311 → v201411}/line_item_service/get_all_line_items.rb +9 -17
  91. data/examples/{v201311 → v201411}/line_item_service/get_line_items_by_statement.rb +19 -17
  92. data/examples/{v201311 → v201411}/line_item_service/get_recently_updated_line_items.rb +19 -13
  93. data/examples/{v201311 → v201411}/line_item_service/target_custom_criteria.rb +31 -15
  94. data/examples/{v201311 → v201411}/line_item_service/update_line_items.rb +9 -9
  95. data/examples/{v201311 → v201411}/network_service/get_all_networks.rb +1 -1
  96. data/examples/{v201311 → v201411}/network_service/get_current_network.rb +1 -1
  97. data/examples/{v201311 → v201411}/network_service/make_test_network.rb +1 -1
  98. data/examples/{v201311 → v201411}/order_service/approve_orders.rb +16 -24
  99. data/examples/{v201311 → v201411}/order_service/create_orders.rb +1 -1
  100. data/examples/{v201311 → v201411}/order_service/get_all_orders.rb +8 -17
  101. data/examples/{v201311 → v201411}/order_service/get_orders_by_statement.rb +18 -14
  102. data/examples/{v201311 → v201411}/order_service/update_orders.rb +15 -7
  103. data/examples/{v201311 → v201411}/placement_service/create_placements.rb +4 -2
  104. data/examples/{v201311 → v201411}/placement_service/deactivate_placements.rb +14 -22
  105. data/examples/{v201311 → v201411}/placement_service/get_all_placements.rb +9 -17
  106. data/examples/{v201311 → v201411}/placement_service/get_placements_by_statement.rb +18 -13
  107. data/examples/{v201311 → v201411}/placement_service/update_placements.rb +16 -6
  108. data/examples/{v201311 → v201411}/publisher_query_language_service/fetch_match_tables.rb +9 -11
  109. data/examples/{v201311 → v201411}/publisher_query_language_service/get_all_line_items.rb +8 -9
  110. data/examples/{v201311 → v201411}/publisher_query_language_service/get_geo_targets.rb +10 -10
  111. data/examples/{v201311 → v201411}/publisher_query_language_service/get_line_items_named_like.rb +10 -10
  112. data/examples/{v201311 → v201411}/report_service/display_report.rb +1 -1
  113. data/examples/{v201311 → v201411}/report_service/download_report.rb +1 -1
  114. data/examples/{v201311 → v201411}/report_service/run_delivery_report.rb +1 -1
  115. data/examples/{v201311 → v201411}/report_service/run_inventory_report.rb +4 -4
  116. data/examples/{v201311 → v201411}/report_service/run_reach_report.rb +1 -1
  117. data/examples/{v201311/report_service/run_merged_delivery_report.rb → v201411/report_service/run_report_with_custom_fields.rb} +12 -14
  118. data/examples/{v201311 → v201411}/report_service/run_sales_report.rb +1 -1
  119. data/examples/{v201311 → v201411}/suggested_ad_unit_service/approve_all_suggested_ad_units.rb +25 -21
  120. data/examples/{v201311 → v201411}/suggested_ad_unit_service/get_all_suggested_ad_units.rb +9 -18
  121. data/examples/{v201311 → v201411}/suggested_ad_unit_service/get_suggested_ad_units_by_statement.rb +24 -21
  122. data/examples/{v201311 → v201411}/team_service/create_teams.rb +1 -1
  123. data/examples/{v201311 → v201411}/team_service/get_all_teams.rb +8 -17
  124. data/examples/{v201311 → v201411}/team_service/get_teams_by_statement.rb +15 -11
  125. data/examples/{v201311 → v201411}/team_service/update_teams.rb +4 -3
  126. data/examples/{v201311 → v201411}/user_service/create_users.rb +1 -1
  127. data/examples/{v201311 → v201411}/user_service/deactivate_users.rb +7 -7
  128. data/examples/{v201311 → v201411}/user_service/get_all_roles.rb +1 -1
  129. data/examples/{v201311 → v201411}/user_service/get_all_users.rb +8 -18
  130. data/examples/{v201311 → v201411}/user_service/get_current_user.rb +1 -1
  131. data/examples/{v201311 → v201411}/user_service/get_users_by_statement.rb +17 -12
  132. data/examples/{v201311 → v201411}/user_service/update_users.rb +15 -6
  133. data/examples/{v201311 → v201411}/user_team_association_service/create_user_team_associations.rb +1 -1
  134. data/examples/{v201311 → v201411}/user_team_association_service/delete_user_team_associations.rb +13 -21
  135. data/examples/{v201311 → v201411}/user_team_association_service/get_all_user_team_associations.rb +10 -17
  136. data/examples/{v201311 → v201411}/user_team_association_service/get_user_team_associations_by_statement.rb +20 -16
  137. data/examples/{v201311 → v201411}/user_team_association_service/update_user_team_associations.rb +8 -7
  138. data/lib/dfp_api/api_config.rb +26 -3
  139. data/lib/dfp_api/{v201302 → v201411}/activity_group_service.rb +6 -18
  140. data/lib/dfp_api/v201411/activity_group_service_registry.rb +46 -0
  141. data/lib/dfp_api/{v201302 → v201411}/activity_service.rb +6 -18
  142. data/lib/dfp_api/v201411/activity_service_registry.rb +46 -0
  143. data/lib/dfp_api/v201411/ad_exclusion_rule_service.rb +46 -0
  144. data/lib/dfp_api/v201411/ad_exclusion_rule_service_registry.rb +46 -0
  145. data/lib/dfp_api/{v201302 → v201411}/ad_rule_service.rb +6 -18
  146. data/lib/dfp_api/v201411/ad_rule_service_registry.rb +46 -0
  147. data/lib/dfp_api/{v201208 → v201411}/audience_segment_service.rb +18 -6
  148. data/lib/dfp_api/v201411/audience_segment_service_registry.rb +46 -0
  149. data/lib/dfp_api/v201411/base_rate_service.rb +46 -0
  150. data/lib/dfp_api/v201411/base_rate_service_registry.rb +46 -0
  151. data/lib/dfp_api/{v201208 → v201411}/company_service.rb +6 -18
  152. data/lib/dfp_api/v201411/company_service_registry.rb +46 -0
  153. data/lib/dfp_api/{v201302 → v201411}/contact_service.rb +6 -18
  154. data/lib/dfp_api/v201411/contact_service_registry.rb +46 -0
  155. data/lib/dfp_api/{v201302 → v201411}/content_bundle_service.rb +6 -18
  156. data/lib/dfp_api/v201411/content_bundle_service_registry.rb +46 -0
  157. data/lib/dfp_api/v201411/content_metadata_key_hierarchy_service.rb +46 -0
  158. data/lib/dfp_api/v201411/content_metadata_key_hierarchy_service_registry.rb +46 -0
  159. data/lib/dfp_api/{v201302 → v201411}/content_service.rb +6 -6
  160. data/lib/dfp_api/v201411/content_service_registry.rb +46 -0
  161. data/lib/dfp_api/{v201208 → v201411}/creative_service.rb +6 -18
  162. data/lib/dfp_api/v201411/creative_service_registry.rb +46 -0
  163. data/lib/dfp_api/{v201208 → v201411}/creative_set_service.rb +6 -10
  164. data/lib/dfp_api/v201411/creative_set_service_registry.rb +46 -0
  165. data/lib/dfp_api/{v201211 → v201411}/creative_template_service.rb +6 -10
  166. data/lib/dfp_api/v201411/creative_template_service_registry.rb +46 -0
  167. data/lib/dfp_api/{v201211 → v201411}/creative_wrapper_service.rb +6 -18
  168. data/lib/dfp_api/v201411/creative_wrapper_service_registry.rb +46 -0
  169. data/lib/dfp_api/{v201302 → v201411}/custom_field_service.rb +6 -26
  170. data/lib/dfp_api/v201411/custom_field_service_registry.rb +46 -0
  171. data/lib/dfp_api/{v201208 → v201411}/custom_targeting_service.rb +6 -6
  172. data/lib/dfp_api/v201411/custom_targeting_service_registry.rb +46 -0
  173. data/lib/dfp_api/v201411/exchange_rate_service.rb +46 -0
  174. data/lib/dfp_api/v201411/exchange_rate_service_registry.rb +46 -0
  175. data/lib/dfp_api/{v201211 → v201411}/forecast_service.rb +6 -6
  176. data/lib/dfp_api/v201411/forecast_service_registry.rb +46 -0
  177. data/lib/dfp_api/{v201211 → v201411}/inventory_service.rb +6 -18
  178. data/lib/dfp_api/v201411/inventory_service_registry.rb +46 -0
  179. data/lib/dfp_api/{v201211 → v201411}/label_service.rb +6 -18
  180. data/lib/dfp_api/v201411/label_service_registry.rb +46 -0
  181. data/lib/dfp_api/{v201211 → v201411}/line_item_creative_association_service.rb +6 -18
  182. data/lib/dfp_api/v201411/line_item_creative_association_service_registry.rb +46 -0
  183. data/lib/dfp_api/{v201211 → v201411}/line_item_service.rb +6 -18
  184. data/lib/dfp_api/v201411/line_item_service_registry.rb +46 -0
  185. data/lib/dfp_api/v201411/line_item_template_service.rb +34 -0
  186. data/lib/dfp_api/v201411/line_item_template_service_registry.rb +46 -0
  187. data/lib/dfp_api/v201411/live_stream_event_service.rb +46 -0
  188. data/lib/dfp_api/v201411/live_stream_event_service_registry.rb +46 -0
  189. data/lib/dfp_api/{v201211 → v201411}/network_service.rb +6 -6
  190. data/lib/dfp_api/v201411/network_service_registry.rb +46 -0
  191. data/lib/dfp_api/{v201302 → v201411}/order_service.rb +6 -18
  192. data/lib/dfp_api/v201411/order_service_registry.rb +46 -0
  193. data/lib/dfp_api/{v201211 → v201411}/placement_service.rb +6 -18
  194. data/lib/dfp_api/v201411/placement_service_registry.rb +46 -0
  195. data/lib/dfp_api/v201411/premium_rate_service.rb +42 -0
  196. data/lib/dfp_api/v201411/premium_rate_service_registry.rb +46 -0
  197. data/lib/dfp_api/v201411/product_service.rb +42 -0
  198. data/lib/dfp_api/v201411/product_service_registry.rb +46 -0
  199. data/lib/dfp_api/v201411/product_template_service.rb +46 -0
  200. data/lib/dfp_api/v201411/product_template_service_registry.rb +46 -0
  201. data/lib/dfp_api/v201411/proposal_line_item_service.rb +46 -0
  202. data/lib/dfp_api/v201411/proposal_line_item_service_registry.rb +46 -0
  203. data/lib/dfp_api/v201411/proposal_service.rb +46 -0
  204. data/lib/dfp_api/v201411/proposal_service_registry.rb +46 -0
  205. data/lib/dfp_api/{v201211 → v201411}/publisher_query_language_service.rb +6 -6
  206. data/lib/dfp_api/v201411/publisher_query_language_service_registry.rb +46 -0
  207. data/lib/dfp_api/v201411/rate_card_service.rb +46 -0
  208. data/lib/dfp_api/v201411/rate_card_service_registry.rb +46 -0
  209. data/lib/dfp_api/v201411/reconciliation_order_report_service.rb +38 -0
  210. data/lib/dfp_api/v201411/reconciliation_order_report_service_registry.rb +46 -0
  211. data/lib/dfp_api/v201411/reconciliation_report_row_service.rb +38 -0
  212. data/lib/dfp_api/v201411/reconciliation_report_row_service_registry.rb +46 -0
  213. data/lib/dfp_api/v201411/reconciliation_report_service.rb +38 -0
  214. data/lib/dfp_api/v201411/reconciliation_report_service_registry.rb +46 -0
  215. data/lib/dfp_api/{v201302 → v201411}/report_service.rb +6 -6
  216. data/lib/dfp_api/v201411/report_service_registry.rb +46 -0
  217. data/lib/dfp_api/v201411/shared_ad_unit_service.rb +38 -0
  218. data/lib/dfp_api/v201411/shared_ad_unit_service_registry.rb +46 -0
  219. data/lib/dfp_api/{v201211 → v201411}/suggested_ad_unit_service.rb +6 -10
  220. data/lib/dfp_api/v201411/suggested_ad_unit_service_registry.rb +46 -0
  221. data/lib/dfp_api/{v201302 → v201411}/team_service.rb +6 -18
  222. data/lib/dfp_api/v201411/team_service_registry.rb +46 -0
  223. data/lib/dfp_api/{v201208 → v201411}/user_service.rb +6 -18
  224. data/lib/dfp_api/v201411/user_service_registry.rb +46 -0
  225. data/lib/dfp_api/{v201211 → v201411}/user_team_association_service.rb +6 -18
  226. data/lib/dfp_api/v201411/user_team_association_service_registry.rb +46 -0
  227. data/lib/dfp_api/v201411/workflow_request_service.rb +38 -0
  228. data/lib/dfp_api/v201411/workflow_request_service_registry.rb +46 -0
  229. data/lib/dfp_api/version.rb +1 -1
  230. data/lib/dfp_api_statement.rb +5 -1
  231. metadata +1118 -1190
  232. data/examples/v201311/company_service/get_company.rb +0 -72
  233. data/examples/v201311/creative_service/get_creative.rb +0 -72
  234. data/examples/v201311/creative_template_service/get_creative_template.rb +0 -74
  235. data/examples/v201311/inventory_service/get_ad_unit.rb +0 -72
  236. data/examples/v201311/label_service/get_label.rb +0 -76
  237. data/examples/v201311/line_item_creative_association_service/get_lica.rb +0 -77
  238. data/examples/v201311/line_item_service/create_mobile_line_item.rb +0 -135
  239. data/examples/v201311/line_item_service/get_line_item.rb +0 -74
  240. data/examples/v201311/order_service/get_order.rb +0 -74
  241. data/examples/v201311/placement_service/get_placement.rb +0 -74
  242. data/examples/v201311/report_service/run_report_with_custom_fields.rb +0 -135
  243. data/examples/v201311/suggested_ad_unit_service/get_suggested_ad_unit.rb +0 -75
  244. data/examples/v201311/team_service/get_team.rb +0 -74
  245. data/examples/v201311/user_service/get_user.rb +0 -73
  246. data/examples/v201311/user_team_association_service/get_user_team_association.rb +0 -76
  247. data/lib/dfp_api/v201208/audience_segment_service_registry.rb +0 -46
  248. data/lib/dfp_api/v201208/company_service_registry.rb +0 -46
  249. data/lib/dfp_api/v201208/content_service.rb +0 -42
  250. data/lib/dfp_api/v201208/content_service_registry.rb +0 -46
  251. data/lib/dfp_api/v201208/creative_service_registry.rb +0 -46
  252. data/lib/dfp_api/v201208/creative_set_service_registry.rb +0 -46
  253. data/lib/dfp_api/v201208/creative_template_service.rb +0 -38
  254. data/lib/dfp_api/v201208/creative_template_service_registry.rb +0 -46
  255. data/lib/dfp_api/v201208/custom_field_service.rb +0 -78
  256. data/lib/dfp_api/v201208/custom_field_service_registry.rb +0 -46
  257. data/lib/dfp_api/v201208/custom_targeting_service_registry.rb +0 -46
  258. data/lib/dfp_api/v201208/forecast_service.rb +0 -38
  259. data/lib/dfp_api/v201208/forecast_service_registry.rb +0 -46
  260. data/lib/dfp_api/v201208/inventory_service.rb +0 -62
  261. data/lib/dfp_api/v201208/inventory_service_registry.rb +0 -46
  262. data/lib/dfp_api/v201208/label_service.rb +0 -58
  263. data/lib/dfp_api/v201208/label_service_registry.rb +0 -46
  264. data/lib/dfp_api/v201208/line_item_creative_association_service.rb +0 -62
  265. data/lib/dfp_api/v201208/line_item_creative_association_service_registry.rb +0 -46
  266. data/lib/dfp_api/v201208/line_item_service.rb +0 -58
  267. data/lib/dfp_api/v201208/line_item_service_registry.rb +0 -46
  268. data/lib/dfp_api/v201208/network_service.rb +0 -46
  269. data/lib/dfp_api/v201208/network_service_registry.rb +0 -46
  270. data/lib/dfp_api/v201208/order_service.rb +0 -58
  271. data/lib/dfp_api/v201208/order_service_registry.rb +0 -46
  272. data/lib/dfp_api/v201208/placement_service.rb +0 -58
  273. data/lib/dfp_api/v201208/placement_service_registry.rb +0 -46
  274. data/lib/dfp_api/v201208/publisher_query_language_service.rb +0 -34
  275. data/lib/dfp_api/v201208/publisher_query_language_service_registry.rb +0 -46
  276. data/lib/dfp_api/v201208/report_service.rb +0 -46
  277. data/lib/dfp_api/v201208/report_service_registry.rb +0 -46
  278. data/lib/dfp_api/v201208/suggested_ad_unit_service.rb +0 -42
  279. data/lib/dfp_api/v201208/suggested_ad_unit_service_registry.rb +0 -46
  280. data/lib/dfp_api/v201208/team_service.rb +0 -54
  281. data/lib/dfp_api/v201208/team_service_registry.rb +0 -46
  282. data/lib/dfp_api/v201208/third_party_slot_service.rb +0 -46
  283. data/lib/dfp_api/v201208/third_party_slot_service_registry.rb +0 -46
  284. data/lib/dfp_api/v201208/user_service_registry.rb +0 -46
  285. data/lib/dfp_api/v201208/user_team_association_service.rb +0 -58
  286. data/lib/dfp_api/v201208/user_team_association_service_registry.rb +0 -46
  287. data/lib/dfp_api/v201211/audience_segment_service.rb +0 -34
  288. data/lib/dfp_api/v201211/audience_segment_service_registry.rb +0 -46
  289. data/lib/dfp_api/v201211/company_service.rb +0 -54
  290. data/lib/dfp_api/v201211/company_service_registry.rb +0 -46
  291. data/lib/dfp_api/v201211/content_service.rb +0 -42
  292. data/lib/dfp_api/v201211/content_service_registry.rb +0 -46
  293. data/lib/dfp_api/v201211/creative_service.rb +0 -54
  294. data/lib/dfp_api/v201211/creative_service_registry.rb +0 -46
  295. data/lib/dfp_api/v201211/creative_set_service.rb +0 -46
  296. data/lib/dfp_api/v201211/creative_set_service_registry.rb +0 -46
  297. data/lib/dfp_api/v201211/creative_template_service_registry.rb +0 -46
  298. data/lib/dfp_api/v201211/creative_wrapper_service_registry.rb +0 -46
  299. data/lib/dfp_api/v201211/custom_field_service.rb +0 -78
  300. data/lib/dfp_api/v201211/custom_field_service_registry.rb +0 -46
  301. data/lib/dfp_api/v201211/custom_targeting_service.rb +0 -62
  302. data/lib/dfp_api/v201211/custom_targeting_service_registry.rb +0 -46
  303. data/lib/dfp_api/v201211/forecast_service_registry.rb +0 -46
  304. data/lib/dfp_api/v201211/inventory_service_registry.rb +0 -46
  305. data/lib/dfp_api/v201211/label_service_registry.rb +0 -46
  306. data/lib/dfp_api/v201211/line_item_creative_association_service_registry.rb +0 -46
  307. data/lib/dfp_api/v201211/line_item_service_registry.rb +0 -46
  308. data/lib/dfp_api/v201211/network_service_registry.rb +0 -46
  309. data/lib/dfp_api/v201211/order_service.rb +0 -58
  310. data/lib/dfp_api/v201211/order_service_registry.rb +0 -46
  311. data/lib/dfp_api/v201211/placement_service_registry.rb +0 -46
  312. data/lib/dfp_api/v201211/publisher_query_language_service_registry.rb +0 -46
  313. data/lib/dfp_api/v201211/report_service.rb +0 -46
  314. data/lib/dfp_api/v201211/report_service_registry.rb +0 -46
  315. data/lib/dfp_api/v201211/suggested_ad_unit_service_registry.rb +0 -46
  316. data/lib/dfp_api/v201211/team_service.rb +0 -54
  317. data/lib/dfp_api/v201211/team_service_registry.rb +0 -46
  318. data/lib/dfp_api/v201211/third_party_slot_service.rb +0 -46
  319. data/lib/dfp_api/v201211/third_party_slot_service_registry.rb +0 -46
  320. data/lib/dfp_api/v201211/user_service.rb +0 -66
  321. data/lib/dfp_api/v201211/user_service_registry.rb +0 -46
  322. data/lib/dfp_api/v201211/user_team_association_service_registry.rb +0 -46
  323. data/lib/dfp_api/v201302/activity_group_service_registry.rb +0 -46
  324. data/lib/dfp_api/v201302/activity_service_registry.rb +0 -46
  325. data/lib/dfp_api/v201302/ad_rule_service_registry.rb +0 -46
  326. data/lib/dfp_api/v201302/audience_segment_service.rb +0 -34
  327. data/lib/dfp_api/v201302/audience_segment_service_registry.rb +0 -46
  328. data/lib/dfp_api/v201302/company_service.rb +0 -54
  329. data/lib/dfp_api/v201302/company_service_registry.rb +0 -46
  330. data/lib/dfp_api/v201302/contact_service_registry.rb +0 -46
  331. data/lib/dfp_api/v201302/content_bundle_service_registry.rb +0 -46
  332. data/lib/dfp_api/v201302/content_service_registry.rb +0 -46
  333. data/lib/dfp_api/v201302/creative_service.rb +0 -54
  334. data/lib/dfp_api/v201302/creative_service_registry.rb +0 -46
  335. data/lib/dfp_api/v201302/creative_set_service.rb +0 -46
  336. data/lib/dfp_api/v201302/creative_set_service_registry.rb +0 -46
  337. data/lib/dfp_api/v201302/creative_template_service.rb +0 -38
  338. data/lib/dfp_api/v201302/creative_template_service_registry.rb +0 -46
  339. data/lib/dfp_api/v201302/creative_wrapper_service.rb +0 -58
  340. data/lib/dfp_api/v201302/creative_wrapper_service_registry.rb +0 -46
  341. data/lib/dfp_api/v201302/custom_field_service_registry.rb +0 -46
  342. data/lib/dfp_api/v201302/custom_targeting_service.rb +0 -62
  343. data/lib/dfp_api/v201302/custom_targeting_service_registry.rb +0 -46
  344. data/lib/dfp_api/v201302/forecast_service.rb +0 -38
  345. data/lib/dfp_api/v201302/forecast_service_registry.rb +0 -46
  346. data/lib/dfp_api/v201302/inventory_service.rb +0 -62
  347. data/lib/dfp_api/v201302/inventory_service_registry.rb +0 -46
  348. data/lib/dfp_api/v201302/label_service.rb +0 -58
  349. data/lib/dfp_api/v201302/label_service_registry.rb +0 -46
  350. data/lib/dfp_api/v201302/line_item_creative_association_service.rb +0 -62
  351. data/lib/dfp_api/v201302/line_item_creative_association_service_registry.rb +0 -46
  352. data/lib/dfp_api/v201302/line_item_service.rb +0 -58
  353. data/lib/dfp_api/v201302/line_item_service_registry.rb +0 -46
  354. data/lib/dfp_api/v201302/network_service.rb +0 -46
  355. data/lib/dfp_api/v201302/network_service_registry.rb +0 -46
  356. data/lib/dfp_api/v201302/order_service_registry.rb +0 -46
  357. data/lib/dfp_api/v201302/placement_service.rb +0 -58
  358. data/lib/dfp_api/v201302/placement_service_registry.rb +0 -46
  359. data/lib/dfp_api/v201302/publisher_query_language_service.rb +0 -34
  360. data/lib/dfp_api/v201302/publisher_query_language_service_registry.rb +0 -46
  361. data/lib/dfp_api/v201302/report_service_registry.rb +0 -46
  362. data/lib/dfp_api/v201302/suggested_ad_unit_service.rb +0 -42
  363. data/lib/dfp_api/v201302/suggested_ad_unit_service_registry.rb +0 -46
  364. data/lib/dfp_api/v201302/team_service_registry.rb +0 -46
  365. data/lib/dfp_api/v201302/third_party_slot_service.rb +0 -46
  366. data/lib/dfp_api/v201302/third_party_slot_service_registry.rb +0 -46
  367. data/lib/dfp_api/v201302/user_service.rb +0 -66
  368. data/lib/dfp_api/v201302/user_service_registry.rb +0 -46
  369. data/lib/dfp_api/v201302/user_team_association_service.rb +0 -58
  370. data/lib/dfp_api/v201302/user_team_association_service_registry.rb +0 -46
@@ -18,7 +18,7 @@
18
18
  # See the License for the specific language governing permissions and
19
19
  # limitations under the License.
20
20
  #
21
- # This example gets first 500 cities available to target. A full list of
21
+ # This example gets all cities available to target. A full list of
22
22
  # available PQL tables can be found at:
23
23
  #
24
24
  # https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
@@ -26,11 +26,11 @@
26
26
  # Tags: PublisherQueryLanguageService.select
27
27
 
28
28
  require 'dfp_api'
29
+ require 'dfp_api_statement'
29
30
 
30
- API_VERSION = :v201311
31
+ API_VERSION = :v201411
31
32
  # A string to separate columns in output. Use "," to get CSV.
32
33
  COLUMN_SEPARATOR = "\t"
33
- PAGE_SIZE = 500
34
34
 
35
35
  def get_geo_targets()
36
36
  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,16 +46,16 @@ def get_geo_targets()
46
46
  # Create a statement to select all targetable cities.
47
47
  statement_text = "SELECT Id, Name, CanonicalParentId, ParentIds, " +
48
48
  "CountryCode, Type, Targetable FROM Geo_Target WHERE Type = 'City' " +
49
- "AND Targetable = true LIMIT %d OFFSET %d"
49
+ "AND Targetable = true ORDER BY Id ASC"
50
+
51
+ statement = DfpApiStatement::FilterStatement.new(statement_text)
50
52
 
51
53
  # Set initial values for paging.
52
- offset, result_set, all_rows = 0, nil, 0
54
+ result_set, all_rows = nil, 0
53
55
 
54
56
  # Get all cities with paging.
55
57
  begin
56
- # Create statement for a page.
57
- statement = {:query => statement_text % [PAGE_SIZE, offset]}
58
- result_set = pql_service.select(statement)
58
+ result_set = pql_service.select(statement.toStatement())
59
59
 
60
60
  if result_set
61
61
  # Print out columns header.
@@ -70,9 +70,9 @@ def get_geo_targets()
70
70
  end
71
71
 
72
72
  # Update the counters.
73
- offset += PAGE_SIZE
73
+ statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
74
74
  all_rows += result_set[:rows].size
75
- end while result_set[:rows].size == PAGE_SIZE
75
+ end while result_set[:rows].size == DfpApiStatement::SUGGESTED_PAGE_LIMIT
76
76
 
77
77
  # Print a footer.
78
78
  if result_set[:rows]
@@ -24,11 +24,11 @@
24
24
  # Tags: PublisherQueryLanguageService.select
25
25
 
26
26
  require 'dfp_api'
27
+ require 'dfp_api_statement'
27
28
 
28
- API_VERSION = :v201311
29
+ API_VERSION = :v201411
29
30
  # A string to separate columns in output. Use "," to get CSV.
30
31
  COLUMN_SEPARATOR = "\t"
31
- PAGE_SIZE = 500
32
32
 
33
33
  def get_line_items_named_like()
34
34
  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,16 +44,16 @@ def get_line_items_named_like()
44
44
  # Create a statement to select all line items matching subtext.
45
45
  statement_text =
46
46
  "SELECT Id, Name, Status FROM Line_Item WHERE Name LIKE 'line item%%' " +
47
- "ORDER BY Id ASC LIMIT %d OFFSET %d"
47
+ "ORDER BY Id ASC"
48
+
49
+ statement = DfpApiStatement::FilterStatement.new(statement_text)
48
50
 
49
51
  # Set initial values for paging.
50
- offset, result_set, all_rows = 0, nil, 0
52
+ result_set, all_rows = nil, 0
51
53
 
52
- # Get all cities starting with "Santa".
54
+ # Get all line items starting with "line item".
53
55
  begin
54
- # Create statement for a page.
55
- statement = {:query => statement_text % [PAGE_SIZE, offset]}
56
- result_set = pql_service.select(statement)
56
+ result_set = pql_service.select(statement.toStatement())
57
57
 
58
58
  if result_set
59
59
  # Print out columns header.
@@ -68,9 +68,9 @@ def get_line_items_named_like()
68
68
  end
69
69
 
70
70
  # Update the counters.
71
- offset += PAGE_SIZE
71
+ statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
72
72
  all_rows += result_set[:rows].size
73
- end while result_set[:rows].size == PAGE_SIZE
73
+ end while result_set[:rows].size == DfpApiStatement::SUGGESTED_PAGE_LIMIT
74
74
 
75
75
  # Print a footer.
76
76
  if result_set[:rows]
@@ -28,7 +28,7 @@ require 'dfp_api'
28
28
 
29
29
  require 'open-uri'
30
30
 
31
- API_VERSION = :v201311
31
+ API_VERSION = :v201411
32
32
 
33
33
  def display_report()
34
34
  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -27,7 +27,7 @@ require 'dfp_api'
27
27
 
28
28
  require 'open-uri'
29
29
 
30
- API_VERSION = :v201311
30
+ API_VERSION = :v201411
31
31
 
32
32
  def download_report()
33
33
  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -26,7 +26,7 @@
26
26
 
27
27
  require 'dfp_api'
28
28
 
29
- API_VERSION = :v201311
29
+ API_VERSION = :v201411
30
30
  MAX_RETRIES = 10
31
31
  RETRY_INTERVAL = 30
32
32
 
@@ -25,7 +25,7 @@
25
25
 
26
26
  require 'dfp_api'
27
27
 
28
- API_VERSION = :v201311
28
+ API_VERSION = :v201411
29
29
  MAX_RETRIES = 10
30
30
  RETRY_INTERVAL = 30
31
31
 
@@ -45,12 +45,12 @@ def run_inventory_report()
45
45
  root_ad_unit_id =
46
46
  network_service.get_current_network()[:effective_root_ad_unit_id]
47
47
 
48
- # Create statement to filter on an ancestor ad unit with the root ad unit ID
48
+ # Create statement to filter on a parent ad unit with the root ad unit ID
49
49
  # to include all ad units in the network.
50
50
  statement = {
51
- :query => 'WHERE AD_UNIT_ANCESTOR_AD_UNIT_ID = :ancestor_ad_unit_id',
51
+ :query => 'WHERE PARENT_AD_UNIT_ID = :parent_ad_unit_id',
52
52
  :values => [
53
- {:key => 'ancestor_ad_unit_id',
53
+ {:key => 'parent_ad_unit_id',
54
54
  :value => {:value => root_ad_unit_id, :xsi_type => 'NumberValue'}}
55
55
  ]
56
56
  }
@@ -24,7 +24,7 @@
24
24
 
25
25
  require 'dfp_api'
26
26
 
27
- API_VERSION = :v201311
27
+ API_VERSION = :v201411
28
28
  MAX_RETRIES = 10
29
29
  RETRY_INTERVAL = 30
30
30
 
@@ -3,7 +3,7 @@
3
3
  #
4
4
  # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
5
  #
6
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
+ # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
7
7
  #
8
8
  # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
9
  # you may not use this file except in compliance with the License.
@@ -18,18 +18,18 @@
18
18
  # See the License for the specific language governing permissions and
19
19
  # limitations under the License.
20
20
  #
21
- # This example runs a report that an upgraded publisher would use to include
22
- # statistics before the upgrade. To download the report see download_report.rb.
21
+ # This example runs a report filtered on a single custom field. To download the
22
+ # report see download_report.rb.
23
23
  #
24
24
  # Tags: ReportService.runReportJob, ReportService.getReportJob
25
25
 
26
26
  require 'dfp_api'
27
27
 
28
- API_VERSION = :v201311
28
+ API_VERSION = :v201411
29
29
  MAX_RETRIES = 10
30
30
  RETRY_INTERVAL = 30
31
31
 
32
- def run_merged_delivery_report()
32
+ def run_report_with_custom_fields()
33
33
  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
34
34
  dfp = DfpApi::Api.new
35
35
 
@@ -40,17 +40,15 @@ def run_merged_delivery_report()
40
40
  # Get the ReportService.
41
41
  report_service = dfp.service(:ReportService, API_VERSION)
42
42
 
43
+ # Set the ID of the custom field to filter on.
44
+ custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
45
+
43
46
  # Create report query.
44
47
  report_query = {
45
48
  :date_range_type => 'LAST_MONTH',
46
- :dimensions => ['ORDER_ID', 'ORDER_NAME'],
47
- :columns => [
48
- 'MERGED_AD_SERVER_IMPRESSIONS',
49
- 'MERGED_AD_SERVER_CLICKS',
50
- 'MERGED_AD_SERVER_CTR',
51
- 'MERGED_AD_SERVER_CPM_AND_CPC_REVENUE',
52
- 'MERGED_AD_SERVER_WITHOUT_CPD_AVERAGE_ECPM'
53
- ]
49
+ :dimensions => ['LINE_ITEM_ID', 'LINE_ITEM_NAME'],
50
+ :custom_field_ids => [custom_field_id],
51
+ :columns => ['AD_SERVER_IMPRESSIONS'],
54
52
  }
55
53
 
56
54
  # Create report job.
@@ -74,7 +72,7 @@ end
74
72
 
75
73
  if __FILE__ == $0
76
74
  begin
77
- run_merged_delivery_report()
75
+ run_report_with_custom_fields()
78
76
 
79
77
  # HTTP errors.
80
78
  rescue AdsCommon::Errors::HttpError => e
@@ -25,7 +25,7 @@
25
25
 
26
26
  require 'dfp_api'
27
27
 
28
- API_VERSION = :v201311
28
+ API_VERSION = :v201411
29
29
  MAX_RETRIES = 10
30
30
  RETRY_INTERVAL = 30
31
31
 
@@ -26,8 +26,9 @@
26
26
  # Tags: SuggestedAdUnitService.performSuggestedAdUnitAction
27
27
 
28
28
  require 'dfp_api'
29
+ require 'dfp_api_statement'
29
30
 
30
- API_VERSION = :v201311
31
+ API_VERSION = :v201411
31
32
  NUMBER_OF_REQUESTS = 50
32
33
 
33
34
  def approve_suggested_ad_units()
@@ -42,31 +43,34 @@ def approve_suggested_ad_units()
42
43
  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
43
44
 
44
45
  # Create a statement to only select suggested ad units with 50 or more
45
- # requests (with maximum limit of 500).
46
- statement = {
47
- :query => 'WHERE numRequests >= :num_requests',
48
- :values => [
49
- {:key => 'num_requests',
50
- :value => {:value => NUMBER_OF_REQUESTS,
51
- :xsi_type => 'NumberValue'}}
52
- ]
53
- }
46
+ # requests.
47
+ statement = DfpApiStatement::FilterStatement.new(
48
+ 'WHERE numRequests >= :num_requests',
49
+ [
50
+ {:key => 'num_requests',
51
+ :value => {:value => NUMBER_OF_REQUESTS,
52
+ :xsi_type => 'NumberValue'}}
53
+ ]
54
+ )
54
55
 
55
- # Get suggested ad units by statement.
56
- page =
57
- suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
56
+ begin
57
+ # Get suggested ad units by statement.
58
+ page = suggested_ad_unit_service.get_suggested_ad_units_by_statement(
59
+ statement.toStatement())
58
60
 
59
- unit_count_to_approve = 0
61
+ unit_count_to_approve = 0
60
62
 
61
- if page[:results]
62
- page[:results].each do |ad_unit|
63
- if ad_unit[:num_requests] >= NUMBER_OF_REQUESTS
64
- puts(("%d) Suggested ad unit with ID '%s' and %d requests will be " +
65
- "approved.") % [suggested_ad_unit_ids.size, ad_unit[:id],
66
- ad_unit[:num_requests]])
67
- unit_count_to_approve += 1
63
+ if page[:results]
64
+ page[:results].each_with_index do |ad_unit, index|
65
+ if ad_unit[:num_requests] >= NUMBER_OF_REQUESTS
66
+ puts(("%d) Suggested ad unit with ID '%s' and %d requests will be " +
67
+ "approved.") % [index + statement.offset, ad_unit[:id],
68
+ ad_unit[:num_requests]])
69
+ unit_count_to_approve += 1
70
+ end
68
71
  end
69
72
  end
73
+ statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
70
74
  end
71
75
 
72
76
  puts "Number of suggested ad units to be approved: %d" % unit_count_to_approve
@@ -26,9 +26,9 @@
26
26
  # Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
27
27
 
28
28
  require 'dfp_api'
29
+ require 'dfp_api_statement'
29
30
 
30
- API_VERSION = :v201311
31
- PAGE_SIZE = 500
31
+ API_VERSION = :v201411
32
32
 
33
33
  def get_all_suggested_ad_units()
34
34
  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,32 +41,23 @@ def get_all_suggested_ad_units()
41
41
  # Get the SuggestedAdUnitService.
42
42
  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
43
43
 
44
- # Define initial values.
45
- offset = 0
46
- page = {}
44
+ # Create a statement to get all suggested ad units.
45
+ statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
47
46
 
48
47
  begin
49
- # Create a statement to get one page with current offset.
50
- statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
51
-
52
48
  # Get suggested ad units by statement.
53
- page =
54
- suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
49
+ page = suggested_ad_unit_service.get_suggested_ad_units_by_statement(
50
+ statement.toStatement())
55
51
 
56
52
  if page[:results]
57
- # Increase query offset by page size.
58
- offset += PAGE_SIZE
59
-
60
- # Get the start index for printout.
61
- start_index = page[:start_index]
62
-
63
53
  # Print details about each suggested ad unit in results.
64
54
  page[:results].each_with_index do |ad_unit, index|
65
55
  puts "%d) Suggested ad unit ID: '%s' with number of requests: %d" %
66
- [index + start_index, ad_unit[:id], ad_unit[:num_requests]]
56
+ [index + statement.offset, ad_unit[:id], ad_unit[:num_requests]]
67
57
  end
68
58
  end
69
- end while offset < page[:total_result_set_size]
59
+ statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
60
+ end while statement.offset < page[:total_result_set_size]
70
61
 
71
62
  # Print a footer.
72
63
  if page.include?(:total_result_set_size)
@@ -18,16 +18,16 @@
18
18
  # See the License for the specific language governing permissions and
19
19
  # limitations under the License.
20
20
  #
21
- # This example gets suggested ad units that have more than 50 requests. The
22
- # statement retrieves up to the maximum page size limit of 500.
21
+ # This example gets suggested ad units that have more than 50 requests.
23
22
  #
24
23
  # This feature is only available to DFP premium solution networks.
25
24
  #
26
25
  # Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
27
26
 
28
27
  require 'dfp_api'
28
+ require 'dfp_api_statement'
29
29
 
30
- API_VERSION = :v201311
30
+ API_VERSION = :v201411
31
31
  NUMBER_OF_REQUESTS = 50
32
32
 
33
33
  def get_suggested_ad_units_by_statement()
@@ -42,27 +42,30 @@ def get_suggested_ad_units_by_statement()
42
42
  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
43
43
 
44
44
  # Create a statement to only select suggested ad units with more than 50
45
- # requests (with maximum limit of 500).
46
- statement = {
47
- :query => 'WHERE numRequests > :num_requests LIMIT 500',
48
- :values => [
49
- {:key => 'num_requests',
50
- :value => {:value => NUMBER_OF_REQUESTS,
51
- :xsi_type => 'NumberValue'}}
52
- ]
53
- }
45
+ # requests.
46
+ statement = DfpApiStatement::FilterStatement.new(
47
+ 'WHERE numRequests > :num_requests ORDER BY id ASC',
48
+ [
49
+ {:key => 'num_requests',
50
+ :value => {:value => NUMBER_OF_REQUESTS,
51
+ :xsi_type => 'NumberValue'}}
52
+ ]
53
+ )
54
54
 
55
- # Get ad units by statement.
56
- page =
57
- suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
55
+ begin
56
+ # Get ad units by statement.
57
+ page = suggested_ad_unit_service.get_suggested_ad_units_by_statement(
58
+ statement.toStatement())
58
59
 
59
- if page[:results]
60
- # Print details about each suggested ad unit in results.
61
- page[:results].each_with_index do |ad_unit, index|
62
- puts "%d) Suggested ad unit ID: '%s', number of requests: %d" %
63
- [index, ad_unit[:id], ad_unit[:num_requests]]
60
+ if page[:results]
61
+ # Print details about each suggested ad unit in results.
62
+ page[:results].each_with_index do |ad_unit, index|
63
+ puts "%d) Suggested ad unit ID: '%s', number of requests: %d" %
64
+ [index + statement.offset, ad_unit[:id], ad_unit[:num_requests]]
65
+ end
64
66
  end
65
- end
67
+ statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
68
+ end statement.offset < page[:total_result_set_size]
66
69
 
67
70
  # Print a footer.
68
71
  if page.include?(:total_result_set_size)
@@ -25,7 +25,7 @@
25
25
 
26
26
  require 'dfp_api'
27
27
 
28
- API_VERSION = :v201311
28
+ API_VERSION = :v201411
29
29
  ITEM_COUNT = 5
30
30
 
31
31
  def create_teams()
@@ -23,9 +23,9 @@
23
23
  # Tags: TeamService.getTeamsByStatement
24
24
 
25
25
  require 'dfp_api'
26
+ require 'dfp_api_statement'
26
27
 
27
- API_VERSION = :v201311
28
- PAGE_SIZE = 500
28
+ API_VERSION = :v201411
29
29
 
30
30
  def get_all_teams()
31
31
  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,31 +38,22 @@ def get_all_teams()
38
38
  # Get the TeamService.
39
39
  team_service = dfp.service(:TeamService, API_VERSION)
40
40
 
41
- # Define initial values.
42
- offset = 0
43
- page = {}
41
+ # Create statement for all teams.
42
+ statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
44
43
 
45
44
  begin
46
- # Create statement for one page with current offset.
47
- statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
48
-
49
45
  # Get teams by statement.
50
- page = team_service.get_teams_by_statement(statement)
46
+ page = team_service.get_teams_by_statement(statement.toStatement())
51
47
 
52
48
  if page[:results]
53
- # Increase query offset by page size.
54
- offset += PAGE_SIZE
55
-
56
- # Get the start index for printout.
57
- start_index = page[:start_index]
58
-
59
49
  # Print details about each team in results page.
60
50
  page[:results].each_with_index do |team, index|
61
51
  puts "%d) Team ID: %d, name: %s" %
62
- [index + start_index, team[:id], team[:name]]
52
+ [index + statement.offset, team[:id], team[:name]]
63
53
  end
64
54
  end
65
- end while offset < page[:total_result_set_size]
55
+ statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
56
+ end while statement.offset < page[:total_result_set_size]
66
57
 
67
58
  # Print a footer
68
59
  if page.include?(:total_result_set_size)