google-dfp-api 0.17.0 → 0.19.0

data/examples/v201605/suggested_ad_unit_service/get_suggested_ad_units_by_statement.rb

@@ -1,91 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 suggested ad units that have more than 50 requests.
-#
-# This feature is only available to DFP premium solution networks.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-NUMBER_OF_REQUESTS = 50
-
-def get_suggested_ad_units_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 SuggestedAdUnitService.
-  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
-
-  # Create a statement to only select suggested ad units with more than 50
-  # requests.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE numRequests > :num_requests ORDER BY id ASC',
-      [
-          {:key => 'num_requests',
-           :value => {:value => NUMBER_OF_REQUESTS,
-                      :xsi_type => 'NumberValue'}}
-      ]
-  )
-
-  begin
-    # Get ad units by statement.
-    page = suggested_ad_unit_service.get_suggested_ad_units_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      # Print details about each suggested ad unit in results.
-      page[:results].each_with_index do |ad_unit, index|
-        puts "%d) Suggested ad unit ID: '%s', number of requests: %d" %
-            [index + statement.offset, ad_unit[:id], ad_unit[:num_requests]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end statement.offset < page[:total_result_set_size]
-
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Total number of suggested ad units: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_suggested_ad_units_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/v201605/team_service/create_teams.rb

@@ -1,79 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 creates new teams with the logged in user added to each team. To
-# determine which teams exist, run get_all_teams.rb.
-
-require 'dfp_api'
-
-API_VERSION = :v201605
-ITEM_COUNT = 5
-
-def create_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')
-
-  # Get the TeamService.
-  team_service = dfp.service(:TeamService, API_VERSION)
-
-  # Create an array to store local team objects.
-  teams = (1..ITEM_COUNT).map do |index|
-    {
-      :name => "Team #%d" % index,
-      :has_all_companies => false,
-      :has_all_inventory => false
-    }
-  end
-
-  # Create the teams on the server.
-  return_teams = team_service.create_teams(teams)
-
-  if return_teams
-    return_teams.each do |team|
-      puts "Team with ID: %d and name: '%s' was created." %
-          [team[:id], team[:name]]
-    end
-  else
-    raise 'No teams were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_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/v201605/team_service/get_all_teams.rb

@@ -1,79 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 gets all teams. To create teams, run create_teams.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def get_all_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')
-
-  # Get the TeamService.
-  team_service = dfp.service(:TeamService, API_VERSION)
-
-  # Create statement for all teams.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get teams by statement.
-    page = team_service.get_teams_by_statement(statement.toStatement())
-
-    if page[:results]
-      # Print details about each team in results page.
-      page[:results].each_with_index do |team, index|
-        puts "%d) Team ID: %d, name: %s" %
-            [index + statement.offset, team[:id], team[:name]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # Print a footer
-  if page.include?(:total_result_set_size)
-    puts "Total number of teams: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_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/v201605/team_service/get_teams_by_statement.rb

@@ -1,78 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 gets all teams ordered by name.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def get_teams_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 TeamService.
-  team_service = dfp.service(:TeamService, API_VERSION)
-
-  # Create a statement to order teams by id.
-  statement = DfpApi::FilterStatement.new('ORDER BY name ASC')
-
-  begin
-    # Get teams by statement.
-    page = team_service.get_teams_by_statement(statement.toStatement())
-
-    if page and page[:results]
-      page[:results].each_with_index do |team, index|
-        puts "%d) Team ID: %d, name: %s." % [index + statement.offset,
-                                             team[:id], team[:name]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # 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_teams_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/v201605/team_service/update_teams.rb

@@ -1,94 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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 = DfpApi::FilterStatement.new('WHERE id > 0', [], 5)
-
-  # Get teams by statement.
-  page = team_service.get_teams_by_statement(statement.toStatement())
-
-  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/v201605/user_service/create_users.rb

@@ -1,85 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201605
-
-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})
-  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/v201605/user_service/deactivate_users.rb

@@ -1,94 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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 = DfpApi::FilterStatement.new(
-      'WHERE id = :user_id',
-      [
-          {:key => 'user_id',
-           :value => {:value => user_id, :xsi_type => 'NumberValue'}}
-      ]
-  )
-
-  # Get users by statement.
-  page = user_service.get_users_by_statement(statement.toStatement())
-
-  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.toStatement())
-
-    # 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/v201605/user_service/get_all_roles.rb

@@ -1,69 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201605
-
-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