google-dfp-api 0.6.3 → 0.7.0

data/examples/v201206/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 = :v201206
-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/v201206/user_service/get_all_roles.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 all roles. This example can be used to determine which role
-# ID is needed when getting and creating users.
-#
-# Tags: UserService.getAllRoles
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-
-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

data/examples/v201206/user_team_association_service/delete_user_team_associations.rb

@@ -1,111 +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 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 = :v201206
-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

data/examples/v201206/user_team_association_service/get_user_team_associations_by_statement.rb

@@ -1,94 +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 gets all teams that the current user belongs to. The statement
-# retrieves up to the maximum page size limit of 500. To create teams, run
-# create_user_team_associations.rb.
-#
-# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
-# Tags: UserService.getCurrentUser
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-PAGE_SIZE = 500
-
-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 = {
-      :query => "WHERE userId = :user_id LIMIT %s" % PAGE_SIZE,
-      :values => [
-          {:key => 'user_id',
-           :value => {:value => user[:id], :xsi_type => 'NumberValue'}},
-      ]
-  }
-
-  # Get user team associations by statement.
-  page = uta_service.get_user_team_associations_by_statement(statement)
-
-  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, association[:team_id], association[:user_id]]
-    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_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

data/examples/v201206/user_team_association_service/update_user_team_associations.rb

@@ -1,102 +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 updates user team associations. It updates a user team
-# association by setting the overridden access type to read only for the first
-# 500 teams that the user belongs to. To determine which users exists, run
-# get_all_users.rb.
-#
-# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
-# Tags: UserTeamAssociationService.updateUserTeamAssociations
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-PAGE_SIZE = 500
-
-def update_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 set to read only access within its teams.
-  user_id = 'INSERT_USER_ID_HERE'.to_i
-
-  # Create filter text to select user team associations by the user ID.
-  statement = {
-      :query => "WHERE userId = :user_id LIMIT %s" % PAGE_SIZE,
-      :values => [
-          {:key => 'user_id',
-           :value => {:value => user_id, :xsi_type => 'NumberValue'}},
-      ]
-  }
-
-  # Get user team associations by statement.
-  page = uta_service.get_user_team_associations_by_statement(statement)
-
-  if page[:results] and !page[:results].empty?
-    associations = page[:results]
-    associations.each do |association|
-      # Update local user team association to read-only access.
-      association[:overridden_team_access_type] = 'READ_ONLY'
-    end
-
-    # Update the user team association on the server.
-    return_associations =
-        uta_service.update_user_team_associations(associations)
-
-    # Display results.
-    return_associations.each do |association|
-      puts ("User team association between user ID %d and team ID %d was " +
-          "updated with access type '%s'") %
-          [association[:user_id], association[:team_id],
-           association[:overridden_team_access_type]]
-    end
-  else
-    puts 'No user team associations were updated.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_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