google-dfp-api 0.17.0 → 0.19.0

data/examples/v201605/activity_service/get_all_activities.rb

@@ -1,81 +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 gets all activities. To create activities,
-# run create_activities.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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)
-
-  # Create a statement to select all activities.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get activities by statement.
-    page = activity_service.get_activities_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |activity, index|
-        puts "%d) Activity with ID: %d, name: %s, type: %s." %
-            [index + statement.offset, activity[:id], activity[:name],
-             activity[:type]]
-      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 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/v201605/activity_service/update_activities.rb

@@ -1,96 +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 activity expected URLs. To determine which activities
-# exist, run get_all_activities.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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'
-
-  # Create statement to select a single activity.
-  statement = DfpApi::FilterStatement.new(
-     'WHERE id = :id ORDER BY id ASC',
-     [
-         {:key => 'id',
-          :value => {:value => activity_id, :xsi_type => 'NumberValue'}}
-     ],
-     1
-  )
-
-  page = activity_service.get_activities_by_statement(statement.toStatement())
-
-  if page[:results]
-    # Get the activities.
-    activities = page[:results]
-
-    activites.each do |activity|
-      # Update the expected URL.
-      activity[:expected_url] = 'https://www.google.com'
-    end
-
-    # Update the activity on the server.
-    return_activities = activity_service.update_activities(activities)
-
-    # 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
-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/v201605/audience_segment_service/create_audience_segments.rb

@@ -1,114 +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 creates new rule based first party audience segments. To
-# determine which audience segments exist, run get_all_audience_segments.rb.
-
-require 'dfp_api'
-
-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.
-  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/v201605/audience_segment_service/get_all_audience_segments.rb

@@ -1,81 +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 code example gets all audience segments. To create audience segments, run
-# create_audience_segments.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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)
-
-  # Create a statement to select all audience segments.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get audience segments by statement.
-    page = audience_segment_service.get_audience_segments_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |segment, index|
-        puts "%d) Audience segment ID: %d, name: '%s' of size %d" %
-            [index + statement.offset,
-             segment[:id], segment[:name], segment[:size]]
-      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 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

data/examples/v201605/audience_segment_service/get_first_party_audience_segments.rb

@@ -1,88 +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 gets all first party audience segments. To create audience
-# segments, run create_audience_segments.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def get_first_party_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)
-
-  # Statement parts to help build a statement to select all first party audience
-  # segments.
-  statement = DfpApi::FilterStatement.new(
-      'type = :type ORDER BY id ASC',
-      [
-          {:key => 'type',
-           :value => {:value => 'FIRST_PARTY', :xsi_type => 'TextValue'}}
-      ]
-  )
-
-  begin
-    # Get audience segments by statement.
-    page = audience_segment_service.get_audience_segments_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |segment, index|
-        puts "%d) First party audience segment ID: %d, name: '%s', size %d" %
-            [index + statement.offset, segment[:id], segment[:name], segment[:size]]
-      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 first party audience segments: %d' %
-        page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_first_party_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/v201605/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 = :v201605
-
-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/v201605/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 = :v201605
-
-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