google-dfp-api 0.4.0 → 0.5.0

data/examples/{v201111 → v201211}/creative_template_service/get_all_creative_templates.rb

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

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

data/examples/{v201111 → v201211}/creative_template_service/get_creative_templates_by_statement.rb

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

data/examples/v201211/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 = :v201211
+
+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/{v201108/user_service/deactivate_users.rb → v201211/creative_wrapper_service/deactivate_creative_wrapper.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,19 +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 = :v201108
-PAGE_SIZE = 500
+API_VERSION = :v201211
 
-def deactivate_users()
+def deactivate_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -37,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

data/examples/{v201108/line_item_creative_association_service/get_all_licas.rb → v201211/creative_wrapper_service/get_all_creative_wrappers.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,17 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all line item creative associations (LICA). To create LICAs,
-# run create_licas.rb.
+# This example gets all creative wrappers for an account. To create creative
+# wrappers, run create_creative_wrappers.rb.
 #
-# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
+# Tags: CreativeWrapperService.getCreativeWrappersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
-def get_all_licas()
+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_licas()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the LineItemCreativeAssociationService.
-  lica_service = dfp.service(:LineItemCreativeAssociationService, 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_licas()
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get LICAs by statement.
+    # Get creative wrappers by statement.
     page =
-        lica_service.get_line_item_creative_associations_by_statement(statement)
+      creative_wrapper_service.get_creative_wrappers_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -57,24 +58,23 @@ def get_all_licas()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each LICA in results page.
-      page[:results].each_with_index do |lica, index|
-        puts "%d) LICA with line item ID: %d, creative ID: %d and status: %s" %
-            [index + start_index, lica[:line_item_id], lica[:creative_id],
-             lica[:status]]
+      # 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 LICAs: %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_licas()
+    get_all_creative_wrappers()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201201/third_party_slot_service/get_third_party_slot_by_statement.rb → v201211/creative_wrapper_service/get_creative_wrappers_by_statement.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,17 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets archived third party slots. The statement retrieves up to
-# the maximum page size limit of 500. To create third party slots, run
-# create_third_party_slot.rb.
+# This code example gets all active creative wrappers. To create creative
+# wrappers, run create_creative_wrappers.rb.
 #
-# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement
+# Tags: CreativeWrapperService.getCreativeWrappersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
-def get_third_party_slot_by_statement()
+def get_creative_wrappers_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,25 +35,28 @@ def get_third_party_slot_by_statement()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the ThirdPartySlotService.
-  third_party_slot_service = dfp.service(:ThirdPartySlotService, API_VERSION)
+  # Get the CreativeWrapperService.
+  creative_wrapper_service = dfp.service(:CreativeWrapperService, API_VERSION)
 
-  # Create a statement to get all slots with status 'ARCHIVED'.
+  # Create filter text to select active creative wrappers.
   statement = {
-      :query => 'WHERE status = :status LIMIT 500',
+      :query => 'WHERE status = :status',
       :values => [
-          {:key => 'status',
-           :value => {:value => 'ARCHIVED', :xsi_type => 'TextValue'}}
+        {
+          :key => 'status',
+          :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}
+        }
       ]
   }
 
-  # Get third party slots by statement.
-  page = third_party_slot_service.get_third_party_slots_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 |slot, index|
-      puts "%d) Third party slot ID: %d, name: '%s'" %
-          [index, slot[:id], slot[: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
 
@@ -65,7 +68,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_third_party_slot_by_statement()
+    get_creative_wrappers_by_statement()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201211/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 = :v201211
+
+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