google-dfp-api 0.2.8 → 0.3.0

data/examples/{v201103/user_service/create_users.rb → v201203/team_service/create_teams.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,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example creates new users. To determine which users exist, run
-# get_all_users.rb. To determine which roles exist, run get_all_roles.rb.
+# This example creates new teams with the logged in user added to each team. To
+# determine which teams exist, run get_all_teams.rb.
 #
-# Tags: UserService.createUsers
+# Tags: TeamService.createTeams, UserService.getCurrentUser
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
+ITEM_COUNT = 5
 
-def create_users()
+def create_teams()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,41 +36,42 @@ def create_users()
   # 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 UserService.
   user_service = dfp.service(:UserService, API_VERSION)
 
-  # Set the user's email addresses and names.
-  emails_and_names = [
-      {:name => 'INSERT_NAME_HERE',
-       :email => 'INSERT_EMAIL_ADDRESS_HERE'},
-      {:name => 'INSERT_NAME_HERE',
-       :email => 'INSERT_EMAIL_ADDRESS_HERE'}
-  ]
-
-  # Set the role ID for new users.
-  role_id = 'INSERT_ROLE_ID_HERE'.to_i
+  # Get the current user's ID.
+  current_user = user_service.get_current_user()
+  user_id = current_user[:id]
 
-  # Create an array to store local user objects.
-  users = emails_and_names.map do |email_and_name|
-    email_and_name.merge({:role_id => role_id, :preferred_locale => 'en_US'})
+  # Create an array to store local team objects.
+  teams = (1..ITEM_COUNT).map do |index|
+    {
+      :name => "Team #%d" % index,
+      :user_ids => [user_id],
+      :has_all_companies => true,
+      :has_all_inventory => true
+    }
   end
 
-  # Create the users on the server.
-  return_users = user_service.create_users(users)
+  # Create the teams on the server.
+  return_teams = team_service.create_teams(teams)
 
-  if return_users
-    return_users.each do |user|
-      puts "User with ID: %d, name: %s and email: %s was created." %
-          [user[:id], user[:name], user[:email]]
+  if return_teams
+    return_teams.each do |team|
+      puts "Team with ID: %d, name: %s and user ids: [%s] was created." %
+          [team[:id], team[:name], team[:user_ids].join(', ')]
     end
   else
-    raise 'No users were created.'
+    raise 'No teams were created.'
   end
 end
 
 if __FILE__ == $0
   begin
-    create_users()
+    create_teams()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201107/user_service/get_all_users.rb → v201203/team_service/get_all_teams.rb}

@@ -1,8 +1,8 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
 # 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 +17,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all users for an account. To create users run
-# create_users.rb.
+# This example gets all teams. To create teams, run create_teams.rb.
 #
-# Tags: UserService.getUsersByStatement
+# Tags: TeamService.getTeamsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
-def get_all_users()
+def get_all_teams()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,8 +34,8 @@ def get_all_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 TeamService.
+  team_service = dfp.service(:TeamService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -46,8 +45,8 @@ def get_all_users()
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # 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[:results]
       # Increase query offset by page size.
@@ -56,23 +55,23 @@ def get_all_users()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each user in results page.
-      page[:results].each_with_index do |user, index|
-        puts "%d) User ID: %d, name: %s, email: %s" %
-            [index + start_index, user[:id], user[:name], user[:email]]
+      # Print details about each team in results page.
+      page[:results].each_with_index do |team, index|
+        puts "%d) Team ID: %d, name: %s" %
+            [index + start_index, team[:id], team[:name]]
       end
     end
   end while offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)
-    puts "Total number of users: %d" % page[:total_result_set_size]
+    puts "Total number of teams: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_users()
+    get_all_teams()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201104/network_service/get_current_network.rb → v201203/team_service/get_team.rb}

@@ -1,8 +1,8 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
 # 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,15 +17,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets the current network that you can make requests against.
+# This example gets a team by its ID. To determine which teams exist, run
+# get_all_teams.rb.
 #
-# Tags: NetworkService.getCurrentNetwork
+# Tags: TeamService.getTeam
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
-def get_current_network()
+def get_team()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -33,19 +34,26 @@ def get_current_network()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
+  # Get the TeamService.
+  team_service = dfp.service(:TeamService, API_VERSION)
 
-  # Get the current network.
-  network = network_service.get_current_network()
+  # Set the ID of the team to get.
+  team_id = 'INSERT_TEAM_ID_HERE'.to_i
 
-  puts "Current network has network code %d and display name %s." %
-      [network[:network_code], network[:display_name]]
+  # Get the team.
+  team = team_service.get_team(team_id)
+
+  if team
+    puts "Team with ID: %d and name '%s' was found." %
+        [team[:id], team[:name]]
+  else
+    puts 'No team found for this ID.'
+  end
 end
 
 if __FILE__ == $0
   begin
-    get_current_network()
+    get_team()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201103/user_service/update_users.rb → v201203/team_service/get_teams_by_statement.rb}

@@ -1,8 +1,8 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
 # 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 +17,16 @@
 #           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 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.
 #
