google-dfp-api 0.7.0 → 0.7.1

data/examples/v201311/activity_service/get_active_activities.rb

@@ -0,0 +1,103 @@
+#!/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 activities. To create activities,
+# run create_activities.rb.
+#
+# Tags: ActivityService.getActivitiesByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+PAGE_SIZE = 500
+
+def get_active_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)
+
+  # 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 activities by statement.
+    page = activity_service.get_activities_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, index|
+        puts "%d) Activity with ID: %d, name: %s, type: %s." %
+            [index + start_index, activity[:id], activity[:name],
+                activity[:type]]
+      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_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

data/examples/v201311/activity_service/get_all_activities.rb

@@ -0,0 +1,96 @@
+#!/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 activities. To create activities,
+# run create_activities.rb.
+#
+# Tags: ActivityService.getActivitiesByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+PAGE_SIZE = 500
+
+def get_all_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)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Update statement for one page with current offset.
+    statement = {
+        :query => 'ORDER BY id LIMIT %d OFFSET %d' % [PAGE_SIZE, offset]
+    }
+
+    # Get activities by statement.
+    page = activity_service.get_activities_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, index|
+        puts "%d) Activity with ID: %d, name: %s, type: %s." %
+            [index + start_index, activity[:id], activity[:name],
+             activity[:type]]
+      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_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

data/examples/v201311/activity_service/update_activities.rb

@@ -0,0 +1,85 @@
+#!/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 expected URLs. To determine which activities
+# exist, run get_all_activities.rb.
+#
+# Tags: ActivityService.getActivity
+# Tags: ActivityService.updateActivities
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def update_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 to update.
+  activity_id = 'INSERT_ACTIVITY_ID_HERE'
+
+  # Get the activity.
+  activity = activity_service.get_activity(activity_id)
+
+  # Update the expected URL.
+  activity[:expected_url] = 'https://www.google.com'
+
+  # Update the activity on the server.
+  return_activities = activity_service.update_activities([activity])
+
+  # Display results.
+  if return_activities
+    return_activities.each do |updated_activity|
+      puts "Activity with ID: %d and name: %s was updated." %
+          [updated_activity[:id], updated_activity[:name]]
+    end
+  else
+    raise 'No activities were updated.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    update_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

data/examples/v201311/audience_segment_service/create_audience_segments.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 rule based first party audience segments. To
+# determine which audience segments exist, run get_all_audience_segments.rb.
+#
+# Tags: AudienceSegmentService.createAudienceSegments
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def create_audience_segments(custom_targeting_key_id, custom_targeting_value_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)
+
+  # Get the NetworkService.
+  network_service = dfp.service(:NetworkService, API_VERSION)
+
+  # Get the root ad unit ID used to target the whole site.
+  effective_root_ad_unit_id =
+        network_service.get_current_network()[:effective_root_ad_unit_id]
+
+  # Create custom criteria.
+  custom_criteria = {
+    :xsi_type => 'CustomCriteria',
+    :operator => 'IS',
+    :key_id => custom_targeting_key_id,
+    :value_ids => [custom_targeting_value_id]
+  }
+
+  # Create the audience segment rule.
+  rule = {
+    :xsi_type => 'FirstPartyAudienceSegmentRule',
+    # Inventory targeting.
+    :inventory_rule => {
+      :targeted_ad_units => [{:ad_unit_id => effective_root_ad_unit_id}]
+    },
+    # Create the custom criteria set that will resemble:
+    #   custom_criteria.key == custom_criteria.value
+    :custom_criteria_rule => {
+      :logical_operator => 'AND',
+      :children => [custom_criteria]
+    }
+  }
+
+  # Create an audience segment.
+  segment = {
+    :xsi_type => 'RuleBasedFirstPartyAudienceSegment',
+    :name => 'Audience segment #%d' % Time.new.to_i,
+    :description => 'Sports enthusiasts between the ages of 20 and 30',
+    :page_views => 6,
+    :recency_days => 6,
+    :membership_expiration_days => 88,
+    :rule => rule
+  }
+
+  # Create the audience segment on the server.
+  return_segments = audience_segment_service.create_audience_segments([segment])
+
+  if return_segments
+    return_segments.each do |segment|
+      puts ("An audience segment with ID: %d, name: '%s' and type: '%s' was " +
+          "created.") % [segment[:id], segment[:name], segment[:type]]
+    end
+  else
+    raise 'No audience segments were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    # Set the IDs of the custom criteria to target.
+    custom_targeting_key_id = 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'
+    custom_targeting_value_id = 'INSERT_CUSTOM_TARGETING_VALUE_ID_HERE'
+
+    create_audience_segments(custom_targeting_key_id, custom_targeting_value_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/v201311/audience_segment_service/get_all_audience_segments.rb

@@ -0,0 +1,94 @@
+#!/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 code example gets all audience segments. To create audience segments, run
+# create_audience_segments.rb.
+#
+# Tags: AudienceSegmentService.getAudienceSegmentsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+PAGE_SIZE = 500
+
+def get_all_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')
+
+  # Get the AudienceSegmentService.
+  audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+
+    # Get audience segments by statement.
+    page =
+        audience_segment_service.get_audience_segments_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 audience segment in results page.
+      page[:results].each_with_index do |segment, index|
+        puts "%d) Audience segment ID: %d, name: '%s' of size %d" %
+            [index + start_index, segment[:id], segment[:name], segment[:size]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of audience segments: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_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