google-dfp-api 0.6.3 → 0.7.0

data/examples/{v201206 → v201308}/creative_service/copy_image_creatives.rb

@@ -28,7 +28,7 @@ require 'dfp_api'
 
 require 'base64'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def copy_image_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -72,7 +72,7 @@ def copy_image_creatives()
       new_creative[:name] += " (Copy of %d)" % old_id
       image_url = new_creative.delete(:image_url)
       new_creative[:image_byte_array] =
-          Base64.encode64(AdsCommon::Http.get(image_url))
+          Base64.encode64(AdsCommon::Http.get(image_url, dfp.config))
       new_creative
     end
 

data/examples/{v201206 → v201308}/creative_service/create_creative_from_template.rb

@@ -28,7 +28,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def create_creative_from_template()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -60,7 +60,7 @@ def create_creative_from_template()
   # Prepare image data for asset value.
   image_url =
       'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
-  image_data = AdsCommon::Http.get(image_url)
+  image_data = AdsCommon::Http.get(image_url, dfp.config)
   image_data_base64 = Base64.encode64(image_data)
 
   # Create the asset variable value.

data/examples/{v201204 → v201308}/creative_service/create_creatives.rb

@@ -27,7 +27,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 # Number of creatives to create.
 ITEM_COUNT = 5
 
@@ -49,18 +49,24 @@ def create_creatives()
   # Prepare image data for creative.
   image_url =
       'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
-  image_data = AdsCommon::Http.get(image_url)
+  image_data = AdsCommon::Http.get(image_url, dfp.config)
   image_data_base64 = Base64.encode64(image_data)
+  size = {:width => 300, :height => 250}
 
   # Create an array to store local creative objects.
   creatives = (1..ITEM_COUNT).map do |index|
-    {:xsi_type => 'ImageCreative',
-     :name => "Image creative #%d" % index,
-     :advertiser_id => advertiser_id,
-     :destination_url => 'http://www.google.com',
-     :image_name => 'image.jpg',
-     :size => {:width => 300, :height => 250, :is_aspect_ratio => false},
-     :image_byte_array => image_data_base64}
+    {
+        :xsi_type => 'ImageCreative',
+        :name => "Image creative #%d-%d" % [index, (Time.new.to_f * 1000).to_i],
+        :advertiser_id => advertiser_id,
+        :destination_url => 'http://www.google.com',
+        :size => size,
+        :primary_image_asset => {
+            :file_name => 'image.jpg',
+            :asset_byte_array => image_data_base64,
+            :size => size
+        }
+    }
   end
 
   # Create the creatives on the server.

data/examples/{v201206 → v201308}/creative_service/create_custom_creative.rb

@@ -29,7 +29,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def create_custom_creative()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -49,7 +49,7 @@ def create_custom_creative()
   # Prepare image data for creative.
   image_url =
       'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
-  image_data = AdsCommon::Http.get(image_url)
+  image_data = AdsCommon::Http.get(image_url, dfp.config)
   image_data_base64 = Base64.encode64(image_data)
 
   # Create an array to store local creative objects.

data/examples/{v201206 → v201308}/creative_service/get_all_creatives.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_all_creatives()
@@ -60,7 +60,7 @@ def get_all_creatives()
       page[:results].each_with_index do |creative, index|
         puts "%d) Creative ID: %d, name: %s, type: %s" %
             [index + start_index, creative[:id],
-             creative[:name], creative[:type]]
+             creative[:name], creative[:creative_type]]
       end
     end
   end while offset < page[:total_result_set_size]

data/examples/{v201206 → v201308}/creative_service/get_creative.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def get_creative()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,7 +46,7 @@ def get_creative()
 
   if creative
     puts "Creative with ID: %d, name: %s and type: %s was found." %
-        [creative[:id], creative[:name], creative[:type]]
+        [creative[:id], creative[:name], creative[:creative_type]]
   end
 end
 

