google-dfp-api 0.6.3 → 0.7.0

data/examples/v201204/third_party_slot_service/update_third_party_slots.rb

@@ -1,95 +0,0 @@
-#!/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 the first third party slot description.
-#
-# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement
-# Tags: ThirdPartySlotService.updateThirdPartySlots
-
-require 'dfp_api'
-
-API_VERSION = :v201204
-PAGE_SIZE = 500
-
-def update_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)
-
-  # Create statement to get one active third party slot.
-  statement = {
-      :query => 'WHERE status = :status LIMIT 1',
-      :values => [
-          {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}},
-      ]
-  }
-
-  # Get third party slots by statement.
-  page = third_party_slot_service.get_third_party_slots_by_statement(statement)
-
-  if page[:results] and !page[:results].empty?
-    slot = page[:results].first
-
-    # Update local third party slot by changing its description.
-    slot[:description] = 'Updated description'
-
-    # Update the third party slot on the server.
-    return_slot = third_party_slot_service.update_third_party_slot(slot)
-
-    # Display results.
-    if return_slot
-      puts ("Third party slot with ID %d and name '%s' was updated with " +
-            "description '%s'.") %
-          [return_slot[:id], return_slot[:name], return_slot[:description]]
-    else
-      puts 'No third party slots were updated.'
-    end
-  else
-    puts 'No third party slots found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_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

data/examples/v201204/user_service/create_users.rb

@@ -1,89 +0,0 @@
-#!/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 = :v201204
-
-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/v201204/user_service/get_current_user.rb

@@ -1,66 +0,0 @@
-#!/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 = :v201204
-
-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/v201204/user_service/get_user.rb

@@ -1,73 +0,0 @@
-#!/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 = :v201204
-
-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/v201204/user_service/get_users_by_statement.rb

@@ -1,79 +0,0 @@
-#!/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 = :v201204
-
-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/v201204/user_team_association_service/create_user_team_associations.rb

@@ -1,86 +0,0 @@
-#!/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 = :v201204
-
-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