google-adwords-api 0.16.1 → 0.17.0

data/examples/v201509/shopping_campaigns/add_product_scope.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2014, 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 restricts the products that will be included in the campaign by
+# setting a ProductScope.
+
+require 'adwords_api'
+
+def add_product_scope(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_criterion_srv = adwords.service(:CampaignCriterionService,
+      API_VERSION)
+
+  product_scope = {
+    # This set of dimensions is for demonstration purposes only. It is
+    # extremely unlikely that you want to include so many dimensions in your
+    # product scope.
+    :dimensions => [
+      {
+        :xsi_type => 'ProductBrand',
+        :value => 'Nexus'
+      },
+      {
+        :xsi_type => 'ProductCanonicalCondition',
+        :value => 'NEW'
+      },
+      {
+        :xsi_type => 'ProductCustomAttribute',
+        :type => 'CUSTOM_ATTRIBUTE_0',
+        :value => 'my attribute value'
+      },
+      {
+        :xsi_type => 'ProductOfferId',
+        :value => 'book1'
+      },
+      {
+        :xsi_type => 'ProductType',
+        :type => 'PRODUCT_TYPE_L1',
+        :value => 'Media'
+      },
+      {
+        :xsi_type => 'ProductType',
+        :type => 'PRODUCT_TYPE_L2',
+        :value => 'Books'
+      },
+      # The value for the bidding category is a fixed ID for the
+      # 'Luggage & Bags' category. You can retrieve IDs for categories from
+      # the ConstantDataService. See the 'get_product_category_taxonomy'
+      # example for more details.
+      {
+        :xsi_type => 'ProductBiddingCategory',
+        :type => 'BIDDING_CATEGORY_L1',
+        :value => '-5914235892932915235',
+      }
+    ]
+  }
+
+  campaign_criterion = {
+    :campaign_id => campaign_id,
+    :product_scope => product_scope
+  }
+
+  campaign_criterion_operation = {
+    :operator => 'ADD',
+    :operand => campaign_criterion
+  }
+
+  # Make the mutate request.
+  result = campaign_criterion_srv.mutate([campaign_criterion_operation])
+
+  campaign_criterion = result[:value].first
+  puts "Created a ProductScope criterion with ID %d." %
+      [campaign_criterion[:criterion][:id]]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201509
+
+  begin
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+    add_product_scope(campaign_id)
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
+
+  # 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/v201509/shopping_campaigns/add_shopping_campaign.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2014, 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 adds a Shopping campaign.
+
+require 'adwords_api'
+require 'date'
+
+def add_shopping_campaign(budget_id, merchant_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)
+  ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
+  ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
+
+  # Create campaign.
+  campaign = {
+    :name => "Shopping campaign #%d" % (Time.new.to_f * 1000).to_i,
+    # The advertising_channel_type is what makes this a Shopping campaign.
+    :advertising_channel_type => 'SHOPPING',
+    :budget => {:budget_id => budget_id},
+    :bidding_strategy_configuration => {
+      :bidding_strategy_type => 'MANUAL_CPC'
+    },
+    :settings => [
+      {
+        :xsi_type => 'ShoppingSetting',
+        :sales_country => 'US',
+        :campaign_priority => 0,
+        :merchant_id => merchant_id,
+        # Set to "true" to enable Local Inventory Ads in your campaign.
+        :enable_local => true
+      }
+    ]
+  }
+  campaign_operation = {:operator => 'ADD', :operand => campaign}
+
+  # Make the mutate request.
+  result = campaign_srv.mutate([campaign_operation])
+
+  # Print the result.
+  campaign = result[:value].first
+  puts "Campaign with name '%s' and ID %d was added." %
+      [campaign[:name], campaign[:id]]
+
+  # Create ad group.
+  ad_group = {
+    :campaign_id => campaign[:id],
+    :name => 'Ad Group #%d' % (Time.new.to_f * 1000).to_i
+  }
+  ad_group_operation = {:operator => 'ADD', :operand => ad_group}
+
+  # Make the mutate request.
+  result = ad_group_srv.mutate([ad_group_operation])
+
+  # Print the result.
+  ad_group = result[:value].first
+  puts "Ad group with name '%s' and ID %d was added." %
+      [ad_group[:name], ad_group[:id]]
+
+  # Create product ad.
+  ad_group_ad = {
+    :ad_group_id => ad_group[:id],
+    :ad => {:xsi_type => 'ProductAd'}
+  }
+  ad_group_operation = {:operator => 'ADD', :operand => ad_group_ad}
+
+  # Make the mutate request.
+  result = ad_group_ad_srv.mutate([ad_group_operation])
+
+  # Print the result.
+  ad_group_ad = result[:value].first
+  puts "Product ad with ID %d was added." % [ad_group_ad[:id]]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201509
+
+  begin
+    budget_id = 'INSERT_BUDGET_ID_HERE'.to_i
+    merchant_id = 'INSERT_MERCHANT_ID_HERE'.to_i
+
+    add_shopping_campaign(budget_id, merchant_id)
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
+
+  # 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/v201509/shopping_campaigns/get_product_category_taxonomy.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2014, 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 fetches the set of valid ProductBiddingCategories.
+
+require 'adwords_api'
+
+def display_categories(categories, prefix='')
+  categories.each do |category|
+    puts "%s%s [%s]" % [prefix, category[:name], category[:id]]
+    if category[:children]
+      display_categories(category[:children],
+          "%s%s > " % [prefix, category[:name]])
+    end
+  end
+end
+
+def get_product_category_taxonomy()
+  # 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')
+
+  constant_data_srv = adwords.service(:ConstantDataService, API_VERSION)
+
+  selector = {
+    :predicates => [
+        {:field => 'Country', :operator => 'IN', :values => ['US']}
+    ]
+  }
+
+  result = constant_data_srv.get_product_bidding_category_data(selector)
+
+  bidding_categories = {}
+  root_categories = []
+
+  result.each do |product_bidding_category|
+    id = product_bidding_category[:dimension_value][:value]
+    parent_id = nil
+    name = product_bidding_category[:display_value].values.first()
+
+    if product_bidding_category[:parent_dimension_value]
+      parent_id = product_bidding_category[:parent_dimension_value][:value]
+    end
+
+    bidding_categories[id] ||= {}
+
+    category = bidding_categories[id]
+
+    if parent_id
+      bidding_categories[parent_id] ||= {}
+
+      parent = bidding_categories[parent_id]
+
+      parent[:children] ||= []
+      parent[:children] << category
+    else
+      root_categories << category
+    end
+
+    category[:id] = id
+    category[:name] = name
+  end
+
+  display_categories(root_categories)
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201509
+
+  begin
+    get_product_category_taxonomy()
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
+
+  # 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/v201509/targeting/add_campaign_targeting_criteria.rb

@@ -0,0 +1,180 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 adds various types of targeting criteria to a campaign. To get
+# campaigns list, run get_campaigns.rb.
+
+require 'adwords_api'
+
+def add_campaign_targeting_criteria(campaign_id, location_feed_id = nil)
+  # 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_criterion_srv =
+      adwords.service(:CampaignCriterionService, API_VERSION)
+
+  # Create campaign criteria.
+  campaign_criteria = [
+    # Location criteria. The IDs can be found in the documentation or retrieved
+    # with the LocationCriterionService.
+    {:xsi_type => 'Location', :id => 21137}, # California, USA
+    {:xsi_type => 'Location', :id => 2484},  # Mexico
+    # Language criteria. The IDs can be found in the documentation or retrieved
+    # with the ConstantDataService.
+    {:xsi_type => 'Language', :id => 1000},  # English
+    {:xsi_type => 'Language', :id => 1003},  # Spanish
+    # Location Groups criteria. These represent targeting by household income
+    # or places of interest. The IDs can be found in the documentation or
+    # retrieved with the LocationCriterionService.
+    {
+      :xsi_type => 'LocationGroups',
+      :matching_function => {
+        :operator => 'AND',
+        :lhs_operand => [{
+          :xsi_type => 'IncomeOperand',
+          # Tiers are numbered 1-10, and represent 10% segments of earners.
+          # For example, TIER_1 is the top 10%, TIER_2 is the 80-90%, etc.
+          # Tiers 6 through 10 are grouped into TIER_6_TO_10.
+          :tier => 'TIER_3'
+        }],
+        :rhs_operand => [{
+          :xsi_type => 'GeoTargetOperand',
+          :locations => [1015116]  # Miami, FL
+        }]
+      }
+    },
+    {
+      :xsi_type => 'LocationGroups',
+      :matching_function => {
+        :operator => 'AND',
+        :lhs_operand => [{
+          :xsi_type => 'PlacesOfInterestOperand',
+          :category => 'DOWNTOWN' # Other valid options: AIRPORT, UNIVERSITY.
+        }],
+        :rhs_operand => [{
+          :xsi_type => 'GeoTargetOperand',
+          :locations => [1015116] # Miami, FL
+        }]
+      }
+    }
+  ]
+
+  # Distance targeting. Area of 10 miles around targets above.
+  unless location_feed_id.nil?
+    campaign_criteria << {
+      :xsi_type => 'LocationGroups',
+      :feed_id => location_feed_id,
+      :matching_function => {
+        :operator => 'IDENTITY',
+        :lhs_operand => [{
+          :xsi_type => 'LocationExtensionOperand',
+          :radius => {
+            :xsi_type => 'ConstantOperand',
+            :type => 'DOUBLE',
+            :unit => 'MILES',
+            :double_value => 10
+          }
+        }]
+      }
+    }
+  end
+
+  # Create operations.
+  operations = campaign_criteria.map do |criterion|
+    {:operator => 'ADD',
+     :operand => {
+         :campaign_id => campaign_id,
+         :criterion => criterion}
+    }
+  end
+
+  # Add negative campaign criterion.
+  operations << {
+    :operator => 'ADD',
+    :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 => 'NegativeCampaignCriterion',
+      :campaign_id => campaign_id,
+      :criterion => {
+        :xsi_type => 'Keyword',
+        :text => 'jupiter cruise',
+        :match_type => 'BROAD'
+      }
+    }
+  }
+
+  response = campaign_criterion_srv.mutate(operations)
+
+  if response and response[:value]
+    criteria = response[:value]
+    criteria.each do |campaign_criterion|
+      criterion = campaign_criterion[:criterion]
+      puts ("Campaign criterion with campaign ID %d, criterion ID %d and " +
+          "type '%s' was added.") % [campaign_criterion[:campaign_id],
+          criterion[:id], criterion[:criterion_type]]
+    end
+  else
+    puts 'No criteria were returned.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201509
+
+  begin
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
+    # Replace the value below with the ID a feed that has been configured for
+    # location targeting, meaning it has an ENABLED FeedMapping with
+    # criterionType of 77. Feeds linked to a GMB account automatically
+    # have this FeedMapping.
+    # If you don't have such a feed, set this value to nil or delete
+    # the variable.
+    location_feed_id = 'INSERT_LOCATION_FEED_ID_HERE'
+    add_campaign_targeting_criteria(campaign_id, location_feed_id)
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
+
+  # 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/v201509/targeting/add_demographic_targeting_criteria.rb

