google-dfp-api 0.13.1 → 0.15.0

data/ChangeLog

@@ -1,3 +1,14 @@
+0.15.0:
+  - Added support for v201605.
+  - Removed support for v201502.
+  - Removed examples for v201505.
+  - Require google-ads-common 0.12.1 or later from now on.
+  - Added JSON keyfile support or OAuth2 service accounts.
+
+0.14.0:
+  - Require google-ads-common 0.12.0 or later from now on. This also means
+    that Ruby 2.0 or later is required. Ruby 2.1 or later is recommended.
+
 0.13.1:
   - Require google-ads-common 0.11.3 or later from now on.
 
@@ -108,7 +119,7 @@
 
 0.3.2:
   - Require google-ads-common 0.7.3 or later from now on.
-  - Support for OAuth2.0 authentication method.
+  - Support for OAuth2 authentication method.
   - Updated User-Agent to a single standard.
 
 0.3.1:

data/README.md

@@ -103,7 +103,7 @@ or add it to the bash configuration file:
     $ echo 'export RUBYOPT="rubygems"' >> ~/.bashrc
 
 
-## Using OAuth2.0
+## Using OAuth2
 
 In order to use OAuth you just need to:
 

data/examples/v201508/common/oauth2_jwt_handling.rb

@@ -16,7 +16,7 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to use OAuth2.0 authentication method with
+# 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.
 #

data/examples/v201508/common/setup_oauth2.rb

@@ -16,7 +16,7 @@
 #           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
+# This example shows how to use OAuth2 authorization method. It is designed to
 # be run from console and requires user input.
 
 require 'dfp_api'

data/examples/v201511/common/oauth2_jwt_handling.rb

@@ -16,7 +16,7 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to use OAuth2.0 authentication method with
+# 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.
 #

data/examples/v201511/common/setup_oauth2.rb

@@ -16,7 +16,7 @@
 #           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
+# This example shows how to use OAuth2 authorization method. It is designed to
 # be run from console and requires user input.
 
 require 'dfp_api'

data/examples/v201602/common/oauth2_jwt_handling.rb

@@ -16,7 +16,7 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to use OAuth2.0 authentication method with
+# 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.
 #

data/examples/v201602/common/setup_oauth2.rb

@@ -16,7 +16,7 @@
 #           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
+# This example shows how to use OAuth2 authorization method. It is designed to
 # be run from console and requires user input.
 
 require 'dfp_api'

data/examples/{v201505 → v201605}/activity_group_service/create_activity_groups.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/activity_group_service/get_active_activity_groups.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_active_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/activity_group_service/get_all_activity_groups.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/activity_group_service/update_activity_groups.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def update_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/activity_service/create_activities.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/activity_service/get_active_activities.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_active_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/activity_service/get_all_activities.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/activity_service/update_activities.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def update_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/audience_segment_service/create_audience_segments.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_audience_segments(custom_targeting_key_id, custom_targeting_value_id)
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/audience_segment_service/get_all_audience_segments.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/audience_segment_service/get_first_party_audience_segments.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_first_party_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/audience_segment_service/populate_first_party_audience_segments.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def populate_first_party_audience_segments(audience_segment_id)
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/audience_segment_service/update_audience_segments.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def update_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/common/error_handling.rb

@@ -20,7 +20,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def produce_api_error()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/common/oauth2_jwt_handling.rb

@@ -26,7 +26,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def oauth2_jwt_handling()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/common/setup_oauth2.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def setup_oauth2()
   # DfpApi::Api will read a config file from ENV['HOME']/dfp_api.yml

data/examples/{v201505 → v201605}/company_service/create_companies.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 # Number of companies to create.
 ITEM_COUNT = 5
 
@@ -38,7 +38,8 @@ def create_companies()
 
   # Create an array to store local company objects.
   companies = (1..ITEM_COUNT).map do |index|
-    {:name => "Advertiser #%d" % index, :type => 'ADVERTISER'}
+    {:name => "Advertiser #%d-%d" % [Time.new.to_f * 1000, index],
+     :type => 'ADVERTISER'}
   end
 
   # Create the companies on the server.

data/examples/{v201505 → v201605}/company_service/get_all_companies.rb

@@ -21,7 +21,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/company_service/get_companies_by_statement.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_companies_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/company_service/update_companies.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def update_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/contact_service/create_contacts.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/contact_service/get_all_contacts.rb

@@ -21,7 +21,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/contact_service/get_uninvited_contacts.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 PAGE_SIZE = 500
 
 def get_uninvited_contacts()

data/examples/{v201505 → v201605}/contact_service/update_contacts.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def update_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/content_metadata_key_hierarchy_service/create_content_metadata_key_hierarchies.rb

@@ -22,7 +22,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/content_metadata_key_hierarchy_service/delete_content_metadata_key_hierarchies.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def delete_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/content_metadata_key_hierarchy_service/get_all_content_metadata_key_hierarchies.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/content_metadata_key_hierarchy_service/update_content_metadata_key_hierarchies.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def update_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/content_service/get_all_content.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_content()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/content_service/get_content_by_category.rb

@@ -24,7 +24,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_content_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_service/copy_image_creatives.rb

@@ -24,7 +24,7 @@ require 'dfp_api'
 
 require 'base64'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def copy_image_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_service/create_creative_from_template.rb

@@ -24,7 +24,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_creative_from_template()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_service/create_creatives.rb

@@ -23,7 +23,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 # Number of creatives to create.
 ITEM_COUNT = 5
 

data/examples/{v201505 → v201605}/creative_service/create_custom_creative.rb

@@ -25,7 +25,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_custom_creative()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -54,11 +54,14 @@ def create_custom_creative()
       :name => 'Custom creative',
       :advertiser_id => advertiser_id,
       :destination_url => 'http://www.google.com',
-      :custom_creative_assets => [
-          {:macro_name => 'IMAGE_ASSET',
-           :file_name => "image%d.jpg" % Time.new.to_i,
-           :asset_byte_array => image_data_base64}
-      ],
+      :custom_creative_assets => [{
+           :macro_name => 'IMAGE_ASSET',
+           :asset => {
+               :file_name => "image%d.jpg" % Time.new.to_i,
+               :asset_byte_array => image_data_base64
+           }
+      }],
+
       # Set the HTML snippet using the custom creative asset macro.
       :html_snippet => "<a href='%%CLICK_URL_UNESC%%%%DEST_URL%%'>" +
         "<img src='%%FILE:IMAGE_ASSET%%'/></a><br>Click above for great deals!",