google-dfp-api 0.8.0 → 0.8.1

data/examples/v201308/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 = :v201308
+
+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/v201308/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 = :v201308
+
+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/v201308/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 = :v201308
+
+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/v201308/user_service/get_all_users.rb

@@ -0,0 +1,93 @@
+#!/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 users for an account. To create users run
+# create_users.rb.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201308
+PAGE_SIZE = 500
+
+def get_all_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)
+
+  # 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 users by statement.
+    page = user_service.get_users_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 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]]
+      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]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_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/v201308/user_service/get_current_user.rb

@@ -0,0 +1,66 @@
+#!/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 the current user.
+#
+# Tags: UserService.getCurrentUser
+
+require 'dfp_api'
+
+API_VERSION = :v201308
+
+def get_current_user()
+  # 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 the current user.
+  user = user_service.get_current_user()
+
+  puts "Current user has ID %d, email %s and role %s." %
+      [user[:id], user[:email], user[:role_name]]
+end
+
+if __FILE__ == $0
+  begin
+    get_current_user()
+
+  # 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/v201308/user_service/get_user.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 a user by its ID. To create users, run create_users.rb.
+#
+# Tags: UserService.getUser
+
+require 'dfp_api'
+
+API_VERSION = :v201308
+
+def get_user()
+  # 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 get.
+  user_id = 'INSERT_USER_ID_HERE'.to_i
+
+  # Get the user.
+  user = user_service.get_user(user_id)
+
+  if user
+    puts "User with ID: %d, name: %s, email: %s and role: %s was found." %
+        [user[:id], user[:name], user[:email], user[:role_name]]
+  else
+    puts 'No user found for this ID.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_user()
+
+  # 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