google-dfp-api 0.6.3 → 0.7.0

data/examples/{v201206 → v201308}/report_service/download_report.rb

@@ -27,7 +27,7 @@ require 'dfp_api'
 
 require 'open-uri'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def download_report()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201206 → v201308}/report_service/run_delivery_report.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -47,14 +47,14 @@ def run_delivery_report()
   # Create report query.
   report_query = {
     :date_range_type => 'LAST_MONTH',
-    :dimensions => ['ORDER'],
+    :dimensions => ['ORDER_ID', 'ORDER_NAME'],
     :dimension_attributes => ['ORDER_TRAFFICKER', 'ORDER_START_DATE_TIME',
         'ORDER_END_DATE_TIME'],
     :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS', 'AD_SERVER_CTR',
-        'AD_SERVER_CPM_AND_CPC_REVENUE', 'AD_SERVER_AVERAGE_ECPM'],
+        'AD_SERVER_CPM_AND_CPC_REVENUE', 'AD_SERVER_WITHOUT_CPD_AVERAGE_ECPM'],
     # Create statement object to filter for an order.
     :statement => {
-        :query => 'WHERE orderId = :order_id',
+        :query => 'WHERE ORDER_ID = :order_id',
         :values => [
             {:key => 'order_id',
              :value => {:value => order_id, :xsi_type => 'NumberValue'}}

data/examples/{v201206 → v201308}/report_service/run_inventory_report.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -52,8 +52,7 @@ def run_inventory_report()
         'DYNAMIC_ALLOCATION_INVENTORY_LEVEL_CLICKS',
         'TOTAL_INVENTORY_LEVEL_IMPRESSIONS',
         'TOTAL_INVENTORY_LEVEL_CPM_AND_CPC_REVENUE'
-    ],
-    :date_range_type => 'LAST_WEEK'
+    ]
   }
 
   # Create report job.

data/examples/{v201206 → v201308}/report_service/run_merged_delivery_report.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -43,13 +43,13 @@ def run_merged_delivery_report()
   # Create report query.
   report_query = {
     :date_range_type => 'LAST_MONTH',
-    :dimensions => ['ORDER'],
+    :dimensions => ['ORDER_ID', 'ORDER_NAME'],
     :columns => [
         'MERGED_AD_SERVER_IMPRESSIONS',
         'MERGED_AD_SERVER_CLICKS',
         'MERGED_AD_SERVER_CTR',
         'MERGED_AD_SERVER_CPM_AND_CPC_REVENUE',
-        'MERGED_AD_SERVER_AVERAGE_ECPM'
+        'MERGED_AD_SERVER_WITHOUT_CPD_AVERAGE_ECPM'
     ]
   }
 

data/examples/{v201204/report_service/run_sales_report.rb → v201308/report_service/run_reach_report.rb}

@@ -1,9 +1,8 @@
 #!/usr/bin/env ruby
-# Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+# Author:: api.davidtorres@gmail.com (David Torres)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
 #           you may not use this file except in compliance with the License.
@@ -18,18 +17,18 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example runs a report equal to the "Sales by salespersons report" on the
-# DFP website. To download the report see download_report.rb.
+# This example runs a reach report. To download the report see
+# download_report.rb.
 #
 # Tags: ReportService.runReportJob, ReportService.getReportJob
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
-def run_sales_report()
+def run_reach_report()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -42,10 +41,9 @@ def run_sales_report()
 
   # Create report query.
   report_query = {
-    :date_range_type => 'LAST_MONTH',
-    :dimensions => ['SALESPERSON'],
-    :columns =>
-        ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_REVENUE', 'AD_SERVER_AVERAGE_ECPM']
+    :date_range_type => 'REACH_LIFETIME',
+    :dimensions => ['LINE_ITEM_ID', 'LINE_ITEM_NAME'],
+    :columns => ['REACH_FREQUENCY', 'REACH_AVERAGE_REVENUE', 'REACH']
   }
 
   # Create report job.
@@ -69,7 +67,7 @@ end
 
 if __FILE__ == $0
   begin
-    run_sales_report()
+    run_reach_report()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201204/report_service/run_delivery_report.rb → v201308/report_service/run_report_with_custom_fields.rb}

@@ -3,7 +3,7 @@
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
 #           you may not use this file except in compliance with the License.
@@ -18,19 +18,20 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example runs a report similar to the "Orders report" on the DFP website
-# with additional attributes and can filter to include just one order.
-# To download the report see download_report.rb.
+# This example runs a report that includes custom fields found in the line items
+# of an order. To download the report see download_report.rb.
 #
+# Tags: LineItemService.getLineItemByStatement
 # Tags: ReportService.runReportJob, ReportService.getReportJob
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
+PAGE_SIZE = 500
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
-def run_delivery_report()
+def run_report_with_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -38,28 +39,59 @@ def run_delivery_report()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
+  # Get the LineItemService.
+  line_item_service = dfp.service(:LineItemService, API_VERSION)
+
   # Get the ReportService.
   report_service = dfp.service(:ReportService, API_VERSION)
 
