google-adwords-api 0.12.1 → 0.13.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Mzc2ZTFhNzVmNzc4ZjMzNTk3YzMwYjRjN2MyZjA2ZmM5NjYwZGFhYQ==
+    ODRhZTMxOWI0ZjZlYTZmMDRhZDA1M2I4YjgxNDJiMTU4YTdlMGNkMw==
   data.tar.gz: !binary |-
-    M2Q1ZjlhZDNmYTUzNGUzNjAwODczYjhjNjA4MmUwMTgyMDYzYzA0Yg==
+    ZThlNzE5ZTUzNWFlMDcyZmU0NTczMjdjOTAyYjdiZDc1ODg4MWMyZg==
 SHA512:
   metadata.gz: !binary |-
-    OWI2MTQxNWY1YjkyNWYzZWI1NTRkYjhhYzFiNGEzYjIyNWNkOTY3OGU0MTE3
-    ODRhZTQ3MzRiOGRlYzBjZGQxNzRkZjBkYWU2NDg2MmIxMTcxMzIyZWQyZjI3
-    ZDk5MGY1NDk0ZmNjMTZjOWRjMmMwZjk3Y2UyY2UwZjFhNTliNWY=
+    MTNiZjMxOTEwNjA3MmRkNGYzZjFiMGI1ZmRhODE5NmZlNTBlOGRlNzg3ZWZh
+    YTg4MDVhNTlhNWI4Yjg5YjUxZGI2NzRlMDA0ZjJlZTVhZTNkOGU3NzFhMTcx
+    MmZkZWUxZDhhMjQzYTZmZGNkZTVjOTkwOTNjYmY1ZjlhNTQwZjQ=
   data.tar.gz: !binary |-
-    NDI3OTdjZTkxYjJkMjEwNGE4MTY4NDIxOWNjNGE2NGMyYTk5YmEwM2JlZDZl
-    NDQ4NTFiMjk0ODMyY2IxMDk2MGY2NDVmMWM4ZDY5N2JjZThkY2VmMjFhMmZi
-    MjU0YTMwNWU2Yjg4ZDE0Y2RkZmM3MDNlMWI2NzIyYTk5MThjZmI=
+    YzI0ZmYxODE3ZmRhNzhlODQ5MmM0OGNhNjM4YjViYzI1Y2U0NDcxNjRhNzU0
+    OWJmZWNhZTc4Nzg4NTg1MWJiMmExZWRmZmVmMThkMmIzNjljYjhlNzA5NDc1
+    YTliYjMzZjU5YmIwNzE3MDlhMmM5YzY0OTc5YTEzMGE3YzVjNjc=

data/ChangeLog

@@ -1,3 +1,6 @@
+0.13.0:
+  - Removed deprecated API version v201309.
+
 0.12.1:
   - Support and examples for v201406.
   - Changed default OAuth scope. See:

data/examples/v201402/basic_operations/delete_ad_group.rb

@@ -36,31 +36,11 @@ def delete_ad_group(ad_group_id)
 
   ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
 
-  # Retrieve the ad group to obtain its name. This is optional but recommended
-  # to keep deleted objects searchable. In production the name is already known
-  # in most cases.
-  selector = {
-    :fields => ['Id', 'Name'],
-    :predicates => [
-      {:field => 'Id', :operator => 'EQUALS', :values => [ad_group_id]}
-    ]
-  }
-  result = ad_group_srv.get(selector)
-
-  if result.nil? or result[:entries].empty?
-    raise StandardError, "Ad group with ID %d was not found." % ad_group_id
-  end
-
-  # We recommend renaming object on delete to avoid name conflicts later.
-  ad_group_name = result[:entries].first[:name]
-  ad_group_name += Time.now.strftime(" (deleted on %Y-%m-%d %H:%M:%S)")
-
   # Prepare for deleting ad group.
   operation = {
     :operator => 'SET',
     :operand => {
       :id => ad_group_id,
-      :name => ad_group_name,
       :status => 'DELETED'
     }
   }
