google-dfp-api 0.6.3 → 0.7.0

data/examples/{v201206/audience_segment_service/get_all_audience_segments.rb → v201308/creative_wrapper_service/get_all_creative_wrappers.rb}

@@ -18,16 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This code example gets all audience segments.
+# This example gets all creative wrappers for an account. To create creative
+# wrappers, run create_creative_wrappers.rb.
 #
-# Tags: AudienceSegmentService.getAudienceSegmentsByStatement
+# Tags: CreativeWrapperService.getCreativeWrappersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
-def get_all_audience_segments()
+def get_all_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,8 +36,8 @@ def get_all_audience_segments()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the AudienceSegmentService.
-  audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
+  # Get the CreativeWrapperService.
+  creative_wrapper_service = dfp.service(:CreativeWrapperService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -46,9 +47,9 @@ def get_all_audience_segments()
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get audience segments by statement.
+    # Get creative wrappers by statement.
     page =
-        audience_segment_service.get_audience_segments_by_statement(statement)
+      creative_wrapper_service.get_creative_wrappers_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -57,23 +58,23 @@ def get_all_audience_segments()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each audience segment in results page.
-      page[:results].each_with_index do |segment, index|
-        puts "%d) Audience segment ID: %d, name: %s" %
-            [index + start_index, segment[:id], segment[:name]]
+      # Print details about each creative wrapper in results page.
+      page[:results].each_with_index do |creative_wrapper, index|
+        puts "%d) Creative wrapper ID: %d, label ID: %d" % [index + start_index,
+            creative_wrapper[:id], creative_wrapper[:label_id]]
       end
     end
   end while offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)
-    puts "Total number of audience segments: %d" % page[:total_result_set_size]
+    puts "Total number of creative wrappers: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_audience_segments()
+    get_all_creative_wrappers()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201206/team_service/get_teams_by_statement.rb → v201308/creative_wrapper_service/get_creative_wrappers_by_statement.rb}

@@ -18,16 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all teams ordered by name. The statement retrieves up to the
-# maximum page size limit of 500. To create teams, run create_teams.rb.
+# This code example gets all active creative wrappers. To create creative
+# wrappers, run create_creative_wrappers.rb.
 #
-# Tags: TeamService.getTeamsByStatement
+# Tags: CreativeWrapperService.getCreativeWrappersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
-def get_teams_by_statement()
+def get_creative_wrappers_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,18 +35,28 @@ def get_teams_by_statement()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the TeamService.
-  team_service = dfp.service(:TeamService, API_VERSION)
+  # Get the CreativeWrapperService.
+  creative_wrapper_service = dfp.service(:CreativeWrapperService, API_VERSION)
 
-  # Create a statement to order teams by name.
-  statement = {:query => "ORDER BY name LIMIT 500"}
+  # Create filter text to select active creative wrappers.
+  statement = {
+      :query => 'WHERE status = :status',
+      :values => [
+        {
+          :key => 'status',
+          :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}
+        }
+      ]
+  }
 
-  # Get teams by statement.
-  page = team_service.get_teams_by_statement(statement)
+  # Get creative wrappers by statement.
+  page = creative_wrapper_service.get_creative_wrappers_by_statement(statement)
 
   if page and page[:results]
-    page[:results].each_with_index do |team, index|
-      puts "%d) Team ID: %d, name: %s." % [index, team[:id], team[:name]]
+    page[:results].each_with_index do |creative_wrapper, index|
+      puts "%d) Creative wrapper ID: %d, label ID: %d, status: '%s'." %
+          [index, creative_wrapper[:id], creative_wrapper[:label_id],
+           creative_wrapper[:status]]
     end
   end
 
@@ -58,7 +68,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_teams_by_statement()
+    get_creative_wrappers_by_statement()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201308/creative_wrapper_service/update_creative_wrappers.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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.
+#           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 code example updates a creative wrapper to the 'OUTER' wrapping order. To
+# determine which creative wrappers exist, run get_all_creative_wrappers.rb.
+#
+# Tags: CreativeWrapperService.getCreativeWrappersByStatement
+# Tags: CreativeWrapperService.updateCreativeWrappers
+
+require 'dfp_api'
+
+API_VERSION = :v201308
+
+def update_creative_wrappers()
+  # 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 CreativeWrapperService.
+  creative_wrapper_service = dfp.service(:CreativeWrapperService, API_VERSION)
+
+  # Set the ID of the creative wrapper to get.
+  creative_wrapper_id = 'INSERT_CREATIVE_WRAPPER_ID_HERE'.to_i
+
+  # Get creative wrapper by ID.
+  creative_wrapper =
+      creative_wrapper_service.get_creative_wrapper(creative_wrapper_id)
+
+  # Update local creative wrapper object by changing its ordering.
+  creative_wrapper[:ordering] = 'OUTER'
+
+  # Update the creative wrapper on the server.
+  return_creative_wrappers =
+      creative_wrapper_service.update_creative_wrappers([creative_wrapper])
+
+  if return_creative_wrappers
+    return_creative_wrappers.each do |creative_wrapper|
+      puts ("Creative wrapper ID: %d, label ID: %d was updated with ordering" +
+            " '%s'") % [creative_wrapper[:id], creative_wrapper[:label_id],
+                        creative_wrapper[:ordering]]
+    end
+  else
+    puts 'No creative wrappers found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_creative_wrappers()
+
+  # 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/{v201204 → v201308}/custom_field_service/create_custom_field_options.rb

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

