google-dfp-api 0.6.1 → 0.6.2

data/ChangeLog

@@ -1,3 +1,6 @@
+0.6.2:
+  - Added support and examples for v201302.
+
 0.6.1:
   - Require google-ads-common 0.9.1 or later from now on.
   - Bug fixes from ads-common.

data/examples/v201302/activity_group_service/create_activity_groups.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# 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 creates new activity groups. To determine which activity groups
+# exist, run get_all_activity_groups.rb.
+#
+# Tags: ActivityGroupService.createActivityGroups
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+def create_activity_groups()
+  # 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 ActivityGroupService.
+  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
+
+  # Set the ID of the advertiser company this activity group is associated
+  # with.
+  advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE';
+
+  # Create a short-term activity group.
+  short_term_activity_group = {
+    :name => 'Short-term activity group',
+    :company_ids => [advertiser_company_id],
+    :clicks_lookback => 1,
+    :impressions_lookback => 1
+  }
+
+  # Create a long-term activity group.
+  long_term_activity_group = {
+    :name => 'Long-term activity group',
+    :company_ids => [advertiser_company_id],
+    :clicks_lookback => 30,
+    :impressions_lookback => 30
+  }
+
+  # Create the activity groups on the server.
+  return_activity_groups = activity_group_service.create_activity_groups([
+      short_term_activity_group, long_term_activity_group])
+
+  if return_activity_groups
+    return_activity_groups.each do |activity_group|
+      puts "An activity group with ID: %d and name: %s was created." %
+          [activity_group[:id], activity_group[:name]]
+    end
+  else
+    raise 'No activity groups were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_activity_groups()
+
+  # 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/activity_group_service/get_active_activity_groups.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# 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 gets all active activity groups. To create activity groups,
+# run create_activity_groups.rb.
+#
+# Tags: ActivityGroupService.getActivityGroupsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+PAGE_SIZE = 500
+
+def get_active_activity_groups()
+  # 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 ActivityGroupService.
+  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {
+       :query => 'WHERE status = :status ORDER BY id LIMIT %d OFFSET %d' %
+           [PAGE_SIZE, offset],
+       :values => [
+           {:key => 'status',
+            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+       ]
+    }
+
+    # Get activity groups by statement.
+    page = activity_group_service.get_activity_groups_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      # Get the start index for printout.
+      start_index = page[:start_index]
+
+      # Print details about each content object in results page.
+      page[:results].each_with_index do |activity_group, index|
+        puts "%d) Activity group with ID: %d, name: %s." % [index + start_index,
+            activity_group[:id], activity_group[:name]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of results: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_active_activity_groups()
+
+  # 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/activity_group_service/get_all_activity_groups.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# 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 gets all activity groups. To create activity groups,
+# run create_activity_groups.rb.
+#
+# Tags: ActivityGroupService.getActivityGroupsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+PAGE_SIZE = 500
+
+def get_all_activity_groups()
+  # 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 ActivityGroupService.
+  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {
+       :query => 'ORDER BY id LIMIT %d OFFSET %d' % [PAGE_SIZE, offset],
+    }
+
+    # Get activity groups by statement.
+    page = activity_group_service.get_activity_groups_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      # Get the start index for printout.
+      start_index = page[:start_index]
+
+      # Print details about each content object in results page.
+      page[:results].each_with_index do |activity_group, index|
+        puts "%d) Activity group with ID: %d, name: %s." % [index + start_index,
+            activity_group[:id], activity_group[:name]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of results: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_activity_groups()
+
+  # 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/activity_group_service/update_activity_groups.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# 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 activity groups by adding a company. To determine which
+# activity groups exist, run get_all_activity_groups.rb.
+#
+# Tags: ActivityGroupService.getActivityGroup
+# Tags: ActivityGroupService.updateActivityGroups
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+def update_activity_groups()
+  # 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 ActivityGroupService.
+  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
+
+  # Set the ID of the activity group and the company to update it with.
+  activity_group_id = 'INSERT_ACTIVITY_GROUP_ID_HERE'
+  advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'
+
+  # Get the activity group.
+  activity_group = activity_group_service.get_activity_group(activity_group_id)
+
+  # Update the companies.
+  activity_group[:company_ids] << advertiser_company_id
+
+  # Update the activity groups on the server.
+  return_activity_groups = activity_group_service.update_activity_groups([
+      activity_group])
+
+  # Display results.
+  if return_activity_groups
+    return_activity_groups.each do |updates_activity_group|
+      puts "Activity group with ID: %d and name: %s was updated." %
+          [updates_activity_group[:id], updates_activity_group[:name]]
+    end
+  else
+    raise 'No activity groups were updated.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    update_activity_groups()
+
+  # 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/activity_service/create_activities.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# 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 creates new activities. To determine which activities exist, run
+# get_all_activities.php.
+#
+# Tags: ActivityService.createActivities
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+def create_activities()
+  # 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 ActivityService.
+  activity_service = dfp.service(:ActivityService, API_VERSION)
+
+  # Set the ID of the activity group this activity is associated with.
+  activity_group_id = 'INSERT_ACTIVITY_GROUP_ID_HERE';
+
+  # Create a daily visits activity.
+  daily_visits_activity = {
+    :name => 'Activity',
+    :activity_group_id => activity_group_id,
+    :type => 'DAILY_VISITS'
+  }
+
+  # Create a custom activity.
+  custom_activity = {
+    :name => 'Activity',
+    :activity_group_id => activity_group_id,
+    :type => 'CUSTOM'
+  }
+
+  # Create the activities on the server.
+  return_activities = activity_service.create_activities([
+      daily_visits_activity, custom_activity])
+
+  if return_activities
+    return_activities.each do |activity|
+      puts "An activity with ID: %d, name: %s and type: %s was created." %
+          [activity[:id], activity[:name], activity[:type]]
+    end
+  else
+    raise 'No activities were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_activities()
+
+  # 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