Support for Ad Manager v201902.

Author: donovanfm

ad_manager_api/ChangeLog

@@ -1,3 +1,8 @@
+1.6.0:
+  - Added support for v201902.
+  - Removed support for v201802.
+  - Removed examples for v201805.
+
 1.5.0:
   - Added support for v201811.
   - Removed support for v201711.

ad_manager_api/examples/v201902/activity_group_service/create_activity_groups.rb

@@ -0,0 +1,90 @@
+#!/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 activity groups. To determine which activity groups
+# exist, run get_all_activity_groups.rb.
+
+require 'ad_manager_api'
+
+def create_activity_groups(ad_manager, advertiser_company_id)
+  # Get the ActivityGroupService.
+  activity_group_service = ad_manager.service(
+      :ActivityGroupService, API_VERSION
+  )
+
+  # 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.to_a.size > 0
+    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
+  API_VERSION = :v201902
+
+  # Get AdManagerApi instance and load configuration from ~/ad_manager_api.yml.
+  ad_manager = AdManagerApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # ad_manager.logger = Logger.new('ad_manager_xml.log')
+
+  begin
+    advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'
+    create_activity_groups(ad_manager, advertiser_company_id)
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdManagerApi::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

ad_manager_api/examples/v201902/activity_group_service/get_active_activity_groups.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2016, 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.
+
+require 'ad_manager_api'
+
+def get_active_activity_groups(ad_manager)
+  activity_group_service = ad_manager.service(
+      :ActivityGroupService, API_VERSION
+  )
+
+  # Create a statement to select activity groups.
+  statement = ad_manager.new_statement_builder do |sb|
+    sb.where = 'status = :status'
+    sb.with_bind_variable('status', 'ACTIVE')
+  end
+
+  # Retrieve a small amount of activity groups at a time, paging
+  # through until all activity groups have been retrieved.
+  page = {:total_result_set_size => 0}
+  begin
+    # Get activity groups by statement.
+    page = activity_group_service.get_activity_groups_by_statement(
+        statement.to_statement()
+    )
+
+    # Print out some information for each activity group.
+    unless page[:results].nil?
+      page[:results].each_with_index do |activity_group, index|
+        puts '%d) Activity group with ID %d and name "%s" was found.' % [
+            index + statement.offset,
+            activity_group[:id],
+            activity_group[:name]
+        ]
+      end
+    end
+
+    # Increase the statement offset by the page size to get the next page.
+    statement.offset += statement.limit
+  end while statement.offset < page[:total_result_set_size]
+
+  puts 'Total number of activity groups: %d' % page[:total_result_set_size]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201902
+
+  # Get AdManagerApi instance and load configuration from ~/ad_manager_api.yml.
+  ad_manager = AdManagerApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # ad_manager.logger = Logger.new('ad_manager_xml.log')
+
+  begin
+    get_active_activity_groups(ad_manager)
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdManagerApi::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

ad_manager_api/examples/v201902/activity_group_service/get_all_activity_groups.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2016, 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.
+require 'ad_manager_api'
+
+def get_all_activity_groups(ad_manager)
+  activity_group_service = ad_manager.service(
+      :ActivityGroupService, API_VERSION
+  )
+
+  # Create a statement to select activity groups.
+  statement = ad_manager.new_statement_builder()
+
+  # Retrieve a small amount of activity groups at a time, paging
+  # through until all activity groups have been retrieved.
+  page = {:total_result_set_size => 0}
+  begin
+    page = activity_group_service.get_activity_groups_by_statement(
+        statement.to_statement()
+    )
+
+    # Print out some information for each activity group.
+    unless page[:results].nil?
+      page[:results].each_with_index do |activity_group, index|
+        puts '%d) Activity group with ID %d and name "%s" was found.' % [
+            index + statement.offset,
+            activity_group[:id],
+            activity_group[:name]
+        ]
+      end
+    end
+
+    # Increase the statement offset by the page size to get the next page.
+    statement.offset += statement.limit
+  end while statement.offset < page[:total_result_set_size]
+
+  puts 'Total number of activity groups: %d' % page[:total_result_set_size]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201902
+
+  # Get AdManagerApi instance and load configuration from ~/ad_manager_api.yml.
+  ad_manager = AdManagerApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # ad_manager.logger = Logger.new('ad_manager_xml.log')
+
+  begin
+    get_all_activity_groups(ad_manager)
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdManagerApi::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

ad_manager_api/examples/v201902/activity_group_service/update_activity_groups.rb

@@ -0,0 +1,90 @@
+#!/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 groups by adding a company. To determine which
+# activity groups exist, run get_all_activity_groups.rb.
+
+require 'ad_manager_api'
+
+def update_activity_groups(ad_manager, advertiser_company_id, activity_group_id)
+  # Get the ActivityGroupService.
+  activity_group_service = ad_manager.service(
+      :ActivityGroupService, API_VERSION
+  )
+
+  # Create statement to select a single activity group.
+  statement = ad_manager.new_statement_builder do |sb|
+    sb.where = 'id = :id'
+    sb.with_bind_variable('id', activity_group_id)
+  end
+
+  page = activity_group_service.get_activity_groups_by_statement(
+      statement.to_statement()
+  )
+
+  unless page[:results].nil?
+    # Get the activity groups.
+    activity_groups = page[:results]
+
+    activity_groups.each do |activity_group|
+      # Update the companies.
+      activity_group[:company_ids] << advertiser_company_id
+    end
+
+    # Update the activity groups on the server.
+    return_activity_groups = activity_group_service.update_activity_groups(
+        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
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201902
+
+  # Get AdManagerApi instance and load configuration from ~/ad_manager_api.yml.
+  ad_manager = AdManagerApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # ad_manager.logger = Logger.new('ad_manager_xml.log')
+
+  begin
+    advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'
+    activity_group_id = 'INSERT_ACTIVITY_GROUP_ID_HERE'
+    update_activity_groups(ad_manager, advertiser_company_id, activity_group_id)
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdManagerApi::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