@@ -0,0 +1,112 @@
+#!/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 example adds demographic criteria to an ad group. To get ad groups list,
+# run get_ad_groups.rb.
+
+require 'adwords_api'
+
+def add_demographic_targeting_criteria(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_criterion_srv =
+      adwords.service(:AdGroupCriterionService, API_VERSION)
+
+  # Create ad group criteria.
+  ad_group_criteria = [
+    # Targeting criterion.
+    {
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :xsi_type => 'Gender',
+        # See system codes section for IDs:
+        # https://developers.google.com/adwords/api/docs/appendix/genders
+        :id => 11
+      }
+    },
+    # Exclusion criterion.
+    {
+      :xsi_type => 'NegativeAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :xsi_type => 'AgeRange',
+        # See system codes section for IDs:
+        # https://developers.google.com/adwords/api/docs/appendix/ages
+        :id => 503999
+      }
+    }
+  ]
+
+  # Create operations.
+  operations = ad_group_criteria.map do |criterion|
+    {:operator => 'ADD', :operand => criterion}
+  end
+
+  response = ad_group_criterion_srv.mutate(operations)
+
+  if response and response[:value]
+    criteria = response[:value]
+    criteria.each do |ad_group_criterion|
+      criterion = ad_group_criterion[:criterion]
+      puts ("Ad group criterion with ad group ID %d, criterion ID %d and " +
+          "type '%s' was added.") % [ad_group_criterion[:ad_group_id],
+          criterion[:id], criterion[:criterion_type]]
+    end
+  else
+    puts 'No criteria were returned.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201509
+
+  begin
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'
+    add_demographic_targeting_criteria(ad_group_id)
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
+
+  # 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