google-dfp-api 0.4.0 → 0.5.0

data/examples/{v201201 → v201211}/placement_service/deactivate_placements.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -20,12 +21,12 @@
 # This example deactivates all active placements. To determine which placements
 # exist, run get_all_placements.rb.
 #
-# Tags: PlacementService.getPlacementsByStatement,
-#       PlacementService.performPlacementAction
+# Tags: PlacementService.getPlacementsByStatement
+# Tags: PlacementService.performPlacementAction
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def deactivate_placements()

data/examples/{v201108 → v201211}/placement_service/get_all_placements.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_placements()

data/examples/{v201108 → v201211}/placement_service/get_placement.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
 def get_placement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201108 → v201211}/placement_service/get_placements_by_statement.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -25,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
 def get_placements_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/placement_service/update_placements.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -20,12 +21,12 @@
 # This example updates all placements to allow for AdSense targeting up to the
 # first 500. To determine which placements exist, run get_all_placements.rb.
 #
-# Tags: PlacementService.getPlacementsByStatement,
-#       PlacementService.updatePlacements
+# Tags: PlacementService.getPlacementsByStatement
+# Tags: PlacementService.updatePlacements
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def update_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/publisher_query_language_service/get_all_cities.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -20,13 +21,13 @@
 # This example gets first 500 cities available to target. A full list of
 # available tables can be found at:
 #
-# http://code.google.com/apis/dfp/docs/reference/v201201/PublisherQueryLanguageService.html
+# https://developers.google.com/doubleclick-publishers/docs/reference/v201204/PublisherQueryLanguageService
 #
 # Tags: PublisherQueryLanguageService.select
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"
 

data/examples/{v201201 → v201211}/report_service/download_report.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@ require 'dfp_api'
 
 require 'open-uri'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def download_report()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,7 +47,7 @@ def download_report()
   file_name = 'INSERT_FILE_PATH_AND_NAME_HERE'
 
   # Change to your preffered export format.
-  export_format = 'CSV'
+  export_format = 'CSV_DUMP'
 
   # Get the report URL.
   download_url = report_service.get_report_download_url(

data/examples/{v201201 → v201211}/report_service/run_delivery_report.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -25,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -50,7 +51,7 @@ def run_delivery_report()
     :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'],
+        'AD_SERVER_CPM_AND_CPC_REVENUE', 'AD_SERVER_AVERAGE_ECPM'],
     # Create statement object to filter for an order.
     :statement => {
         :query => 'WHERE orderId = :order_id',

data/examples/{v201201 → v201211}/report_service/run_inventory_report.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -42,12 +43,16 @@ def run_inventory_report()
   # Create report query.
   report_query = {
     :date_range_type => 'LAST_WEEK',
-    :dimensions => ['DATE'],
+    :dimensions => ['DATE', 'AD_UNIT_NAME'],
     :ad_unit_view => 'HIERARCHICAL',
-    :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS',
-        'ADSENSE_IMPRESSIONS', 'ADSENSE_CLICKS', 'TOTAL_IMPRESSIONS',
-        'TOTAL_REVENUE'],
-    :date_range_type => 'LAST_WEEK'
+    :columns => [
+        'AD_SERVER_IMPRESSIONS',
+        'AD_SERVER_CLICKS',
+        'DYNAMIC_ALLOCATION_INVENTORY_LEVEL_IMPRESSIONS',
+        'DYNAMIC_ALLOCATION_INVENTORY_LEVEL_CLICKS',
+        'TOTAL_INVENTORY_LEVEL_IMPRESSIONS',
+        'TOTAL_INVENTORY_LEVEL_CPM_AND_CPC_REVENUE'
+    ]
   }
 
   # Create report job.

data/examples/{v201111 → v201211}/report_service/run_merged_delivery_report.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -47,7 +48,7 @@ def run_merged_delivery_report()
         'MERGED_AD_SERVER_IMPRESSIONS',
         'MERGED_AD_SERVER_CLICKS',
         'MERGED_AD_SERVER_CTR',
