google-dfp-api 0.7.0 → 0.7.1

data/examples/v201311/team_service/update_teams.rb

@@ -0,0 +1,97 @@
+#!/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 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
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def update_teams()
+  # 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')
+
+  # 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)
+
+  # 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)
+
+  if page[:results]
+    teams = page[:results]
+
+    # Create a local set of teams than need to be updated. We are updating by
+    # adding an ad unit to it.
+    updated_teams = teams.inject([]) do |updated_teams, team|
+      # 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
+        # Workaround for issue #94.
+        team[:description] = "" if team[:description].nil?
+        updated_teams << team
+      end
+      updated_teams
+    end
+
+    # Update the teams on the server.
+    return_teams = team_service.update_teams(updated_teams)
+    return_teams.each do |team|
+      puts "Team ID: %d was updated" % team[:id]
+    end
+  else
+    puts 'No teams found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_teams()
+
+  # 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/v201311/user_service/create_users.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 creates new users. To determine which users exist, run
+# get_all_users.rb. To determine which roles exist, run get_all_roles.rb.
+#
+# Tags: UserService.createUsers
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def create_users()
+  # 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 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
+
+  # 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'})
+  end
+
+  # Create the users on the server.
+  return_users = user_service.create_users(users)
+
+  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]]
+    end
+  else
+    raise 'No users were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_users()
+
+  # 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/v201311/user_service/deactivate_users.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 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.
+#
+# Tags: UserService.getUsersByStatement, UserService.performUserAction
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def deactivate_users()
+  # 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 UserService.
+  user_service = dfp.service(:UserService, API_VERSION)
+
+  # Set the ID of the user to deactivate
+  user_id = 'INSERT_USER_ID_HERE'
+
+  # Create filter text to select user by id.
+  statement = {
+      :query => 'WHERE id = :user_id',
+      :values => [
+          {:key => 'user_id',
+           :value => {:value => user_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  # Get users by statement.
+  page = user_service.get_users_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]]
+    end
+
+    # Perform action.
+    result = user_service.perform_user_action(
+        {:xsi_type => 'DeactivateUsers'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of users deactivated: %d" % result[:num_changes]
+    else
+      puts 'No users were deactivated.'
+    end
+  else
+    puts 'No user found to deactivate.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    deactivate_users()
+
+  # 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/v201311/user_service/get_all_roles.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 gets all roles. This example can be used to determine which role
+# ID is needed when getting and creating users.
+#
+# Tags: UserService.getAllRoles
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def get_all_roles()
+  # 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 UserService.
+  user_service = dfp.service(:UserService, API_VERSION)
+
+  # Get all roles.
+  roles = user_service.get_all_roles()
+
+  if roles
+    # Print details about each role in results page.
+    roles.each_with_index do |role, index|
+      puts "%d) Role ID: %d, name: %s" % [index, role[:id], role[:name]]
+    end
+    # Print a footer
+    puts "Total number of roles: %d" % roles.size
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_roles()
+
+  # 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/common/oauth2_handling.rb → v201311/user_service/get_all_users.rb}

@@ -3,7 +3,7 @@
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
+# 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.
@@ -18,18 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example shows how to use OAuth2.0 authorization method. It is designed to
-# be run from console and requires user input.
+# This example gets all users for an account. To create users run
+# create_users.rb.
 #
 # Tags: UserService.getUsersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201311
 PAGE_SIZE = 500
-MAX_RETRIES = 3
 
-def oauth2_handling()
+def get_all_users()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -37,45 +36,19 @@ def oauth2_handling()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Forcing authorization. A callback URL and other parameters could be
-  # specified as parameter for OAuth method.
-  token = dfp.authorize({:oauth_callback => 'oob'}) do |oauth_url|
-    # For command-line we ask user to go to URL and type in code.
-    verification_code = get_verification_code(oauth_url)
-    # Return verification code from the block.
-    (verification_code.empty?) ? nil : verification_code
-  end
-
   # Get the UserService.
   user_service = dfp.service(:UserService, API_VERSION)
 
   # Define initial values.
   offset = 0
-  page = Hash.new
-  retry_count = 0
+  page = {}
 
   begin
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    begin
-      # Get users by statement.
-      page = user_service.get_users_by_statement(statement)
-
-    # The second way to do OAuth authentication is to make a request and catch
-    # the OAuthVerificationRequired exception. Add the verification code to the
-    # credentials once acquired.
-    rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-      if retry_count < MAX_RETRIES
-        verification_code = get_verification_code(e.oauth_url)
-        dfp.credential_handler.set_credential(
-            :oauth2_verification_code, verification_code)
-        retry_count += 1
-        retry
-      else
-        raise AdsCommon::Errors::AuthError, 'Failed to authenticate.'
-      end
-    end
+    # Get users by statement.
+    page = user_service.get_users_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -98,17 +71,9 @@ def oauth2_handling()
   end
 end
 
-# Misc util to get the verification code from the console.
-def get_verification_code(url)
-  puts "Hit Auth error, please navigate to URL:\n\t%s" % url
-  print 'Log in and type the verification code: '
-  verification_code = gets.chomp
-  return verification_code
-end
-
 if __FILE__ == $0
   begin
-    oauth2_handling()
+    get_all_users()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e