RubyGems - google-dfp-api - Versions diffs - 0.17.0 → 0.18.0 - Mend

google-dfp-api 0.17.0 → 0.18.0

Files changed (797) hide show

data/examples/{v201508 → v201608}/line_item_creative_association_service/update_licas.rb RENAMED

@@ -22,7 +22,7 @@
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 def update_licas()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201508 → v201608}/line_item_service/activate_line_items.rb RENAMED

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

data/examples/{v201511 → v201608}/line_item_service/create_line_items.rb RENAMED

@@ -25,7 +25,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 # Number of line items to create.
 ITEM_COUNT = 5

data/examples/{v201508 → v201608}/line_item_service/create_video_line_item.rb RENAMED

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

data/examples/{v201508 → v201608}/line_item_service/get_all_line_items.rb RENAMED

@@ -22,7 +22,7 @@
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 def get_all_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201511 → v201608}/line_item_service/get_line_items_by_statement.rb RENAMED

@@ -23,7 +23,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 def get_line_items_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201508 → v201608}/line_item_service/get_recently_updated_line_items.rb RENAMED

@@ -25,7 +25,7 @@ require 'date'
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 def get_recently_updated_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201511 → v201608}/line_item_service/target_custom_criteria.rb RENAMED

@@ -26,7 +26,7 @@ require 'dfp_api'
 require 'pp'
-API_VERSION = :v201511
+API_VERSION = :v201608
 PAGE_SIZE = 500
 def target_custom_criteria()

data/examples/{v201511 → v201608}/line_item_service/update_line_items.rb RENAMED

@@ -23,7 +23,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 def update_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201511 → v201608}/network_service/get_all_networks.rb RENAMED

@@ -20,7 +20,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 def get_all_networks()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201511 → v201608}/network_service/get_current_network.rb RENAMED

@@ -20,7 +20,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 def get_current_network()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201508 → v201608}/network_service/make_test_network.rb RENAMED

@@ -31,7 +31,7 @@
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 def make_test_network()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201511 → v201608}/order_service/approve_orders.rb RENAMED

@@ -23,7 +23,7 @@ require 'date'
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 PAGE_SIZE = 500
 def approve_orders()

data/examples/{v201511 → v201608}/order_service/create_orders.rb RENAMED

@@ -23,7 +23,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 # Number of orders to create.
 ITEM_COUNT = 5

data/examples/{v201508 → v201608}/order_service/get_all_orders.rb RENAMED

@@ -21,7 +21,7 @@
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 def get_all_orders()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201508 → v201608}/order_service/get_orders_by_statement.rb RENAMED

@@ -23,7 +23,7 @@
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 def get_orders_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201511 → v201608}/order_service/update_orders.rb RENAMED

@@ -22,7 +22,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 def update_orders()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201511 → v201608}/placement_service/create_placements.rb RENAMED

@@ -22,7 +22,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 def create_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201508 → v201608}/placement_service/deactivate_placements.rb RENAMED

@@ -22,7 +22,7 @@
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 def deactivate_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201511 → v201608}/placement_service/get_all_placements.rb RENAMED

@@ -22,7 +22,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 def get_all_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201508 → v201608}/placement_service/get_placements_by_statement.rb RENAMED

@@ -22,7 +22,7 @@
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 def get_placements_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201511 → v201608}/placement_service/update_placements.rb RENAMED

@@ -22,7 +22,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 def update_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201508 → v201608}/publisher_query_language_service/fetch_match_tables.rb RENAMED

@@ -21,14 +21,14 @@
 #
 # A full list of available tables can be found at:
 #
-#   https://developers.google.com/doubleclick-publishers/docs/reference/v201508/PublisherQueryLanguageService
+#   https://developers.google.com/doubleclick-publishers/docs/reference/v201608/PublisherQueryLanguageService
 require 'tempfile'
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = ','

data/examples/{v201511 → v201608}/publisher_query_language_service/get_all_line_items.rb RENAMED

@@ -24,7 +24,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"

data/examples/{v201511 → v201608}/publisher_query_language_service/get_geo_targets.rb RENAMED

