google-dfp-api 0.2.8 → 0.3.0

data/examples/v201107/publisher_query_language_service/get_all_metros.rb

@@ -1,84 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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 metros available to target.
-#
-# Tags: PublisherQueryLanguageService.select
-
-require 'dfp_api'
-
-API_VERSION = :v201107
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_all_metros()
-  # 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 PublisherQueryLanguageService.
-  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
-
-  # Create statement to select all targetable metros.
-  statement = {:query => 'SELECT * FROM Metro WHERE targetable = true'}
-
-  # Get all metros.
-  result_set = pql_service.select(statement)
-
-  if result_set
-    # Print out columns header.
-    columns = result_set[:column_types].collect {|col| col[:label_name]}
-    puts columns.join(COLUMN_SEPARATOR)
-
-    # Print out every row.
-    result_set[:rows].each do |row_set|
-        row = row_set[:values].collect {|item| item[:value]}
-        puts row.join(COLUMN_SEPARATOR)
-    end
-  end
-
-  # Print a footer.
-  if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_metros()
-
-  # 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/v201107/publisher_query_language_service/get_all_operating_systems.rb

@@ -1,84 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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 operating systems.
-#
-# Tags: PublisherQueryLanguageService.select
-
-require 'dfp_api'
-
-API_VERSION = :v201107
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_all_operating_systems()
-  # 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 PublisherQueryLanguageService.
-  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
-
-  # Create statement to select all operating systems.
-  statement = {:query => 'SELECT * FROM Operating_System'}
-
-  # Get all operating systems.
-  result_set = pql_service.select(statement)
-
-  if result_set
-    # Print out columns header.
-    columns = result_set[:column_types].collect {|col| col[:label_name]}
-    puts columns.join(COLUMN_SEPARATOR)
-
-    # Print out every row.
-    result_set[:rows].each do |row_set|
-        row = row_set[:values].collect {|item| item[:value]}
-        puts row.join(COLUMN_SEPARATOR)
-    end
-  end
-
-  # Print a footer.
-  if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_operating_systems()
-
-  # 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/v201107/publisher_query_language_service/get_all_regions.rb

@@ -1,84 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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 regions available to target.
-#
-# Tags: PublisherQueryLanguageService.select
-
-require 'dfp_api'
-
-API_VERSION = :v201107
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_all_regions()
-  # 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 PublisherQueryLanguageService.
-  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
-
-  # Create statement to select all targetable regions.
-  statement = {:query => 'SELECT * FROM Region WHERE targetable = true'}
-
-  # Get all regions.
-  result_set = pql_service.select(statement)
-
-  if result_set
-    # Print out columns header.
-    columns = result_set[:column_types].collect {|col| col[:label_name]}
-    puts columns.join(COLUMN_SEPARATOR)
-
-    # Print out every row.
-    result_set[:rows].each do |row_set|
-        row = row_set[:values].collect {|item| item[:value]}
-        puts row.join(COLUMN_SEPARATOR)
-    end
-  end
-
-  # Print a footer.
-  if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_regions()
-
-  # 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/v201107/report_service/run_inventory_report.rb

@@ -1,89 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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 runs a report equal to the "Whole network report" on the DFP
-# website. To download the report see download_report.rb.
-#
-# Tags: ReportService.runReportJob, ReportService.getReportJob
-
-require 'dfp_api'
-
-API_VERSION = :v201107
-MAX_RETRIES = 10
-RETRY_INTERVAL = 30
-
-def run_inventory_report()
-  # 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 ReportService.
-  report_service = dfp.service(:ReportService, API_VERSION)
-
-  # Create report query.
-  report_query = {
-    :date_range_type => 'LAST_WEEK',
-    :dimensions => ['DATE'],
-    :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS',
-        'ADSENSE_IMPRESSIONS', 'ADSENSE_CLICKS', 'TOTAL_IMPRESSIONS',
-        'TOTAL_REVENUE']
-  }
-
-  # Create report job.
-  report_job = {:report_query => report_query}
-
-  # Run report job.
-  report_job = report_service.run_report_job(report_job);
-
-  MAX_RETRIES.times do |retry_count|
-    # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
-
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
-    puts "Report with ID: %d is still running." % report_job[:id]
-    sleep(RETRY_INTERVAL)
-  end
-
-  puts "Report job with ID: %d finished with status %s." %
-      [report_job[:id], report_job[:report_job_status]]
-end
-
-if __FILE__ == $0
-  begin
-    run_inventory_report()
-
-  # 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/v201107/user_service/create_users.rb

@@ -1,88 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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 = :v201107
-
-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/v201107/user_service/deactivate_users.rb

@@ -1,98 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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 = :v201107
-PAGE_SIZE = 500
-
-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