-  # Specify the order ID to filter by.
+  # Set the ID of the order to get line items from.
   order_id = 'INSERT_ORDER_ID_HERE'.to_i
 
+  # Define initial values.
+  offset = 0
+  page = {}
+  custom_field_ids = []
+
+  # Create a statement to only select line items from a given order.
+  statement = {
+      :values => [
+          {:key => 'order_id',
+           :value => {:value => order_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+  query_text = 'WHERE orderId = :order_id LIMIT %d OFFSET %d'
+
+  begin
+    # Update the statement to get one page with current offset.
+    statement[:query] = query_text % [PAGE_SIZE, offset]
+
+    # Get line items by statement.
+    page = line_item_service.get_line_items_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      # Get custom field IDs from the line items of an order.
+      page[:results].each do |line_item|
+        if line_item[:custom_field_values]
+          line_item[:custom_field_values].each do |value|
+            custom_field_ids |= [value[:custom_field_id]]
+          end
+        end
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
   # Create report query.
+  statement[:query] = 'WHERE ORDER_ID = :order_id'
   report_query = {
     :date_range_type => 'LAST_MONTH',
-    :dimensions => ['ORDER'],
-    :dimension_attributes => ['ORDER_TRAFFICKER', 'ORDER_START_DATE_TIME',
-        'ORDER_END_DATE_TIME'],
-    :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS', 'AD_SERVER_CTR',
-        'AD_SERVER_REVENUE', 'AD_SERVER_AVERAGE_ECPM'],
-    # Create statement object to filter for an order.
-    :statement => {
-        :query => 'WHERE orderId = :order_id',
-        :values => [
-            {:key => 'order_id',
-             :value => {:value => order_id, :xsi_type => 'NumberValue'}}
-        ]
-    }
+    :dimensions => ['LINE_ITEM_ID', 'LINE_ITEM_NAME'],
+    :custom_field_ids => custom_field_ids,
+    :columns => ['AD_SERVER_IMPRESSIONS'],
+    :statement => statement
   }
 
   # Create report job.
@@ -83,7 +115,7 @@ end
 
 if __FILE__ == $0
   begin
-    run_delivery_report()
+    run_report_with_custom_fields()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201206 → v201308}/report_service/run_sales_report.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -43,11 +43,11 @@ def run_sales_report()
   # Create report query.
   report_query = {
     :date_range_type => 'LAST_MONTH',
-    :dimensions => ['SALESPERSON'],
+    :dimensions => ['SALESPERSON_ID', 'SALESPERSON_NAME'],
     :columns => [
         'AD_SERVER_IMPRESSIONS',
         'AD_SERVER_CPM_AND_CPC_REVENUE',
-        'AD_SERVER_AVERAGE_ECPM'
+        'AD_SERVER_WITHOUT_CPD_AVERAGE_ECPM'
     ]
   }
 

data/examples/{v201206 → v201308}/suggested_ad_unit_service/approve_all_suggested_ad_units.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 NUMBER_OF_REQUESTS = 50
 
 def approve_suggested_ad_units()

data/examples/{v201206 → v201308}/suggested_ad_unit_service/get_all_suggested_ad_units.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_all_suggested_ad_units()

data/examples/{v201206 → v201308}/suggested_ad_unit_service/get_suggested_ad_unit.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def get_suggested_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201206 → v201308}/suggested_ad_unit_service/get_suggested_ad_units_by_statement.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 NUMBER_OF_REQUESTS = 50
 
 def get_suggested_ad_units_by_statement()

data/examples/{v201204 → v201308}/team_service/create_teams.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 ITEM_COUNT = 5
 
 def create_teams()

data/examples/{v201204 → v201308}/team_service/get_all_teams.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_all_teams()

data/examples/{v201206 → v201308}/team_service/get_team.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def get_team()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201204 → v201308}/team_service/get_teams_by_statement.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def get_teams_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201206 → v201308}/team_service/update_teams.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def update_teams()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -58,6 +58,8 @@ def update_teams()
       unless team[:has_all_inventory]
         team[:ad_unit_ids] ||= []
         team[:ad_unit_ids] << ad_unit_id
+        # Workaround for issue #94.
+        team[:description] = "" if team[:description].nil?
         updated_teams << team
       end
       updated_teams

data/examples/{v201206 → v201308}/user_service/create_users.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def create_users()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201204 → v201308}/user_service/deactivate_users.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def deactivate_users()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201204 → v201308}/user_service/get_all_roles.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def get_all_roles()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201204 → v201308}/user_service/get_all_users.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_all_users()

data/examples/{v201206 → v201308}/user_service/get_current_user.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def get_current_user()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201206 → v201308}/user_service/get_user.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def get_user()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201206 → v201308}/user_service/get_users_by_statement.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def get_users_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.