google-adwords-api 0.19.1 → 0.20.0

data/examples/v201509/advanced_operations/add_html5_ad.rb

@@ -1,137 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2015, 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 an HTML5 ad to a given ad group.
-# To get ad groups, run basic_operations/get_ad_groups.rb.
-
-require 'adwords_api'
-require 'base64'
-
-def add_html5_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)
-
-  # The HTML5 zip file contains all the HTML, CSS, and images needed for the
-  # HTML5 ad. For help on creating an HTML5 zip file, check out Google Web
-  # Designer (https://www.google.com/webdesigner).
-  html5_url = 'http://goo.gl/9Y7qI2'
-  html5_data = AdsCommon::Http.get(html5_url, adwords.config)
-  base64_html5_data = Base64.encode64(html5_data)
-
-  # Create a media bundle containing the zip file with all the HTML5
-  # components.
-  media_bundle = {
-    :xsi_type => 'MediaBundle',
-    :data => base64_html5_data,
-    :entry_point => 'carousel/index.html',
-    :type => 'MEDIA_BUNDLE'
-  }
-
-  # Create the template elements for the ad. You can refer to
-  # https://developers.google.com/adwords/api/docs/appendix/templateads
-  # for the list of available template fields.
-  ad_data = {
-    :unique_name => 'adData',
-    :fields => [
-      {
-        :name => 'Custom_layout',
-        :field_media => media_bundle,
-        :type => 'MEDIA_BUNDLE'
-      },
-      {
-        :name => 'layout',
-        :field_text => 'Custom',
-        :type => 'ENUM'
-      }
-    ]
-  }
-
-  html5_ad = {
-    :xsi_type => 'TemplateAd',
-    :name => 'Ad for HTML5',
-    :template_id => 419,
-    :final_urls => ['http://example.com/html5'],
-    :display_url => 'www.example.com/html5',
-    :dimensions => {
-      :width => 300,
-      :height => 250
-    },
-    :template_elements => [ad_data]
-  }
-
-  ad_group_ad = {
-    :ad_group_id => ad_group_id,
-    :ad => html5_ad,
-    :status => 'PAUSED'
-  }
-
-  operation = {
-    :operator => 'ADD',
-    :operand => ad_group_ad
-  }
-
-  response = ad_group_ad_srv.mutate([operation])
-  if response and !response.empty?
-    response[:value].each do |ad_group_ad|
-      puts "New HTML5 ad with ID %d and display url '%s' was added." %
-          [ad_group_ad[:ad][:id], ad_group_ad[:ad][:display_url]]
-    end
-  else
-    puts "No HTML5 ads were added."
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201509
-
-  begin
-    # Ad group ID to add text ads to.
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    add_html5_ad(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

data/examples/v201509/advanced_operations/add_text_ad_with_upgraded_urls.rb

@@ -1,134 +0,0 @@
-#!/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 code example adds a text ad that uses advanced features of upgraded
-# URLs.
-
-require 'adwords_api'
-
-def add_text_ad_with_upgraded_urls(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)
-
-  # Since your tracking URL will have two custom parameters, provide their
-  # values too. This can be provided at campaign, ad group, ad, criterion, or
-  # feed item levels.
-  season_parameter = {
-    :key => 'season',
-    :value => 'christmas'
-  }
-
-  promo_code_parameter = {
-    :key => 'promocode',
-    :value => 'NYC123'
-  }
-
-  tracking_url_parameters = {
-    :parameters => [season_parameter, promo_code_parameter]
-  }
-
-  text_ad = {
-    :xsi_type => 'TextAd',
-    :headline => 'Luxury Cruise to Mars',
-    :description1 => 'Visit the Red Planet in style.',
-    :description2 => 'Low-gravity fun for everyone!',
-    :display_url => 'www.example.com',
-    # Specify a tracking URL for 3rd party tracking provider. You may specify
-    # one at customer, campaign, ad group, ad, criterion, or feed item levels.
-    :tracking_url_template => 'http://tracker.example.com/' +
-        '?season={_season}&promocode={_promocode}&u={lpurl}',
-    :url_custom_parameters => tracking_url_parameters,
-    # Specify a list of final URLs. This field cannot be set if :url field
-    # is set. This may be specified at ad, criterion, and feed item levels.
-    :final_urls => [
-      'http://www.example.com/cruise/space/',
-      'http://www.example.com/locations/mars/'
-    ],
-    # Specify a list of final mobile URLs. This field cannot be set if :url
-    # field is set. This may be specificed at ad, criterion, and
-    # feed item levels.
-    :final_mobile_urls => [
-      'http://mobile.example.com/cruise/space/',
-      'http://mobile.example.com/locations/mars/'
-    ]
-  }
-
-  operation = {
-    :operator => 'ADD',
-    :operand => {:ad_group_id => ad_group_id, :ad => text_ad}
-  }
-
-  # Add ads.
-  response = ad_group_ad_srv.mutate([operation])
-  if response and response[:value]
-    response[:value].each do |ad|
-      text_ad = ad[:ad]
-      puts "Ad with ID %d and displayUrl '%s' was added." %
-          [text_ad[:id], text_ad[:display_url]]
-      puts "\tFinal URLs: %s" % [text_ad[:final_urls].join(', ')]
-      puts "\tFinal Mobile URLs: %s" % [text_ad[:final_mobile_urls].join(', ')]
-      puts "\tTracking URL template: %s" % [text_ad[:tracking_url_template]]
-      custom_parameters =
-          text_ad[:url_custom_parameters][:parameters].map do |custom_parameter|
-            "%s=%s" % [custom_parameter[:key], custom_parameter[:value]]
-          end
-      puts "\tCustom parameters: %s" % [custom_parameters.join(', ')]
-    end
-  else
-    raise StandardError, 'No ads were added.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201509
-
-  begin
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    add_text_ad_with_upgraded_urls(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

data/examples/v201509/advanced_operations/create_and_attach_shared_keyword_set.rb

@@ -1,141 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2015, 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 a shared list of negative broad match keywords, it then
-# attaches them to a campaign.
-
-require 'adwords_api'
-require 'date'
-
-def create_and_attach_shared_keyword_set(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')
-
-  shared_set_srv = adwords.service(:SharedSetService, API_VERSION)
-  shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
-  campaign_shared_set_srv =
-      adwords.service(:CampaignSharedSetService, API_VERSION)
-
-  # Keywords to create a shared set of.
-  keywords = ['mars cruise', 'mars hotels']
-
-  # Create shared negative keyword set.
-  shared_set = {
-    :name => 'API Negative keyword list - %d' % (Time.new.to_f * 1000).to_i,
-    :type => 'NEGATIVE_KEYWORDS'
-  }
-
-  # Add shared set.
-  response = shared_set_srv.mutate([
-      {:operator => 'ADD', :operand => shared_set}
-  ])
-
-  if response and response[:value]
-    shared_set = response[:value].first
-    shared_set_id = shared_set[:shared_set_id]
-    puts "Shared set with ID %d and name '%s' was successfully added." %
-        [shared_set_id, shared_set[:name]]
-  else
-    raise StandardError, 'No shared set was added'
-  end
-
-  # Add negative keywords to shared set.
-  shared_criteria = keywords.map do |keyword|
-    {
-      :criterion => {
-        :xsi_type => 'Keyword',
-        :text => keyword,
-        :match_type => 'BROAD'
-      },
-      :negative => true,
-      :shared_set_id => shared_set_id
-    }
-  end
-
-  operations = shared_criteria.map do |criterion|
-    {:operator => 'ADD', :operand => criterion}
-  end
-
-  response = shared_criterion_srv.mutate(operations)
-  if response and response[:value]
-    response[:value].each do |shared_criterion|
-      puts "Added shared criterion ID %d '%s' to shared set with ID %d." %
-          [shared_criterion[:criterion][:id],
-           shared_criterion[:criterion][:text],
-           shared_criterion[:shared_set_id]]
-    end
-  else
-    raise StandardError, 'No shared keyword was added'
-  end
-
-  # Attach the articles to the campaign.
-  campaign_set = {
-    :campaign_id => campaign_id,
-    :shared_set_id => shared_set_id
-  }
-
-  response = campaign_shared_set_srv.mutate([
-    {:operator => 'ADD', :operand => campaign_set}
-  ])
-  if response and response[:value]
-    campaign_shared_set = response[:value].first
-    puts 'Shared set ID %d was attached to campaign ID %d' %
-        [campaign_shared_set[:shared_set_id], campaign_shared_set[:campaign_id]]
-  else
-    raise StandardError, 'No campaign shared set was added'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201509
-
-  begin
-    # Campaign ID to attach shared keyword set to.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-    create_and_attach_shared_keyword_set(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/advanced_operations/find_and_remove_criteria_from_shared_set.rb

@@ -1,174 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2015, 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 demonstrates how to find shared sets, shared set criterions and
-# how to remove them.
-
-require 'adwords_api'
-
-def find_and_remove_criteria_from_shared_set(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_shared_set_srv =
-      adwords.service(:CampaignSharedSetService, API_VERSION)
-  shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
-
-  shared_set_ids = []
-  criterion_ids = []
-
-  # First, retrieve all shared sets associated with the campaign.
-
-  # Create selector for shared sets to:
-  # - filter by campaign ID,
-  # - filter by shared set type.
-  selector = {
-    :fields => ['SharedSetId', 'CampaignId', 'SharedSetName', 'SharedSetType',
-        'Status'],
-    :predicates => [
-      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]},
-      {:field => 'SharedSetType', :operator => 'IN', :values =>
-          ['NEGATIVE_KEYWORDS', 'NEGATIVE_PLACEMENTS']}
-    ],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = campaign_shared_set_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |shared_set|
-        puts "Campaign shared set ID %d and name '%s'" %
-            [shared_set[:shared_set_id], shared_set[:shared_set_name]]
-        shared_set_ids << shared_set[:shared_set_id]
-      end
-      # Increment values to request the next page.
-      offset += PAGE_SIZE
-      selector[:paging][:start_index] = offset
-    end
-  end while page[:total_num_entries] > offset
-
-  # Next, Retrieve criterion IDs for all found shared sets.
-  selector = {
-    :fields => ['SharedSetId', 'Id', 'KeywordText', 'KeywordMatchType',
-        'PlacementUrl'],
-    :predicates => [
-      {:field => 'SharedSetId', :operator => 'IN', :values => shared_set_ids}
-    ],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = shared_criterion_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |shared_criterion|
-        if shared_criterion[:criterion][:type] == 'KEYWORD'
-          puts "Shared negative keyword with ID %d and text '%s' was found." %
-            [shared_criterion[:criterion][:id],
-             shared_criterion[:criterion][:text]]
-        elsif shared_criterion[:criterion][:type] == 'PLACEMENT'
-          puts "Shared negative placement with ID %d and url '%s' was found." %
-            [shared_criterion[:criterion][:id],
-             shared_criterion[:criterion][:url]]
-        else
-          puts 'Shared criterion with ID %d was found.' %
-            [shared_criterion[:criterion][:id]]
-        end
-        criterion_ids << {
-           :shared_set_id => shared_criterion[:shared_set_id],
-           :criterion_id => shared_criterion[:criterion][:id]
-        }
-      end
-      # Increment values to request the next page.
-      offset += PAGE_SIZE
-      selector[:paging][:start_index] = offset
-    end
-  end while page[:total_num_entries] > offset
-
-  # Finally, remove the criteria.
-  operations = criterion_ids.map do |criterion|
-    {
-      :operator => 'REMOVE',
-      :operand => {
-        :criterion => {:id => criterion[:criterion_id]},
-        :shared_set_id => criterion[:shared_set_id]
-      }
-    }
-  end
-
-  response = shared_criterion_srv.mutate(operations)
-  if response and response[:value]
-    response[:value].each do |criterion|
-      puts "Criterion ID %d was successfully removed from shared set ID %d." %
-          [criterion[:criterion][:id], criterion[:shared_set_id]]
-    end
-  else
-    puts 'No shared criteria were removed.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201509
-  PAGE_SIZE = 500
-
-  begin
-    # ID of a campaign to remove shared criteria from.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-    find_and_remove_criteria_from_shared_set(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