@@ -24,7 +24,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"

data/examples/{v201508 → v201608}/publisher_query_language_service/get_line_items_named_like.rb RENAMED

@@ -22,7 +22,7 @@
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"

data/examples/{v201508 → v201608}/report_service/display_report.rb RENAMED

@@ -24,7 +24,7 @@ require 'dfp_api'
 require 'open-uri'
-API_VERSION = :v201508
+API_VERSION = :v201608
 def display_report()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201508 → v201608}/report_service/download_report.rb RENAMED

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

data/examples/{v201511 → v201608}/report_service/run_delivery_report.rb RENAMED

@@ -23,7 +23,7 @@
 require 'date'
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30

data/examples/{v201511 → v201608}/report_service/run_inventory_report.rb RENAMED

@@ -21,7 +21,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30

data/examples/{v201511 → v201608}/report_service/run_reach_report.rb RENAMED

@@ -21,7 +21,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30

data/examples/{v201508 → v201608}/report_service/run_report_with_custom_fields.rb RENAMED

@@ -21,7 +21,7 @@
 require 'dfp_api'
-API_VERSION = :v201508
+API_VERSION = :v201608
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30

data/examples/{v201511 → v201608}/report_service/run_sales_report.rb RENAMED

@@ -21,7 +21,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30

data/examples/v201608/report_service/run_saved_query.rb ADDED

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2016, 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.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example runs a report from a saved query. To download the report see
+# download_report.rb.
+require 'dfp_api'
+API_VERSION = :v201608
+MAX_RETRIES = 10
+RETRY_INTERVAL = 30
+def run_saved_query(saved_query_id)
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+  # Get the ReportService and NetworkService.
+  report_service = dfp.service(:ReportService, API_VERSION)
+  # Create statement to select a single saved report query.
+  statement = DfpApi::FilterStatement.new(
+      'WHERE id = :id',
+      [
+        {:key => 'id',
+         :value => {
+             :value => saved_query_id,
+             :xsi_type => 'NumberValue'}
+        }
+      ],
+      # Limit results to single entity.
+      1
+  )
+  saved_query_page = report_service.get_saved_queries_by_statement(
+      statement.toStatement())
+  unless saved_query_page[:results].nil?
+    saved_query = response[:results].first
+    if saved_query[:is_compatible_with_api_version]
+      # Create report job.
+      report_job = {:report_query => saved_query[:report_query]}
+      # Run report job.
+      report_job = report_service.run_report_job(report_job);
+      MAX_RETRIES.times do |retry_count|
+        # Get the report job status.
+        report_job_status = report_service.get_report_job_status(
+            report_job[:id])
+        break unless report_job_status == 'IN_PROGRESS'
+        puts "Report with ID: %d is still running." % report_job[:id]
+        sleep(RETRY_INTERVAL)
+      end
+      puts "Report job with ID: %d finished with status %s." %
+          [report_job[:id],
+           report_service.get_report_job_status(report_job[:id])]
+    else
+      raise StandardError, 'Report query is not compatible with the API'
+    end
+  end
+end
+if __FILE__ == $0
+  begin
+    SAVED_QUERY_ID = 'INSERT_SAVED_QUERY_ID_HERE'.to_i
+    run_saved_query(SAVED_QUERY_ID)
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+  # API errors.
+  rescue DfpApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/{v201511 → v201608}/suggested_ad_unit_service/approve_all_suggested_ad_units.rb RENAMED

@@ -23,7 +23,7 @@
 require 'dfp_api'
-API_VERSION = :v201511
+API_VERSION = :v201608
 NUMBER_OF_REQUESTS = 50
 def approve_suggested_ad_units()
@@ -73,7 +73,7 @@ def approve_suggested_ad_units()
   if unit_count_to_approve > 0
     # Perform action with the same statement.
     result = suggested_ad_unit_service.perform_suggested_ad_unit_action(
-        {:xsi_type => 'ApproveSuggestedAdUnit'}, statement)
+        {:xsi_type => 'ApproveSuggestedAdUnits'}, statement)
     # Display results.
     if result and result[:num_changes] > 0