google-dfp-api 0.4.0 → 0.5.0

data/examples/v201211/custom_field_service/set_line_item_custom_field_value.rb

@@ -0,0 +1,135 @@
+#!/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 example sets custom field values on a line item. To determine which
+# custom fields exist, run get_all_custom_fields.rb. To determine which line
+# items exist, run get_all_line_items.rb. To create custom field options, run
+# create_custom_field_options.rb.
+#
+# Tags: CustomFieldService.getCustomField, LineItemService.getLineItem
+
+require 'dfp_api'
+
+API_VERSION = :v201211
+
+def set_line_item_custom_field_value()
+  # 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 CustomFieldService.
+  custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
+
+  # Get the LineItemService.
+  line_item_service = dfp.service(:LineItemService, API_VERSION)
+
+  # Set the ID of the custom fields, custom field option, and line item.
+  custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
+  drop_down_custom_field_id = 'INSERT_DROP_DOWN_CUSTOM_FIELD_ID_HERE'.to_i
+  custom_field_option_id = 'INSERT_CUSTOM_FIELD_OPTION_ID_HERE'.to_i
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+
+  # Get custom field.
+  custom_field = custom_field_service.get_custom_field(custom_field_id)
+
+  # Get drop-down custom field.
+  drop_down_custom_field = custom_field_service.get_custom_field(
+      drop_down_custom_field_id)
+
+  # Get line item.
+  line_item = line_item_service.get_line_item(line_item_id)
+
+  if custom_field and drop_down_custom_field and line_item
+    # Create custom field values.
+    custom_field_value = {
+      :custom_field_id => custom_field[:id],
+      :type => 'CustomFieldValue',
+      :value => {:type => 'TextValue', :value => 'Custom field value'}
+    }
+
+    drop_down_custom_field_value = {
+      :custom_field_id => drop_down_custom_field[:id],
+      :type => 'DropDownCustomFieldValue',
+      :custom_field_option_id => custom_field_option_id
+    }
+
+    custom_field_values = [custom_field_value, drop_down_custom_field_value]
+    old_custom_field_values = line_item.include?(:custom_field_values) ?
+      line_item[:custom_field_values] : []
+
+    # Only add existing custom field values for different custom fields than the
+    # ones you are setting.
+    old_custom_field_values.each do |old_custom_field_value|
+      unless custom_field_values.map {|value| value[:id]}.include?(
+          old_custom_field_value[:custom_field_id])
+        custom_field_values << old_custom_field_value
+      end
+    end
+
+    line_item[:custom_field_values] = custom_field_values
+
+    # Update the line item on the server.
+    return_line_items = line_item_service.update_line_items([line_item])
+
+    return_line_items.each do |return_line_item|
+      custom_field_value_strings = []
+      if return_line_item.include?(:custom_field_values)
+        return_line_item[:custom_field_values].each do |value|
+          if value[:base_custom_field_value_type].eql?('CustomFieldValue')
+            custom_field_value_strings << "{ID: %d, value: '%s'}" %
+                [value[:custom_field_id], value[:value][:value]]
+          end
+          if value[:base_custom_field_value_type].eql?(
+              'DropDownCustomFieldValue')
+            custom_field_value_strings <<
+                "{ID: %d, custom field option ID: %d}" %
+                [value[:custom_field_id], value[:custom_field_option_id]]
+          end
+        end
+      end
+      puts "Line item ID %d set with custom field values: [%s]" %
+          [return_line_item[:id], custom_field_value_strings.join(', ')]
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    set_line_item_custom_field_value()
+
+  # 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/{v201201/team_service/get_teams_by_statement.rb → v201211/custom_field_service/update_custom_fields.rb}

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,16 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all teams that you belong to. The statement retrieves up to
-# the maximum page size limit of 500. To create teams, run create_teams.rb.
+# This example updates custom field descriptions. To determine which custom
+# fields exist, run get_all_custom_fields.rb.
 #
-# Tags: TeamService.getTeamsByStatement, UserService.getCurrentUser
+# Tags: CustomFieldService.updateCustomFields
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
-def get_teams_by_statement()
+def update_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,39 +35,35 @@ 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 CustomFieldService.
+  custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
 
-  # Get the UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
+  # Set the ID of the custom field to update.
+  custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
 
-  # Get the current user's team IDs.
-  current_user = user_service.get_current_user()
-  team_ids = current_user[:team_ids]
+  # Get custom field.
+  custom_field = custom_field_service.get_custom_field(custom_field_id)
 
-  unless team_ids.empty?
-    # Create a statement to only select teams by their IDs.
-    statement = {:query => "WHERE Id IN (%s) LIMIT 500" % team_ids.join(', ')}
+  if custom_field
+    # Update local custom field object.
+    custom_field[:description] += ' Updated.'
 
-    # Get teams by statement.
-    page = team_service.get_teams_by_statement(statement)
+    # Update the custom field on the server.
+    return_custom_fields =
+        custom_field_service.update_custom_fields([custom_field])
 