data/examples/{v201204 → v201308}/creative_service/get_creatives_by_statement.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def get_creatives_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -55,7 +55,7 @@ def get_creatives_by_statement()
     # Print details about each creative in results.
     page[:results].each_with_index do |creative, index|
       puts "%d) Creative ID: %d, name: %s, type: %s" %
-          [index, creative[:id], creative[:name], creative[:type]]
+          [index, creative[:id], creative[:name], creative[:creative_type]]
     end
   end
 

data/examples/{v201206 → v201308}/creative_service/update_creatives.rb

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

data/examples/{v201206/line_item_creative_association_service/get_lica.rb → v201308/creative_set_service/associate_creative_set_to_line_item.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,17 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets a line item creative association (LICA) by the line item and
-# creative ID. To determine which line items exist, run get_all_line_items.rb.
-# To determine which creatives exit, run get_all_creatives.rb.
+# This code example creates a line item creative association for a creative
+# set. To create creative sets, run create_creative_set.rb. To create creatives,
+# run create_creatives.rb. To determine which LICAs exist, run get_all_licas.rb.
 #
-# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociation
+# Tags: LineItemCreativeAssociationService.createLineItemCreativeAssociations
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
-def get_lica()
+def associate_creative_set_to_line_item()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -36,36 +36,36 @@ def get_lica()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
+  # Set the line item ID and creative set ID to associate.
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+  creative_set_id = 'INSERT_CREATIVE_SET_ID_HERE'.to_i
+
   # Get the LineItemCreativeAssociationService.
   lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
 
-  # Set the line item and creative IDs to use to retrieve the LICA.
-  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
-  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
+  lica = {
+    :creative_set_id => creative_set_id,
+    :line_item_id => line_item_id
+  }
 
-  # Get the LICA.
-  lica =
-      lica_service.get_line_item_creative_association(line_item_id, creative_id)
+  # Create the LICAs on the server.
+  return_lica = lica_service.create_line_item_creative_associations([lica])
 
-  if lica
-    puts ("LICA with line item ID: %d, creative ID: %d and status: %s was " +
-        "found.") % [lica[:line_item_id], lica[:creative_id], lica[:status]]
-  else
-    puts 'No lica found for this ID.'
-  end
+  puts 'A LICA with line item ID %d and creative set ID %d was created.' %
+      [return_lica[:line_item_id], return_lica[:creative_set_id]]
 end
 
 if __FILE__ == $0
   begin
-    get_lica()
+    associate_creative_set_to_line_item()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
+    puts 'HTTP Error: %s' % e
 
   # API errors.
   rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
+    puts 'Message: %s' % e.message
     puts 'Errors:'
     e.errors.each_with_index do |error, index|
       puts "\tError [%d]:" % (index + 1)

data/examples/{v201206 → v201308}/creative_set_service/create_creative_set.rb

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

data/examples/{v201206 → v201308}/creative_set_service/get_all_creative_sets.rb

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

data/examples/{v201206 → v201308}/creative_set_service/get_creative_sets_by_statement.rb

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

data/examples/{v201206 → v201308}/creative_set_service/update_creative_sets.rb

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

data/examples/{v201206 → v201308}/creative_template_service/get_all_creative_templates.rb

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

data/examples/{v201204 → v201308}/creative_template_service/get_creative_template.rb

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

data/examples/{v201206 → v201308}/creative_template_service/get_creative_templates_by_statement.rb

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

data/examples/v201308/creative_wrapper_service/create_creative_wrappers.rb

@@ -0,0 +1,89 @@
+#!/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 creates a new creative wrapper.
+#
+# Creative wrappers must be associated with a LabelType.CREATIVE_WRAPPER label
+# and applied to ad units by AdUnit.appliedLabels. To determine which creative
+# wrappers exist, run get_all_creative_wrappers.rb.
+#
+# Tags: CreativeWrapperService.createCreativeWrappers
+
+require 'dfp_api'
+
+API_VERSION = :v201308
+
+def create_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 creative wrapper label ID.
+  label_id = 'INSERT_CREATIVE_WRAPPER_LABEL_ID_HERE'.to_i
+
+  # Create creative wrapper objects.
+  creative_wrapper = {
+    # A label can only be associated with one creative wrapper.
+    :label_id => label_id,
+    :ordering => 'INNER',
+    :header => {:html_snippet => '<b>My creative wrapper header</b>'},
+    :footer => {:html_snippet => '<b>My creative wrapper footer</b>'}
+  }
+
+  # Create the creative wrapper on the server.
+  return_creative_wrappers =
+      creative_wrapper_service.create_creative_wrappers([creative_wrapper])
+
+  if return_creative_wrappers
+    return_creative_wrappers.each do |creative_wrapper|
+      puts "Creative wrapper with ID: %d applying to label: %d was created." %
+          [creative_wrapper[:id], creative_wrapper[:label_id]]
+    end
+  else
+    raise 'No creative wrappers were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_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/{v201206/user_service/deactivate_users.rb → v201308/creative_wrapper_service/deactivate_creative_wrapper.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,17 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example deactivates a user. Deactivated users can no longer make requests
-# to the API. The user making the request cannot deactivate itself. To determine
-# which users exist, run get_all_users.rb.
+# This example deactivates a creative wrapper belonging to a label.
 #
-# Tags: UserService.getUsersByStatement, UserService.performUserAction
+# Tags: CreativeWrapperService.getCreativeWrappersByStatement
+# Tags: CreativeWrapperService.performCreativeWrapperAction
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
-def deactivate_users()
+def deactivate_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -36,48 +35,54 @@ def deactivate_users()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
+  # Get the CreativeWrapperService.
+  creative_wrapper_service = dfp.service(:CreativeWrapperService, API_VERSION)
 
-  # Set the ID of the user to deactivate
-  user_id = 'INSERT_USER_ID_HERE'
+  # Set the ID of the label for the creative wrapper to deactivate.
+  label_id = 'INSERT_CREATIVE_WRAPPER_LABEL_ID_HERE'.to_i
 
-  # Create filter text to select user by id.
+  # Create statement to select creative wrappers by label id and status.
   statement = {
-      :query => 'WHERE id = :user_id',
+      :query => 'WHERE labelId = :label_id AND status = :status',
       :values => [
-          {:key => 'user_id',
-           :value => {:value => user_id, :xsi_type => 'NumberValue'}}
+        {
+          :key => 'label_id',
+          :value => {:value => label_id, :xsi_type => 'NumberValue'}
+        },
+        {
+          :key => 'status',
+          :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}
+        }
       ]
   }
 