-# Tags: UserService.getUsersByStatement, UserService.updateUsers
+# Tags: TeamService.getTeamsByStatement, UserService.getCurrentUser
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
-def update_users()
+def get_teams_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,40 +34,39 @@ def update_users()
   # 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 UserService.
   user_service = dfp.service(:UserService, API_VERSION)
 
-  # Create a statement to get all users.
-  statement = {:query => 'LIMIT 500'}
-
-  # Get users by statement.
-  page = user_service.get_users_by_statement(statement)
-
-  if page[:results]
-    users = page[:results]
+  # Get the current user's team IDs.
+  current_user = user_service.get_current_user()
+  team_ids = current_user[:team_ids]
 
-    # Update each local users object by changing its name.
-    users.each {|user| user[:name] += ' Sr.'}
+  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(', ')}
 
-    # Update the users on the server.
-    return_users = user_service.update_users(users)
+    # Get teams by statement.
+    page = team_service.get_teams_by_statement(statement)
 
-    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]]
+    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
-    else
-      raise 'No users were updated.'
     end
-  else
-    puts 'No users found to update.'
+
+    # Print a footer.
+    if page.include?(:total_result_set_size)
+      puts "Number of results found: %d" % page[:total_result_set_size]
+    end
   end
 end
 
 if __FILE__ == $0
   begin
-    update_users()
+    get_teams_by_statement()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201104/user_service/update_users.rb → v201203/team_service/update_teams.rb}

@@ -1,8 +1,8 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
 # 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 +17,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 example updates teams by adding you to them up to the first 500. To
+# determine which teams exist, run get_all_teams.rb.
 #
-# Tags: UserService.getUsersByStatement, UserService.updateUsers
+# Tags: TeamService.getTeamsByStatement, TeamService.updateTeams
+# Tags: UserService.getCurrentUser
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
-def update_users()
+def update_teams()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,40 +35,55 @@ def update_users()
   # 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 UserService.
   user_service = dfp.service(:UserService, API_VERSION)
 
-  # Create a statement to get all users.
+  # 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'}
 
-  # 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[:results]
-    users = page[:results]
+    teams = page[:results]
 
-    # Update each local users object by changing its name.
-    users.each {|user| user[:name] += ' Sr.'}
+    # 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.
+    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
+        updated_teams << team
+        puts "Adding user ID %d into team ID %d" % [user_id, team[:id]]
+      end
+      updated_teams
+    end
 
-    # Update the users on the server.
-    return_users = user_service.update_users(users)
+    # Update the teams on the server.
+    return_teams = team_service.update_teams(updated_teams)
 
-    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]]
+    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 users were updated.'
+      raise 'No teams were updated.'
     end
   else
-    puts 'No users found to update.'
+    puts 'No teams found to update.'
   end
 end
 
 if __FILE__ == $0
   begin
-    update_users()
+    update_teams()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201203/third_party_slot_service/archive_third_party_slots.rb

@@ -0,0 +1,124 @@
+#!/usr/bin/ruby
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, 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 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
+
+require 'dfp_api'
+
+API_VERSION = :v201203
+PAGE_SIZE = 500
+
+def archive_third_party_slots()
+  # 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 ThirdPartySlotService.
+  third_party_slot_service = dfp.service(:ThirdPartySlotService, API_VERSION)
+
+  # Set the company that the third party slots to archive belong to.
+  company_id = 'INSERT_COMPANY_ID_HERE'.to_i
+
+  # Create a statement to only select active third party slots.
+  statement_text = 'WHERE status = :status AND companyId = :company_id'
+
+  # Create statement bind variables.
+  statement = {
+      :query => statement_text,
+      :values => [
+          {:key => 'status',
+           :value => {:value => 'ARCHIVED', :xsi_type => 'TextValue'}},
+          {:key => 'company_id',
+           :value => {:value => company_id, :xsi_type => 'NumberValue'}},
+      ]
+  }
+
+  # Define initial values.
+  offset = 0
+  page = {}
+  third_party_slot_ids = []
+
+  begin
+    # Update the statement to get one page with current offset.
+    statement[:query] =
+        statement_text + " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
+
+    # Get third party slots by statement.
+    page = third_party_slot_service.get_third_party_slots_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      page[:results].each do |slot|
+        puts "%d) Third party slot ID: %d and name: '%s' will be archived." %
+            [third_party_slot_ids.size, slot[:id], slot[:name]]
+        third_party_slot_ids << slot[:id]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  puts "Number of third party slots to be archived: %d" % third_party_slot_ids.size
+
+  unless third_party_slot_ids.empty?
+    # Create statement for action.
+    statement = {:query => "WHERE id IN (%s)" % third_party_slot_ids.join(', ')}
+
+    # Perform action.
+    result = third_party_slot_service.perform_third_party_slot_action(
+        {:xsi_type => 'ArchiveThirdPartySlots'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of third party slots archived: %d" % result[:num_changes]
+    else
+      puts 'No third party slots were archived.'
+    end
+  else
+    puts 'No third party slots found to archive.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    archive_third_party_slots()
+
+  # 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