google-dfp-api 0.3.3 → 0.4.0

data/examples/v201208/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 = :v201208
+
+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/v201208/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 = :v201208
+
+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

data/examples/v201208/user_service/get_users_by_statement.rb

@@ -0,0 +1,79 @@
+#!/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 sorted by name. The statement retrieves up to the
+# maximum page size limit of 500. To create new users, run create_users.rb.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201208
+
+def get_users_by_statement()
+  # 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)
+
+  # Create a statement to get all users sorted by name.
+  statement = {:query => 'ORDER BY name LIMIT 500'}
+
+  # Get users by statement.
+  page = user_service.get_users_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]]
+    end
+  end
+
+  # Print a footer.
+  if page.include?(:total_result_set_size)
+    puts "Number of results found: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_users_by_statement()
+
+  # 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/v201208/user_service/update_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 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.
+#
+# Tags: UserService.getUsersByStatement, UserService.updateUsers
+
+require 'dfp_api'
+
+API_VERSION = :v201208
+
+def update_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)
+
+  # 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]
+
+    # Update each local users object by changing its name.
+    users.each {|user| user[:name] += ' Sr.'}
+
+    # 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
+  else
+    puts 'No users found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_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/v201208/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 = :v201208
+
+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

data/examples/v201208/user_team_association_service/delete_user_team_associations.rb

@@ -0,0 +1,111 @@
+#!/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 removes the user from all its teams. To determine which users
+# exist, run get_all_users.rb.
+#
+# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
+# Tags: UserTeamAssociationService.performUserTeamAssociationAction
+
+require 'dfp_api'
+
+API_VERSION = :v201208
+PAGE_SIZE = 500
+
+def delete_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 user to remove from its teams.
+  user_id = 'INSERT_USER_ID_HERE'.to_i
+
+  # Create filter text to remove association by user ID.
+  statement_text = 'WHERE userId = :user_id'
+  statement = {
+      :values => [
+          {:key => 'user_id',
+           :value => {:value => user_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  offset = 0
+  page = {}
+
+  begin
+    # Update statement with the current offset.
+    statement[:query] = statement_text + " LIMIT %d OFFSET %d" %
+        [PAGE_SIZE, offset]
+
+    # Get user team associations by statement.
+    page = uta_service.get_user_team_associations_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      page[:results].each do |association|
+        puts ("User team association of user ID %d with team ID %d will be " +
+            "deleted.") % [association[:user_id], association[:team_id]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Update statement for deletion.
+  statement[:query] = statement_text
+
+  # Perform the action.
+  result = uta_service.perform_user_team_association_action(
+      {:xsi_type => 'DeleteUserTeamAssociations'}, statement)
+
+  # Display results.
+  if result and result[:num_changes] > 0
+    puts "Number of user team associations deleted: %d" % result[:num_changes]
+  else
+    puts 'No user team associations were deleted.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    delete_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