google-adx-buyer-api 0.4.3 → 0.4.4

data/examples/v201209/basic_operations/add_thirdparty_redirect_ad.rb

@@ -0,0 +1,126 @@
+#!/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 adds a third party redirect ad to an ad group. To create an
+# ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupAdService.mutate
+
+require 'adwords_api'
+
+def add_thirdparty_redirect_ad(ad_group_id)
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
+
+  # Create third party redirect ad.
+  # The 'xsi_type' field allows you to specify the xsi:type of the object
+  # being created. It's only necessary when you must provide an explicit
+  # type that the client library can't infer.
+  redirect_ad = {
+    :xsi_type => 'ThirdPartyRedirectAd',
+    :name => 'Example third party ad %d' % (Time.new.to_f * 1000).to_i,
+    :url => 'http://www.example.com',
+    :dimensions => {
+      :height => 250,
+      :width => 300
+    },
+    # This field normally contains the javascript ad tag.
+    :snippet =>
+        '<img src="https://sandbox.google.com/sandboximages/image.jpg"/>',
+    :certified_vendor_format_id => 119,
+    :is_cookie_targeted => false,
+    :is_user_interest_targeted => false,
+    :is_tagged => false
+  }
+
+  # Create in-stream third party redirect ad.
+  in_stream_ad = {
+    :xsi_type => 'ThirdPartyRedirectAd',
+    :name => 'Example in stream ad %d' % (Time.new.to_f * 1000).to_i,
+    :url => 'http://www.example.com',
+    # 15 secs.
+    :ad_duration => 15000,
+    :source_url => 'http://ad.doubleclick.net/pfadx/N270.126913.6102203221521' +
+        '/B3876671.21;dcadv=2215309;sz=0x0;ord=%5btimestamp%5d;dcmt=text/xml',
+    :certified_vendor_format_id => 303,
+    :rich_media_ad_type => 'IN_STREAM_VIDEO'
+  }
+
+  # Create operations to add the ads.
+  operations = [
+    {
+      :operator => 'ADD',
+      :operand => {
+        :ad_group_id => ad_group_id,
+        :ad => redirect_ad
+      }
+    },
+    {
+      :operator => 'ADD',
+      :operand => {
+        :ad_group_id => ad_group_id,
+        :ad => in_stream_ad
+      }
+    }
+  ]
+
+  # Add the ads.
+  response = ad_group_ad_srv.mutate(operations)
+
+  ads = response[:value]
+  puts "Added %d third party redirect ads to ad group ID %d:" %
+      [ads.length, ad_group_id]
+  ads.each do |ad|
+    puts "\tAd ID %d, type '%s' and status '%s'" %
+        [ad[:ad][:id], ad[:ad][:ad_type], ad[:status]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+
+  begin
+    # Ad group ID to add text ads to.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    add_thirdparty_redirect_ad(ad_group_id)
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::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/v201209/basic_operations/delete_ad.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, 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 deletes an ad using the 'REMOVE' operator. To get ads,
+# run get_thirdparty_redirect_ads.rb.
+#
+# Tags: AdGroupAdService.mutate
+
+require 'adwords_api'
+
+def delete_ad(ad_group_id, ad_id)
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
+
+  # Prepare for deleting ad.
+  operation = {
+    :operator => 'REMOVE',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :ad => {
+        :xsi_type => 'Ad',
+        :id => ad_id
+      }
+    }
+  }
+
+  # Delete ad.
+  response = ad_group_ad_srv.mutate([operation])
+  ad = response[:value].first
+  puts "Ad ID %d was successfully deleted." % ad[:ad][:id]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+
+  begin
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    ad_id = 'INSERT_AD_ID_HERE'.to_i
+    delete_ad(ad_group_id, ad_id)
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::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/{v201206/reporting/download_defined_report.rb → v201209/basic_operations/delete_ad_group.rb}

@@ -18,13 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets and downloads a report from a report definition.
+# This example deletes an ad group by setting the status to 'DELETED'.
+# To get ad groups, run get_ad_groups.rb.
 #
