google-dfp-api 0.4.0 → 0.5.0

data/examples/{v201201 → v201211}/creative_service/get_creatives_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 = :v201201
+API_VERSION = :v201211
 
 def get_creatives_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -54,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/{v201108 → v201211}/creative_service/update_creatives.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 = :v201108
+API_VERSION = :v201211
 
 def update_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201/line_item_creative_association_service/get_lica.rb → v201211/creative_set_service/associate_creative_set_to_line_item.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 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 = :v201201
+API_VERSION = :v201211
 
-def get_lica()
+def associate_creative_set_to_line_item()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,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/v201211/creative_set_service/create_creative_set.rb

@@ -0,0 +1,83 @@
+#!/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 set.
+#
+# Tags: CreativeSetService.createCreativeSet
+
+require 'dfp_api'
+
+API_VERSION = :v201211
+
+def create_creative_set()
+  # 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')
+
+  master_creative_id = 'INSERT_MASTER_CREATIVE_ID_HERE'.to_i
+  companion_creative_id = 'INSERT_COMPANION_CREATIVE_ID_HERE'.to_i
+
+  # Get the CreativeSetService.
+  creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
+
+  # Create an array to store local creative set object.
+  creative_set = {
+      :name => 'Creative set #%d' % (Time.new.to_f * 1000),
+      :master_creative_id => master_creative_id,
+      :companion_creative_ids => [companion_creative_id]
+  }
+
+  # Create the creative set on the server.
+  return_set = creative_set_service.create_creative_set(creative_set)
+
+  if return_set
+    puts ('Creative set with ID: %d, master creative ID: %d and companion ' +
+        'creative IDs: [%s] was created') %
+        [return_set[:id], return_set[:master_creative_id],
+         return_set[:companion_creative_ids].join(', ')]
+  else
+    raise 'No creative set was created.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    create_creative_set()
+
+  # 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/v201211/creative_set_service/get_all_creative_sets.rb

@@ -0,0 +1,94 @@
+#!/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 gets all creative sets. To create creative sets run
+# create_creative_set.rb.
+#
+# Tags: CreativeSetService.getCreativeSetsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201211
+PAGE_SIZE = 500
+
+def get_all_creative_sets()
+  # 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 CreativeSetService.
+  creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {:query => 'LIMIT %d OFFSET %d' % [PAGE_SIZE, offset]}
+
+    # Get creative sets by statement.
+    page = creative_set_service.get_creative_sets_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      # Get the start index for printout.
+      start_index = page[:start_index]
+
+      # Print details about each creative set in results page.
+      page[:results].each_with_index do |set, index|
+        puts ('%d) Creative set ID: %d, master creative ID: %d and companion ' +
+            'creative IDs: [%s]') % [index + start_index, set[:id],
+            set[:master_creative_id], set[:companion_creative_ids].join(', ')]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of creative sets: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_creative_sets()
+
+  # 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/line_item_service/get_line_items_by_statement.rb → v201211/creative_set_service/get_creative_sets_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 all line items for the given order. The statement retrieves
-# up to the maximum page size limit of 500. To create line items, run
-# create_line_items.rb. To determine which orders exist, run get_all_orders.rb.
+# This code example gets all creative sets for a master creative. To create
+# creative sets, run create_creative_sets.rb.
 #
-# Tags: LineItemService.getLineItemsByStatement
+# Tags: CreativeSetService.getCreativeSetsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
-def get_line_items_by_statement()
+def get_creative_sets_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,40 +35,42 @@ def get_line_items_by_statement()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the LineItemService.
-  line_item_service = dfp.service(:LineItemService, API_VERSION)
+  master_creative_id = 'INSERT_MASTER_CREATIVE_ID_HERE'.to_i
 
-  # Set the ID of the order to get line items from.
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
+  # Get the CreativeSetService.
+  creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
 
