google-dfp-api 0.17.0 → 0.19.0

data/examples/v201605/user_service/get_all_users.rb

@@ -1,79 +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 users for an account. To create users run
-# create_users.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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)
-
-  # Create a statement to select all users.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get users by statement.
-    page = user_service.get_users_by_statement(statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |user, index|
-        puts "%d) User ID: %d, name: %s, email: %s" %
-            [index + statement.offset, user[:id], user[:name], user[:email]]
-      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 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/v201605/user_service/get_current_user.rb

@@ -1,62 +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 the current user.
-
-require 'dfp_api'
-
-API_VERSION = :v201605
-
-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/v201605/user_service/get_users_by_statement.rb

@@ -1,80 +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 users sorted by name. To create new users, run
-# create_users.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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 id.
-  statement = DfpApi::FilterStatement.new('ORDER BY name ASC')
-
-  begin
-    # Get users by statement.
-    page = user_service.get_users_by_statement(statement.toStatement())
-
-    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 + statement.offset, user[:id], user[:name], user[:email],
-            user[:role_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_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/v201605/user_service/update_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 updates all users by adding "Sr." to the end of a single user.
-# To determine which users exist, run get_all_users.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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)
-
-  user_id = 'INSERT_USER_ID_HERE'.to_i
-
-  # Create a statement to get all users.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE id = :id ORDER BY id ASC',
-      [
-         {:key => 'id',
-          :value => {:value => user_id, :xsi_type => 'NumberValue'}}
-      ],
-      1
-  )
-
-  # Get users by statement.
-  page = user_service.get_users_by_statement(statement.toStatement())
-
-  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/v201605/user_team_association_service/create_user_team_associations.rb

@@ -1,82 +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 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201605
-
-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/v201605/user_team_association_service/delete_user_team_associations.rb

@@ -1,98 +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 removes the user from all its teams. To determine which users
-# exist, run get_all_users.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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 = DfpApi::FilterStatement.new(
-      'WHERE userId = :user_id',
-      [
-          {:key => 'user_id',
-           :value => {:value => user_id, :xsi_type => 'NumberValue'}}
-      ]
-  )
-
-  begin
-    # Get user team associations by statement.
-    page = uta_service.get_user_team_associations_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      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
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # Reset offset back to 0 to perform action.
-  statement.toStatementForAction()
-
-  # Perform the action.
-  result = uta_service.perform_user_team_association_action(
-      {:xsi_type => 'DeleteUserTeamAssociations'}, statement.toStatement())
-
-  # 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

data/examples/v201605/user_team_association_service/get_all_user_team_associations.rb

@@ -1,83 +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 user team associations. To create user team
-# associations, run create_user_team_assocations.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def get_all_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)
-
-  # Create statement for all user team associations.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get the user team associations by statement.
-    page = uta_service.get_user_team_associations_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      # Print details about each user team association in results page.
-      page[:results].each_with_index do |association, index|
-        puts "%d) User team association between team ID: %d and user ID %d" %
-            [index + statement.offset,
-             association[:team_id], association[:user_id]]
-      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 user team associations: %d" %
-        page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_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/v201605/user_team_association_service/get_user_team_associations_by_statement.rb

@@ -1,93 +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 that the current user belongs to.
-# To create teams, run create_user_team_associations.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def get_user_team_associations_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 UserTeamAssociationService.
-  uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
-
-  # Get the UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
-
-  # Get the current user.
-  user = user_service.get_current_user()
-
-  # Create filter text to select user team associations by the user ID.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE userId = :user_id ORDER BY id',
-      [
-          {:key => 'user_id',
-           :value => {:value => user[:id], :xsi_type => 'NumberValue'}},
-      ]
-  )
-
-  begin
-    # Get user team associations by statement.
-    page = uta_service.get_user_team_associations_by_statement(
-        statement.toStatement())
-
-    if page and page[:results]
-      page[:results].each_with_index do |association, index|
-        puts "%d) Team user association between team ID %d and user ID %d." %
-            [index + statement.offset, association[:team_id],
-             association[:user_id]]
-      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_user_team_associations_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