@@ -69,8 +49,7 @@ def delete_ad_group(ad_group_id)
   response = ad_group_srv.mutate([operation])
   if response and response[:value]
     ad_group = response[:value].first
-    puts "Ad group ID %d was successfully deleted and renamed to '%s'." %
-       [ad_group[:id], ad_group[:name]]
+    puts "Ad group ID %d was successfully deleted." % [ad_group[:id]]
   else
     puts 'No ad group was updated.'
   end

data/examples/{v201309/basic_operations/delete_ad_group.rb → v201402/basic_operations/delete_ad_group.rb~}

@@ -51,16 +51,11 @@ def delete_ad_group(ad_group_id)
     raise StandardError, "Ad group with ID %d was not found." % ad_group_id
   end
 
-  # We recommend renaming object on delete to avoid name conflicts later.
-  ad_group_name = result[:entries].first[:name]
-  ad_group_name += Time.now.strftime(" (deleted on %Y-%m-%d %H:%M:%S)")
-
   # Prepare for deleting ad group.
   operation = {
     :operator => 'SET',
     :operand => {
       :id => ad_group_id,
-      :name => ad_group_name,
       :status => 'DELETED'
     }
   }
@@ -69,15 +64,14 @@ def delete_ad_group(ad_group_id)
   response = ad_group_srv.mutate([operation])
   if response and response[:value]
     ad_group = response[:value].first
-    puts "Ad group ID %d was successfully deleted and renamed to '%s'." %
-       [ad_group[:id], ad_group[:name]]
+    puts "Ad group ID %d was successfully deleted." % [ad_group[:id]]
   else
     puts 'No ad group was updated.'
   end
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201309
+  API_VERSION = :v201402
 
   begin
     # ID of an ad group to delete.

data/examples/v201402/basic_operations/delete_campaign.rb

@@ -36,32 +36,12 @@ def delete_campaign(campaign_id)
 
   campaign_srv = adwords.service(:CampaignService, API_VERSION)
 
-  # Retrieve the campaign to obtain its name. This is optional but recommended
-  # to keep deleted objects searchable. In production the name is already known
-  # in most cases.
-  selector = {
-    :fields => ['Id', 'Name'],
-    :predicates => [
-      {:field => 'Id', :operator => 'EQUALS', :values => [campaign_id]}
-    ]
-  }
-  result = campaign_srv.get(selector)
-
-  if result.nil? or result[:entries].empty?
-    raise StandardError, "Campaign with ID %d was not found." % campaign_id
-  end
-
-  # We recommend renaming object on delete to avoid name conflicts later.
-  campaign_name = result[:entries].first[:name]
-  campaign_name += Time.now.strftime(" (deleted on %Y-%m-%d %H:%M:%S)")
-
   # Prepare for deleting campaign.
   operation = {
     :operator => 'SET',
     :operand => {
       :id => campaign_id,
-      :name => campaign_name,
-      :status => 'DELETED',
+      :status => 'DELETED'
     }
   }
 
@@ -70,8 +50,7 @@ def delete_campaign(campaign_id)
 
   if response and response[:value]
     campaign = response[:value].first
-    puts "Campaign ID %d was renamed to '%s' and deleted." %
-        [campaign[:id], campaign[:name]]
+    puts "Campaign ID %d was deleted." % [campaign[:id]]
   else
     puts 'No campaign was updated.'
   end

data/examples/{v201309/basic_operations/update_campaign.rb → v201402/basic_operations/delete_campaign.rb~}

@@ -18,14 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to update a campaign, setting its status to
-# 'PAUSED'. To create a campaign, run add_campaigns.rb.
+# 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 update_campaign(campaign_id)
+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
@@ -36,33 +36,34 @@ def update_campaign(campaign_id)
 
   campaign_srv = adwords.service(:CampaignService, API_VERSION)
 
-  # Prepare for updating campaign.
+  # Prepare for deleting campaign.
   operation = {
     :operator => 'SET',
     :operand => {
       :id => campaign_id,
-      :status => 'PAUSED'
+      :status => 'DELETED'
     }
   }
 
-  # Update campaign.
+  # Delete campaign.
   response = campaign_srv.mutate([operation])
