google-dfp-api 0.4.0 → 0.5.0

data/examples/{v201201 → v201211}/team_service/get_all_teams.rb

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

data/examples/{v201201 → v201211}/team_service/get_team.rb

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

data/examples/{v201111/user_service/get_users_by_statement.rb → v201211/team_service/get_teams_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,16 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all users sorted by name. The statement retrieves up to the
-# maximum page size limit of 500. To create new users, run create_users.rb.
+# 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.
 #
-# Tags: UserService.getUsersByStatement
+# Tags: TeamService.getTeamsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 
-def get_users_by_statement()
+def get_teams_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,19 +35,18 @@ def get_users_by_statement()
   # 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 TeamService.
+  team_service = dfp.service(:TeamService, API_VERSION)
 
-  # Create a statement to get all users sorted by name.
-  statement = {:query => 'ORDER BY name LIMIT 500'}
+  # Create a statement to order teams by name.
+  statement = {:query => "ORDER BY name LIMIT 500"}
 
-  # Get users by statement.
-  page = user_service.get_users_by_statement(statement)
+  # Get teams by statement.
+  page = team_service.get_teams_by_statement(statement)
 
   if page and page[:results]
-    page[:results].each_with_index do |user, index|
-      puts "%d) User ID: %d, name: %s, email: %s, role: %s." % [index,
-          user[:id], user[:name], user[:email], user[:role_name]]
+    page[:results].each_with_index do |team, index|
+      puts "%d) Team ID: %d, name: %s." % [index, team[:id], team[:name]]
     end
   end
 
@@ -58,7 +58,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_users_by_statement()
+    get_teams_by_statement()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201201 → v201211}/team_service/update_teams.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,15 +18,15 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates teams by adding you to them up to the first 500. To
-# determine which teams exist, run get_all_teams.rb.
+# This example updates teams by adding an ad unit to the first 5. To determine
+# which teams exist, run get_all_teams.rb. To determine which ad units exist,
+# run get_all_ad_units.rb.
 #
 # Tags: TeamService.getTeamsByStatement, TeamService.updateTeams
-# Tags: UserService.getCurrentUser
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def update_teams()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -35,18 +36,14 @@ def update_teams()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
+  # Set the ID of the ad unit to add to the teams.
+  ad_unit_id = 'INSERT_AD_UNIT_ID_HERE'.to_i
+
   # Get the TeamService.
   team_service = dfp.service(:TeamService, API_VERSION)
 
-  # Get the UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
-
-  # Get the current user's ID.
-  current_user = user_service.get_current_user()
-  user_id = current_user[:id]
-
-  # Create a statement to select first 500 teams.
-  statement = {:query => 'LIMIT 500'}
+  # Create a statement to select first 5 teams that aren't built-in.
+  statement = {:query => 'WHERE id > 0 LIMIT 5'}
 
   # Get teams by statement.
   page = team_service.get_teams_by_statement(statement)
@@ -55,26 +52,21 @@ def update_teams()
     teams = page[:results]
 
     # Create a local set of teams than need to be updated. We are updating by
-    # adding the current user to it, if it is not already there.
+    # adding an ad unit to it.
     updated_teams = teams.inject([]) do |updated_teams, team|
-      unless team[:user_ids].nil? or team[:user_ids].include?(user_id)
-        team[:user_ids] << user_id
+      # Don't add ad unit if the team has all inventory already.
+      unless team[:has_all_inventory]
+        team[:ad_unit_ids] ||= []
+        team[:ad_unit_ids] << ad_unit_id
         updated_teams << team
-        puts "Adding user ID %d into team ID %d" % [user_id, team[:id]]
       end
       updated_teams
     end
 
     # Update the teams on the server.
     return_teams = team_service.update_teams(updated_teams)
-
-    if return_teams
-      return_teams.each do |team|
-        puts ("Team ID: %d was updated with user ids: [%s]") %
-            [team[:id], team[:user_ids].join(', ')]
-      end
-    else
-      raise 'No teams were updated.'
+    return_teams.each do |team|
+      puts "Team ID: %d was updated" % team[:id]
     end
   else
     puts 'No teams found to update.'

data/examples/{v201111 → v201211}/third_party_slot_service/archive_third_party_slots.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 archives all active third party slots for a company. To determine
 # which third party slots exist, run get_all_third_party_slots.rb.
 #
-# Tags: ThirdPartSlotService.getThirdPartySlotsByStatement,
-#       ThirdPartSlotService.performThirdPartySlotsAction
+# Tags: ThirdPartSlotService.getThirdPartySlotsByStatement
+# Tags: ThirdPartSlotService.performThirdPartySlotsAction
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def archive_third_party_slots()

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

data/examples/{v201111 → v201211}/third_party_slot_service/get_all_third_party_slots.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
 PAGE_SIZE = 500
 
 def get_all_third_party_slots()

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

data/examples/{v201111 → v201211}/third_party_slot_service/update_third_party_slots.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -19,12 +20,12 @@
 #
 # This example updates the first third party slot description.
 #
-# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement,
-#       ThirdPartySlotService.updateThirdPartySlots
+# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement
+# Tags: ThirdPartySlotService.updateThirdPartySlots
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def update_third_party_slots()

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

data/examples/{v201201 → v201211}/user_service/deactivate_users.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -21,13 +22,11 @@
 # to the API. The user making the request cannot deactivate itself. To determine
 # which users exist, run get_all_users.rb.
 #
-# Tags: UserService.getUsersByStatement,
-#       UserService.performUserAction
+# Tags: UserService.getUsersByStatement, UserService.performUserAction
 
 require 'dfp_api'
 
-API_VERSION = :v201201
-PAGE_SIZE = 500
+API_VERSION = :v201211
 
 def deactivate_users()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

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

data/examples/{v201201 → v201211}/user_service/get_all_users.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 = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_users()

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

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

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

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

data/examples/v201211/user_team_association_service/create_user_team_associations.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 example adds a user to a team by creating an association between the two.
+# To determine which teams exist, run get_all_teams.rb. To determine which users
+# exist, run get_all_users.rb.
+#
+# Tags: UserTeamAssociationService.createUserTeamAssociations
+
+require 'dfp_api'
+
+API_VERSION = :v201211
+
+def create_user_team_associations()
+  # 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 UserTeamAssociationService.
+  uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
+
+  # Set the users and team to add them to.
+  team_id = 'INSERT_TEAM_ID_HERE'.to_i
+  user_ids = ['INSERT_USER_ID_HERE'.to_i]
+
+  # Create an array to store local user team association objects.
+  associations = user_ids.map do |user_id|
+    {
+      :user_id => user_id,
+      :team_id => team_id
+    }
+  end
+
+  # Create the user team associations on the server.
+  return_associations = uta_service.create_user_team_associations(associations)
+
+  if return_associations
+    return_associations.each do |association|
+      puts ("A user team association between user ID %d and team ID %d was " +
+          "created.") % [association[:user_id], association[:team_id]]
+    end
+  else
+    raise 'No user team associations were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_user_team_associations()
+
+  # 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