data/examples/{v201204 → v201308}/custom_field_service/create_custom_fields.rb

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

data/examples/{v201204 → v201308}/custom_field_service/deactivate_all_line_item_custom_fields.rb

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

data/examples/{v201204 → v201308}/custom_field_service/get_all_custom_fields.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_all_custom_fields()
@@ -60,7 +60,7 @@ def get_all_custom_fields()
       # Print details about each custom field in results.
       page[:results].each_with_index do |custom_field, index|
         if custom_field[:custom_field_type].eql?('DropDownCustomField')
-          drop_down_custom_field_string = custom_field.include?(:options) ?
+          drop_down_custom_field_strings = custom_field.include?(:options) ?
               custom_field[:options].map {|option| option[:display_name]} : []
           print ("%d) Drop-down custom field with ID %d, name '%s', and " +
               "options [%s] was found.") %

data/examples/{v201204 → v201308}/custom_field_service/get_all_line_item_custom_fields.rb

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

data/examples/{v201206 → v201308}/custom_field_service/set_line_item_custom_field_value.rb

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

data/examples/{v201204 → v201308}/custom_field_service/update_custom_fields.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def update_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,7 +46,8 @@ def update_custom_fields()
 
   if custom_field
     # Update local custom field object.
-    custom_field[:description] += ' Updated.'
+    custom_field[:description] = '' if custom_field[:description].nil?
+    custom_field[:description] +=' Updated.'
 
     # Update the custom field on the server.
     return_custom_fields =

data/examples/{v201204 → v201308}/custom_targeting_service/create_custom_targeting_keys_and_values.rb

@@ -28,7 +28,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def create_custom_targeting_keys_and_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -54,7 +54,7 @@ def create_custom_targeting_keys_and_values()
 
   # Create the custom targeting keys on the server.
   return_keys = custom_targeting_service.create_custom_targeting_keys(
-      [gender_key, car_model_key, gender_key])
+      [gender_key, car_model_key, genre_key])
 
   if return_keys
     return_keys.each do |key|

data/examples/{v201206 → v201308}/custom_targeting_service/delete_custom_targeting_keys.rb

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

data/examples/{v201204 → v201308}/custom_targeting_service/delete_custom_targeting_values.rb

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

data/examples/{v201206 → v201308}/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

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

data/examples/{v201206 → v201308}/custom_targeting_service/get_custom_targeting_keys_by_statement.rb

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

data/examples/{v201206 → v201308}/custom_targeting_service/get_custom_targeting_values_by_statement.rb

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

data/examples/{v201206 → v201308}/custom_targeting_service/update_custom_targeting_keys.rb

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

data/examples/{v201206 → v201308}/custom_targeting_service/update_custom_targeting_values.rb

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

data/examples/{v201206 → v201308}/forecast_service/get_forecast.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def get_forecast()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -60,7 +60,7 @@ def get_forecast()
     :creative_placeholders => [creative_placeholder],
     # Set the line item's time to be now until the projected end date time.
     :start_date_time_type => 'IMMEDIATELY',
-    :end_date_time => Time.utc(2012, 01, 01),
+    :end_date_time => Time.utc(2014, 01, 01),
     # Set the line item to use 50% of the impressions.
     :unit_type => 'IMPRESSIONS',
     :units_bought => 50,
@@ -82,6 +82,7 @@ def get_forecast()
       possible_percent = forecast[:possible_units] * 100.0 / matched
       puts "%.2f%% %s possible." % [possible_percent, unit_type]
     end
+    puts "%d contending line items." % forecast[:contending_line_items].size
   end
 end
 

data/examples/{v201206 → v201308}/forecast_service/get_forecast_by_id.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def get_forecast_by_id()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -55,6 +55,7 @@ def get_forecast_by_id()
       possible_percent = forecast[:possible_units] * 100.0 / matched
       puts "%.2f%% %s possible." % [possible_percent, unit_type]
     end
+    puts "%d contending line items." % forecast[:contending_line_items].size
   end
 end