+
   if response and response[:value]
     campaign = response[:value].first
-    puts "Campaign ID %d was successfully updated, status was set to '%s'." %
-        [campaign[:id], campaign[:status]]
+    puts "Campaign ID %d was renamed to '%s' and deleted." %
+        [campaign[:id], campaign[:name]]
   else
-    puts 'No campaigns were updated.'
+    puts 'No campaign was updated.'
   end
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201309
+  API_VERSION = :v201402
 
   begin
-    # ID of a campaign to update.
+    # ID of a campaign to delete.
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-    update_campaign(campaign_id)
+    delete_campaign(campaign_id)
 
   # Authorization error.
   rescue AdsCommon::Errors::OAuth2VerificationRequired => e

data/examples/v201406/basic_operations/remove_ad_group.rb

@@ -36,31 +36,11 @@ def remove_ad_group(ad_group_id)
 
   ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
 
-  # Retrieve the ad group to obtain its name. This is optional but recommended
-  # to keep remove objects searchable. In production the name is already known
-  # in most cases.
-  selector = {
-    :fields => ['Id', 'Name'],
-    :predicates => [
-      {:field => 'Id', :operator => 'EQUALS', :values => [ad_group_id]}
-    ]
-  }
-  result = ad_group_srv.get(selector)
-
-  if result.nil? or result[:entries].empty?
-    raise StandardError, "Ad group with ID %d was not found." % ad_group_id
-  end
-
-  # We recommend renaming object on remove to avoid name conflicts later.
-  ad_group_name = result[:entries].first[:name]
-  ad_group_name += Time.now.strftime(" (removed on %Y-%m-%d %H:%M:%S)")
-
   # Prepare for deleting ad group.
   operation = {
     :operator => 'SET',
     :operand => {
       :id => ad_group_id,
-      :name => ad_group_name,
       :status => 'REMOVED'
     }
   }
@@ -69,8 +49,7 @@ def remove_ad_group(ad_group_id)
   response = ad_group_srv.mutate([operation])
   if response and response[:value]
     ad_group = response[:value].first
-    puts "Ad group ID %d was successfully removed and renamed to '%s'." %
-       [ad_group[:id], ad_group[:name]]
+    puts "Ad group ID %d was successfully removed." % [ad_group[:id]]
   else
     puts 'No ad group was updated.'
   end

data/examples/{v201309/basic_operations/update_ad_group.rb → v201406/basic_operations/remove_ad_group.rb~}

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -18,14 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to update an ad group, setting its status to
-# 'PAUSED'. To create an ad group, run add_ad_group.rb.
+# This example removes an ad group by setting the status to 'REMOVED'. To get ad
+# groups, run get_ad_groups.rb.
 #
 # Tags: AdGroupService.mutate
 
 require 'adwords_api'
 
-def update_ad_group(ad_group_id)
+def remove_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
@@ -36,32 +36,33 @@ def update_ad_group(ad_group_id)
 
   ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
 
-  # Prepare for updating ad group.
+  # Prepare for deleting ad group.
   operation = {
     :operator => 'SET',
     :operand => {
-      :status => 'PAUSED',
-      :id => ad_group_id
+      :id => ad_group_id,
+      :status => 'REMOVED'
     }
   }
 
-  # Update ad group.
+  # Remove ad group.
   response = ad_group_srv.mutate([operation])
   if response and response[:value]
     ad_group = response[:value].first
-    puts 'Ad group id %d was successfully updated.' % ad_group[:id]
+    puts "Ad group ID %d was successfully removed." %
+       [ad_group[:id]]
   else
-    puts 'No ad groups were updated.'
+    puts 'No ad group was updated.'
   end
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201309
+  API_VERSION = :v201406
 
   begin
-    # ID of an ad group to update.
+    # ID of an ad group to remove.
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    update_ad_group(ad_group_id)
+    remove_ad_group(ad_group_id)
 
   # Authorization error.
   rescue AdsCommon::Errors::OAuth2VerificationRequired => e

data/examples/v201406/basic_operations/remove_campaign.rb

