google-dfp-api 0.18.0 → 0.19.0

data/examples/v201602/audience_segment_service/populate_first_party_audience_segments.rb

@@ -1,99 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2013, 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 code example populates specific rule based first party audience segment.
-# To determine which audience segments exist, run get_audience_segments.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def populate_first_party_audience_segments(audience_segment_id)
-  # 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 AudienceSegmentService.
-  audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
-
-  # Statement parts to help build a statement to select first party audience
-  # segment for an ID.
-  statement = DfpApi::FilterStatement.new(
-     'WHERE type = :type AND id = :audience_segment_id ORDER BY id ASC',
-     [
-       {:key => 'type',
-        :value => {:value => 'FIRST_PARTY', :xsi_type => 'TextValue'}},
-       {:key => 'audience_segment_id',
-        :value => {:value => audience_segment_id, :xsi_type => 'TextValue'}},
-     ],
-     1
-  )
-
-  # Get audience segments by statement.
-  page = audience_segment_service.get_audience_segments_by_statement(
-      statement.toStatement())
-
-  if page[:results]
-    page[:results].each do |segment|
-      puts "First party audience segment ID: %d, name: '%s' will be populated" %
-          [segment[:id], segment[:name]]
-
-      # Perform action.
-      result = audience_segment_service.perform_audience_segment_action(
-          {:xsi_type => 'PopulateAudienceSegments'},
-          {:query => statement.toStatement()})
-
-      # Display results.
-      if result and result[:num_changes] > 0
-        puts 'Number of audience segments populated: %d.' % result[:num_changes]
-      else
-        puts 'No audience segments were populated.'
-      end
-    end
-  else
-    puts 'No first party audience segments found to populate.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    # Audience segment ID to populate.
-    audience_segment_id = 'INSERT_AUDIENCE_SEGMENT_ID_HERE'
-
-    populate_first_party_audience_segments(audience_segment_id)
-
-  # 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/v201602/audience_segment_service/update_audience_segments.rb

@@ -1,94 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2013, 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 rule based first party audience segments. To determine
-# which first party audience segments exist, run
-# get_all_first_party_audience_segments.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def update_audience_segments()
-  # 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 first party audience segment to update.
-  audience_segment_id = 'INSERT_AUDIENCE_SEGMENT_ID_HERE'
-
-  # Get the AudienceSegmentService.
-  audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
-
-  # Create statement text to select the audience segment to update.
-  statement = DfpApi::FilterStatement.new(
-     'WHERE id = :segment_id ORDER BY id ASC',
-     [
-         {:key => 'segment_id',
-          :value => {:value => audience_segment_id, :xsi_type => 'NumberValue'}}
-     ],
-     1
-  )
-
-  # Get audience segments by statement.
-  page = audience_segment_service.get_audience_segments_by_statement(
-      statement.toStatement())
-
-  if page[:results]
-    audience_segments = page[:results]
-
-    # Create a local set of audience segments than need to be updated.
-    audience_segments.each do |audience_segment|
-      audience_segment[:membership_expiration_days] = 180
-    end
-
-    # Update the audience segments on the server.
-    return_audience_segments =
-        audience_segment_service.update_audience_segments(audience_segments)
-    return_audience_segments.each do |audience_segment|
-      puts 'Audience segment ID: %d was updated' % audience_segment[:id]
-    end
-  else
-    puts 'No audience segments found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_audience_segments()
-
-  # 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/v201602/common/error_handling.rb

@@ -1,72 +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 runs incorrect query and demonstrates how to handle errors.
-
-require 'dfp_api'
-
-API_VERSION = :v201602
-
-def produce_api_error()
-  # 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)
-
-  # Omitting "id" field here to produce an error.
-  user = {:preferred_locale => 'en_UK', :name => 'foo_bar'}
-
-  # Execute request and get the response, this should raise an exception.
-  user = user_service.update_user(user)
-
-  # Output retrieved data.
-  puts "User ID: %d, name: %s, email: %s" %
-      [user[:id], user[:name], user[:email]]
-end
-
-if __FILE__ == $0
-  begin
-    # This function should produce an exception for demo.
-    produce_api_error()
-
-  # One of two kinds of exception might occur, general HTTP error like 403 or
-  # 404 and DFP API error defined in WSDL and described in documentation.
-
-  # Handling HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # Handling API errors.
-  rescue DfpApi::Errors::ApiException => e
-    # Standard DFP API error includes message and array of errors occured.
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    # Print out each of the 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/v201602/common/oauth2_jwt_handling.rb

@@ -1,99 +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 illustrates how to use OAuth2 authentication method with
-# Service Account (JWT). For this example to work, your Service Account must be
-# a Google Apps for Business Account.
-#
-# See https://developers.google.com/doubleclick-publishers/docs/service_accounts
-# for more information.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def oauth2_jwt_handling()
-  # 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')
-
-  # Option 1: provide key filename as authentication -> oauth2_keyfile in the
-  #           configuration file. No additional code is necessary.
-  # To provide a file name at runtime, use authorize:
-  # dfp.authorize({:oauth2_keyfile => key_filename})
-
-  # Option 2: retrieve key manually and create OpenSSL::PKCS12 object.
-  # key_filename = 'INSERT_FILENAME_HERE'
-  # key_secret = 'INSERT_SECRET_HERE'
-  # key_file_data = File.read(key_filename)
-  # key = OpenSSL::PKCS12.new(key_file_data, key_secret).key
-  # dfp.authorize({:oauth2_key => key})
-
-  # Now you can make API calls.
-
-  # 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')
-  # Define initial values.
-
-  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
-    oauth2_jwt_handling()
-
-  # 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/v201602/common/setup_oauth2.rb

@@ -1,85 +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 shows how to use OAuth2 authorization method. It is designed to
-# be run from console and requires user input.
-
-require 'dfp_api'
-
-API_VERSION = :v201602
-
-def setup_oauth2()
-  # DfpApi::Api will read a config file from ENV['HOME']/dfp_api.yml
-  # when called without parameters.
-  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')
-
-  # You can call authorize explicitly to obtain the access token. Otherwise, it
-  # will be invoked automatically on the first API call.
-  # There are two ways to provide verification code, first one is via the block:
-  token = dfp.authorize() do |auth_url|
-    puts "Hit Auth error, please navigate to URL:\n\t%s" % auth_url
-    print 'log in and type the verification code: '
-    verification_code = gets.chomp
-    verification_code
-  end
-  if token
-    print "\nWould you like to update your dfp_api.yml to save " +
-        "OAuth2 credentials? (y/N): "
-    response = gets.chomp
-    if ('y'.casecmp(response) == 0) or ('yes'.casecmp(response) == 0)
-      dfp.save_oauth2_token(token)
-      puts 'OAuth2 token is now saved to ~/dfp_api.yml and will be ' +
-          'automatically used by the library.'
-    end
-  end
-
-  # Alternatively, you can provide one within the parameters:
-  # token = dfp.authorize({:oauth2_verification_code => verification_code})
-
-  # Note, 'token' is a Hash. Its value is not used in this example. If you need
-  # to be able to access the API in offline mode, with no user present, you
-  # should persist it to be used in subsequent invocations like this:
-  # dfp.authorize({:oauth2_token => token})
-
-  # No exception thrown - we are good to make a request.
-end
-
-if __FILE__ == $0
-  begin
-    setup_oauth2()
-
-  # 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