-# Note: defined reports are deprecated, please use AdHoc reporting.
+# Tags: AdGroupService.mutate
 
 require 'adwords_api'
 
-def download_defined_report(report_definition_id, file_name)
+def delete_ad_group(ad_group_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -33,21 +34,29 @@ def download_defined_report(report_definition_id, file_name)
   # the configuration file or provide your own logger:
   # adwords.logger = Logger.new('adwords_xml.log')
 
-  report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
+  ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
 
-  # Download report, using "download_report_as_file" extension method.
-  report_def_srv.download_report_as_file(report_definition_id, file_name)
-  puts 'Report with definition id %d was downloaded to \'%s\'.' %
-      [report_definition_id, file_name]
+  # Prepare for deleting ad group.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :status => 'DELETED',
+      :id => ad_group_id
+    }
+  }
+
+  # Delete ad group.
+  response = ad_group_srv.mutate([operation])
+  ad_group = response[:value].first
+  puts "Ad group ID %d was successfully deleted." % ad_group[:id]
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201209
 
   begin
-    report_definition_id = 'INSERT_REPORT_DEFINITION_ID'.to_i
-    file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
-    download_defined_report(report_definition_id, file_name)
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    delete_ad_group(ad_group_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201209/basic_operations/delete_campaign.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# Copyright:: Copyright 2011, 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 deletes a campaign by setting the status to 'DELETED'. To get
+# campaigns, run get_campaigns.rb.
+#
+# Tags: CampaignService.mutate
+
+require 'adwords_api'
+
+def delete_campaign(campaign_id)
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+
+  # Prepare for deleting campaign.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :id => campaign_id,
+      :status => 'DELETED',
+    }
+  }
+
+  # Delete campaign.
+  response = campaign_srv.mutate([operation])
+  campaign = response[:value].first
+  puts "Campaign with name '%s' and ID %d was deleted." %
+      [campaign[:name], campaign[:id]]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+
+  begin
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    delete_campaign(campaign_id)
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::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/v201209/basic_operations/delete_placement.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, 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 deletes a placement using the 'REMOVE' operator. To get list of
+# placements, run get_placements.rb.
+#
+# Tags: AdGroupCriterionService.mutate
+
+require 'adwords_api'
+
+def delete_placement(ad_group_id, criterion_id)
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  ad_group_criterion_srv =
+      adwords.service(:AdGroupCriterionService, API_VERSION)
+
+  # Prepare for deleting placement.
+  operation = {
+    :operator => 'REMOVE',
+    :operand => {
+      # The 'xsi_type' field allows you to specify the xsi:type of the object
+      # being created. It's only necessary when you must provide an explicit
+      # type that the client library can't infer.
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :id => criterion_id
+      }
+    }
+  }
+
+  # Delete placement.
+  response = ad_group_criterion_srv.mutate([operation])
+  ad_group_criterion = response[:value].first
+  puts "Placement ID %d was successfully deleted." %
+      ad_group_criterion[:criterion][:id]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+
+  begin
+    # IDs of criterion to delete and its ad group.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+    delete_placement(ad_group_id, criterion_id)
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::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/v201209/basic_operations/get_ad_groups.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# Copyright:: Copyright 2011, 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 illustrates how to retrieve all the ad groups for a campaign. To
+# create an ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupService.get
+
+require 'adwords_api'
+
+def get_all_ad_groups(campaign_id)
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
+
+  # Get all the ad groups for this campaign.
+  selector = {
+    :fields => ['Id', 'Name'],
+    :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
+    :predicates => [{
+      :field => 'CampaignId',
+      :operator => 'IN',
+      :values => [campaign_id]
+    }]
+  }
+  response = ad_group_srv.get(selector)
+  ad_groups = response[:entries]
+  puts "Campaign ID %d has %d ad group(s)." % [campaign_id, ad_groups.length]
+  ad_groups.each do |ad_group|
+    puts "\tAd group name is '%s' and ID is %d" %
+        [ad_group[:name], ad_group[:id]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+
+  begin
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    get_all_ad_groups(campaign_id)
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::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