@@ -36,32 +36,12 @@ def remove_campaign(campaign_id)
 
   campaign_srv = adwords.service(:CampaignService, API_VERSION)
 
-  # Retrieve the campaign to obtain its name. This is optional but recommended
-  # to keep removed objects searchable. In production the name is already known
-  # in most cases.
-  selector = {
-    :fields => ['Id', 'Name'],
-    :predicates => [
-      {:field => 'Id', :operator => 'EQUALS', :values => [campaign_id]}
-    ]
-  }
-  result = campaign_srv.get(selector)
-
-  if result.nil? or result[:entries].empty?
-    raise StandardError, "Campaign with ID %d was not found." % campaign_id
-  end
-
-  # We recommend renaming object on remove to avoid name conflicts later.
-  campaign_name = result[:entries].first[:name]
-  campaign_name += Time.now.strftime(" (removed on %Y-%m-%d %H:%M:%S)")
-
-  # Prepare for deleting campaign.
+   # Prepare for deleting campaign.
   operation = {
     :operator => 'SET',
     :operand => {
       :id => campaign_id,
-      :name => campaign_name,
-      :status => 'REMOVED',
+     :status => 'REMOVED'
     }
   }
 
@@ -70,8 +50,8 @@ def remove_campaign(campaign_id)
 
   if response and response[:value]
     campaign = response[:value].first
-    puts "Campaign ID %d was renamed to '%s' and removed." %
-        [campaign[:id], campaign[:name]]
+    puts "Campaign ID %d was removed." %
+        [campaign[:id]]
   else
     puts 'No campaign was updated.'
   end

data/examples/{v201309/basic_operations/delete_campaign.rb → v201406/basic_operations/remove_campaign.rb~}

@@ -18,14 +18,14 @@
 #           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
+# This example removes a campaign by setting the status to 'REMOVED'. To get
 # campaigns, run get_campaigns.rb.
 #
 # Tags: CampaignService.mutate
 
 require 'adwords_api'
 
-def delete_campaign(campaign_id)
+def remove_campaign(campaign_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -37,7 +37,7 @@ def delete_campaign(campaign_id)
   campaign_srv = adwords.service(:CampaignService, API_VERSION)
 
   # Retrieve the campaign to obtain its name. This is optional but recommended
-  # to keep deleted objects searchable. In production the name is already known
+  # to keep removed objects searchable. In production the name is already known
   # in most cases.
   selector = {
     :fields => ['Id', 'Name'],
@@ -51,9 +51,9 @@ def delete_campaign(campaign_id)
     raise StandardError, "Campaign with ID %d was not found." % campaign_id
   end
 
-  # We recommend renaming object on delete to avoid name conflicts later.
+  # We recommend renaming object on remove to avoid name conflicts later.
   campaign_name = result[:entries].first[:name]
-  campaign_name += Time.now.strftime(" (deleted on %Y-%m-%d %H:%M:%S)")
+  campaign_name += Time.now.strftime(" (removed on %Y-%m-%d %H:%M:%S)")
 
   # Prepare for deleting campaign.
   operation = {
@@ -61,16 +61,16 @@ def delete_campaign(campaign_id)
     :operand => {
       :id => campaign_id,
       :name => campaign_name,
-      :status => 'DELETED',
+      :status => 'REMOVED',
     }
   }
 
-  # Delete campaign.
+  # Remove campaign.
   response = campaign_srv.mutate([operation])
 
   if response and response[:value]
     campaign = response[:value].first
-    puts "Campaign ID %d was renamed to '%s' and deleted." %
+    puts "Campaign ID %d was renamed to '%s' and removed." %
         [campaign[:id], campaign[:name]]
   else
     puts 'No campaign was updated.'
@@ -78,12 +78,12 @@ def delete_campaign(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201309
+  API_VERSION = :v201406
 
   begin
-    # ID of a campaign to delete.
+    # ID of a campaign to remove.
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-    delete_campaign(campaign_id)
+    remove_campaign(campaign_id)
 
   # Authorization error.
   rescue AdsCommon::Errors::OAuth2VerificationRequired => e