-  # Create a statement to only select line items from a given order.
+  # Create a statement to get all creative sets that have the given master
+  # creative.
   statement = {
-      :query => 'WHERE orderId = :order_id LIMIT 500',
+      :query => 'WHERE masterCreativeId = :master_creative_id',
       :values => [
-          {:key => 'order_id',
-           :value => {:value => order_id, :xsi_type => 'NumberValue'}}
+          {:key => 'master_creative_id',
+           :value => {:value => master_creative_id, :xsi_type => 'NumberValue'}}
       ]
   }
 
-  # Get line items by statement.
-  page = line_item_service.get_line_items_by_statement(statement)
+  # Get creative sets by statement.
+  page = creative_set_service.get_creative_sets_by_statement(statement)
 
   if page and page[:results]
-    page[:results].each_with_index do |line_item, index|
-      puts "%d) [%d] belongs to order ID %d, name: %s." % [index,
-          line_item[:id], line_item[:order_id], line_item[:name]]
+    page[:results].each_with_index do |creative_set, index|
+      puts ('%d) Creative set ID: %d, master creative ID: %d and companion ' +
+          'creative IDs: [%s]') %
+          [index, creative_set[:id], creative_set[:master_creative_id],
+           creative_set[:companion_creative_ids].join(', ')]
     end
   end
 
   # Print a footer.
   if page.include?(:total_result_set_size)
-    puts "Number of results found: %d" % page[:total_result_set_size]
+    puts 'Number of results found: %d' % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_line_items_by_statement()
+    get_creative_sets_by_statement()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201111/user_service/update_users.rb → v201211/creative_set_service/update_creative_sets.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,17 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates all users by adding "Sr." to the end of each name (after
-# a very large baby boom and lack of creativity). To determine which users
-# exist, run get_all_users.rb.
+# This code example updates a creative set by adding a companion creative. To
+# determine which creative sets exist, run get_all_creative_sets.rb.
 #
-# Tags: UserService.getUsersByStatement, UserService.updateUsers
+# Tags: CreativeSetService.getCreativeSet
+# Tags: CreativeSetService.updateCreativeSet
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 
-def update_users()
+def update_creative_sets()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,40 +36,36 @@ def update_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)
+  # Set the IDs of the creative set to get and companion creative ID to add.
+  creative_set_id = 'INSERT_CREATIVE_SET_ID_HERE'.to_i
+  companion_creative_id = 'INSERT_COMPANION_CREATIVE_ID_HERE'.to_i
 
-  # Create a statement to get all users.
-  statement = {:query => 'LIMIT 500'}
+  # Get the CreativeSetService.
+  creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
 
-  # Get users by statement.
-  page = user_service.get_users_by_statement(statement)
+  # Get creative set.
+  creative_set = creative_set_service.get_creative_set(creative_set_id)
 
-  if page[:results]
-    users = page[:results]
+  # Update the creative set locally.
+  creative_set[:companion_creative_ids] << companion_creative_id
 
-    # Update each local users object by changing its name.
-    users.each {|user| user[:name] += ' Sr.'}
+  # Update the creative set on the server.
+  return_creative_set = creative_set_service.update_creative_set(creative_set)
 
-    # Update the users on the server.
-    return_users = user_service.update_users(users)
-
-    if return_users
-      return_users.each do |user|
-        puts ("User ID: %d, email: %s was updated with name %s") %
-            [user[:id], user[:email], user[:name]]
-      end
-    else
-      raise 'No users were updated.'
-    end
+  if return_creative_set
+     puts ('Creative set ID: %d, master creative ID: %d was updated with ' +
+         'companion creative IDs: [%s]') %
+         [creative_set[:id],
+          creative_set[:master_creative_id],
+          creative_set[:companion_creative_ids].join(', ')]
   else
-    puts 'No users found to update.'
+    raise 'No creative sets were updated.'
   end
 end
 
 if __FILE__ == $0
   begin
-    update_users()
+    update_creative_sets()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e