-        'MERGED_AD_SERVER_REVENUE',
+        'MERGED_AD_SERVER_CPM_AND_CPC_REVENUE',
         'MERGED_AD_SERVER_AVERAGE_ECPM'
     ]
   }

data/examples/{v201108/report_service/run_delivery_report.rb → v201211/report_service/run_report_with_custom_fields.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # 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.
@@ -17,18 +18,20 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example runs a report equal to the "Orders report" on the DFP website.
-# 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 = :v201108
+API_VERSION = :v201211
+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
 
@@ -36,15 +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)
 
+  # 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'],
-    :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS', 'AD_SERVER_CTR',
-        'AD_SERVER_REVENUE', 'AD_SERVER_AVERAGE_ECPM']
+    :dimensions => ['LINE_ITEM'],
+    :custom_field_ids => custom_field_ids,
+    :columns => ['AD_SERVER_IMPRESSIONS'],
+    :statement => statement
   }
 
   # Create report job.
@@ -68,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/{v201111 → v201211}/report_service/run_sales_report.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -43,8 +44,11 @@ def run_sales_report()
   report_query = {
     :date_range_type => 'LAST_MONTH',
     :dimensions => ['SALESPERSON'],
-    :columns =>
-        ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_REVENUE', 'AD_SERVER_AVERAGE_ECPM']
+    :columns => [
+        'AD_SERVER_IMPRESSIONS',
+        'AD_SERVER_CPM_AND_CPC_REVENUE',
+        'AD_SERVER_AVERAGE_ECPM'
+    ]
   }
 
   # Create report job.

data/examples/{v201201 → v201211}/suggested_ad_unit_service/approve_all_suggested_ad_units.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -21,12 +22,12 @@
 #
 # This feature is only available to DFP premium solution networks.
 #
-# Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement,
-#       SuggestedAdUnitService.performSuggestedAdUnitAction
+# Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
+# Tags: SuggestedAdUnitService.performSuggestedAdUnitAction
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 NUMBER_OF_REQUESTS = 50
 
 def approve_suggested_ad_units()

data/examples/{v201201 → v201211}/suggested_ad_unit_service/get_all_suggested_ad_units.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_suggested_ad_units()

data/examples/{v201111 → v201211}/suggested_ad_unit_service/get_suggested_ad_unit.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 
 def get_suggested_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/suggested_ad_unit_service/get_suggested_ad_units_by_statement.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 NUMBER_OF_REQUESTS = 50
 
 def get_suggested_ad_units_by_statement()

data/examples/{v201201 → v201211}/team_service/create_teams.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -20,11 +21,11 @@
 # This example creates new teams with the logged in user added to each team. To
 # determine which teams exist, run get_all_teams.rb.
 #
-# Tags: TeamService.createTeams, UserService.getCurrentUser
+# Tags: TeamService.createTeams
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 ITEM_COUNT = 5
 
 def create_teams()
@@ -38,17 +39,13 @@ def create_teams()
   # Get the TeamService.
   team_service = dfp.service(:TeamService, API_VERSION)
 
-  # Get the UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
-
-  # Get the current user's ID.
-  current_user = user_service.get_current_user()
-  user_id = current_user[:id]
-
   # Create an array to store local team objects.
   teams = (1..ITEM_COUNT).map do |index|
-    {:name => "Team #%d" % index,
-     :user_ids => [user_id]}
+    {
+      :name => "Team #%d" % index,
+      :has_all_companies => false,
+      :has_all_inventory => false
+    }
   end
 
   # Create the teams on the server.
@@ -56,8 +53,8 @@ def create_teams()
 
   if return_teams
     return_teams.each do |team|
-      puts "Team with ID: %d, name: %s and user ids: [%s] was created." %
-          [team[:id], team[:name], team[:user_ids].join(', ')]
+      puts "Team with ID: %d and name: '%s' was created." %
+          [team[:id], team[:name]]
     end
   else
     raise 'No teams were created.'