-  # Get users by statement.
-  page = user_service.get_users_by_statement(statement)
+  # Get creative wrappers by statement.
+  page = creative_wrapper_service.get_creative_wrappers_by_statement(statement)
 
   if page[:results]
-    page[:results].each do |user|
-      puts "User ID: %d, name: %s and status: %s will be deactivated." %
-          [user[:id], user[:name], user[:status]]
+    page[:results].each do |creative_wrapper|
+      puts 'Creative wrapper ID: %d, label: %d will be deactivated.' %
+          [creative_wrapper[:id], creative_wrapper[:label_id]]
     end
 
     # Perform action.
-    result = user_service.perform_user_action(
-        {:xsi_type => 'DeactivateUsers'}, statement)
+    result = creative_wrapper_service.perform_creative_wrapper_action(
+        {:xsi_type => 'DeactivateCreativeWrappers'}, statement)
 
     # Display results.
     if result and result[:num_changes] > 0
-      puts "Number of users deactivated: %d" % result[:num_changes]
+      puts 'Number of creative wrappers deactivated: %d' % result[:num_changes]
     else
-      puts 'No users were deactivated.'
+      puts 'No creative wrappers were deactivated.'
     end
   else
-    puts 'No user found to deactivate.'
+    puts 'No creative wrapper found to deactivate.'
   end
 end
 
 if __FILE__ == $0
   begin
-    deactivate_users()
+    deactivate_creative_wrappers()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e