-    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]]
-      end
-    end
-
-    # Print a footer.
-    if page.include?(:total_result_set_size)
-      puts "Number of results found: %d" % page[:total_result_set_size]
+    return_custom_fields.each do |custom_field|
+      puts "Custom field ID: %d, name: '%s' and description '%s' was updated." %
+          [custom_field[:id], custom_field[:name], custom_field[:description]]
     end
+  else
+    puts 'No custom fields were found to update.'
   end
 end
 
 if __FILE__ == $0
   begin
-    get_teams_by_statement()
+    update_custom_fields()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201201 → v201211}/custom_targeting_service/create_custom_targeting_keys_and_values.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -22,12 +23,12 @@
 # get_all_custom_targeting_keys_and_values.rb. To target these custom targeting
 # keys and values, run target_custom_criteria.rb.
 #
-# Tags: CustomTargetingService.createCustomTargetingKeys,
-#       CustomTargetingService.createCustomTargetingValues
+# Tags: CustomTargetingService.createCustomTargetingKeys
+# Tags: CustomTargetingService.createCustomTargetingValues
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def create_custom_targeting_keys_and_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201108 → v201211}/custom_targeting_service/delete_custom_targeting_keys.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 deletes custom targeting key by its name. To determine which
 # custom targeting keys exist, run get_all_custom_targeting_keys_and_values.rb.
 #
-# Tags: CustomTargetingService.getCustomTargetingKeysByStatement,
-#       CustomTargetingService.performCustomTargetingKeyAction
+# Tags: CustomTargetingService.getCustomTargetingKeysByStatement
+# Tags: CustomTargetingService.performCustomTargetingKeyAction
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def delete_custom_targeting_keys()

data/examples/{v201201 → v201211}/custom_targeting_service/delete_custom_targeting_values.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 @@
 # To determine which custom targeting keys and values exist, run
 # get_all_custom_targeting_keys_and_values.rb.
 #
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement,
-#       CustomTargetingService.performCustomTargetingValueAction
+# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
+# Tags: CustomTargetingService.performCustomTargetingValueAction
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def delete_custom_targeting_values()

data/examples/{v201108 → v201211}/custom_targeting_service/get_all_custom_targeting_keys_and_values.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 gets all custom targeting keys and the values. To create custom
 # targeting keys and values, run create_custom_targeting_keys_and_values.rb.
 #
-# Tags: CustomTargetingService.getCustomTargetingKeysByStatement,
-#       CustomTargetingService.getCustomTargetingValuesByStatement
+# Tags: CustomTargetingService.getCustomTargetingKeysByStatement
+# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_custom_targeting_keys_and_values()

data/examples/{v201111 → v201211}/custom_targeting_service/get_custom_targeting_keys_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 = :v201111
+API_VERSION = :v201211
 
 def get_custom_targeting_keys_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201111 → v201211}/custom_targeting_service/get_custom_targeting_values_by_statement.rb

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

data/examples/{v201201 → v201211}/custom_targeting_service/update_custom_targeting_keys.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 @@
 # first 500. To determine which custom targeting keys exist, run
 # get_all_custom_targeting_keys_and_values.rb.
 #
-# Tags: CustomTargetingService.getCustomTargetingKeysByStatement,
-#       CustomTargetingService.updateCustomTargetingKeys
+# Tags: CustomTargetingService.getCustomTargetingKeysByStatement
+# Tags: CustomTargetingService.updateCustomTargetingKeys
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def update_custom_targeting_keys()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/custom_targeting_service/update_custom_targeting_values.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 @@
 # the first 500. To determine which custom targeting keys exist, run
 # get_all_custom_targeting_keys_and_values.rb.
 #
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement,
-#       CustomTargetingService.updateCustomTargetingValues
+# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
+# Tags: CustomTargetingService.updateCustomTargetingValues
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def update_custom_targeting_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201111 → v201211}/forecast_service/get_forecast.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
 
 def get_forecast()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201111 → v201211}/forecast_service/get_forecast_by_id.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
 
 def get_forecast_by_id()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/inventory_service/create_ad_units.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
 # Number of ad units to create.
 ITEM_COUNT = 5
 

data/examples/{v201111 → v201211}/inventory_service/create_mobile_ad_unit.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,7 +18,7 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example creates a new mobile ad unit under a the effective root ad unit.
+# This example creates a new mobile ad unit under the effective root ad unit.
 # To determine which ad units exist, run get_inventory_tree.rb or
 # get_all_ad_units.rb.
 #
@@ -27,7 +28,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 
 def create_mobile_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -62,6 +63,7 @@ def create_mobile_ad_unit()
      :description => 'Mobile Ad unit description',
      :target_window => 'BLANK',
      :target_platform => 'MOBILE',
+     :mobile_platform => 'APPLICATION',
      # Set the size of possible creatives that can match this ad unit.
      :ad_unit_sizes => [ad_unit_size]
   }