google-dfp-api 0.7.0 → 0.7.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTk4NTYxNTQwMjZkN2YyMDRiZmE1MjNjODQ2MzgxYTRiZDM1ODBmMQ==
+    NjAzNWNjM2ZiODk0ZDlkODBkNzExYjdjOGFlYjkzZjdlY2RkZjhkMw==
   data.tar.gz: !binary |-
-    YjE1Y2QxODM4MzYyOTFmNjMzYTgwMTQ3OGEwYWY5N2ZhODY2ZDM0YQ==
+    YWMxNGYyMzdlZjRkNTYyZGViOWQzMjhiODllMTAwYjBjZmYwZGNkZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YzUzNjYyYTQ4ZTVhMDU3MjJkZTk5NTY5OWRhMmZmYmY4NTY1NTcxMzhmNzJm
-    NzUzYzJjNjEyMWY4OTI3OTYxOTVhMWMzOWRjNGMyOWJjNDA3NjdmODU4Nzk0
-    YjFhY2EwZmM2MDdmZjMzYzFlOTgwNzM5Y2M0NjhiNzVjODhiMjc=
+    NWYwNzc5ODA0ZDc5MzhjMGVmYTAxMDY5ZjhhZGQ2YmVmYzQzNzc1OWFhMGNm
+    MWJkYzJiMzdkMzQ2ZjViYTQxMzQ3MGZmYTQ3Y2E0NDQxZDAzNjlkMTNlOGM4
+    ZDM2ODM0NDdlMGY0NzNhNjY4MTdjY2I0MGM0MDljZTQ1NDlhMzI=
   data.tar.gz: !binary |-
-    MTRhYmE2YmRmNWYzYTQwNWVhZjU1NmRmZGM4ZGFlZGU5MDBkZjBhZDdhMTgz
-    OTY5MDhjZWNlYTY2ODM3MjVhZDgxMTFjMDhjZTJiY2IzMTgyYWY1ZTk4Yjhl
-    MjkxYmUwNjhkZDdjNzJjZWZmMjAzMmVkYWM2NDUxNTk4M2QzZmU=
+    MWJiMjk0MjllZDYzODcxMWM4YjdjNWNjNDVjMDVmMGRlMjZkMDVkMjliNTY0
+    MmJlODI2ODJkNWVkYmRlZDQyNzc3NWE1ZDc3ZjdhMmUxNjMyZmNiYzQ5YjE3
+    OTU1NDMxYThhMmYyODQ1ZTkzYTIwMGUzZGIzMGY2MDBjZTFkNTk=

data/ChangeLog

@@ -1,3 +1,7 @@
+0.7.1:
+  - Added support and examples for v201311.
+  - Require google-ads-common 0.9.4 or later from now on.
+
 0.7.0:
   - Added support and examples for v201308.
   - Removed support for deprecated v201203, v201204, v201206.

data/README

@@ -116,7 +116,7 @@ Once the library object is created you can request services with a 'service'
 method:
   user_service = dfp.service(:UserService, <API_VERSION>)
 
-where <API_VERSION> is required version of DFP API as symbol, e.g. :v201308.
+where <API_VERSION> is required version of DFP API as symbol, e.g. :v201311.
 
 Then you should be able to execute service methods:
 
@@ -150,7 +150,7 @@ Examples can be run by executing by running:
 
 from the "examples/<version>/<service_name>" directory i.e.
 
-  $ cd examples/v201308/user_service
+  $ cd examples/v201311/user_service
   $ ruby get_all_users.rb
 
 Some examples require modification to be functional, like create_order example

data/examples/v201208/common/setup_oauth2.rb

@@ -0,0 +1,89 @@
+#!/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 shows how to use OAuth2.0 authorization method. It is designed to
+# be run from console and requires user input.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201208
+
+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

data/examples/v201211/common/setup_oauth2.rb

@@ -0,0 +1,89 @@
+#!/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 shows how to use OAuth2.0 authorization method. It is designed to
+# be run from console and requires user input.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201211
+
+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

data/examples/v201302/common/setup_oauth2.rb

@@ -0,0 +1,89 @@
+#!/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 shows how to use OAuth2.0 authorization method. It is designed to
+# be run from console and requires user input.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+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

data/examples/v201306/common/setup_oauth2.rb

@@ -0,0 +1,89 @@
+#!/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 shows how to use OAuth2.0 authorization method. It is designed to
+# be run from console and requires user input.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+
+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

data/examples/v201308/common/setup_oauth2.rb

@@ -0,0 +1,89 @@
+#!/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 shows how to use OAuth2.0 authorization method. It is designed to
+# be run from console and requires user input.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201308
+
+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