google-adwords-api 0.21.1 → 0.22.0

data/examples/v201603/remarketing/add_crm_based_user_list.rb

@@ -1,116 +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 adds a user list (a.k.a. audience) and uploads hashed email
-# addresses to populate the list.
-#
-# Note: It may take several hours for the list to be populated with members.
-# Email addresses must be associated with a Google account. For privacy
-# purposes, the user list size will show as zero until the list has at least
-# 1000 members. After that, the size will be rounded to the two most
-# significant digits.
-
-require 'adwords_api'
-require 'digest'
-
-def add_crm_based_user_list(emails)
-  # 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')
-
-  user_list_srv = adwords.service(:AdwordsUserListService, API_VERSION)
-
-  user_list = {
-    :xsi_type => 'CrmBasedUserList',
-    :name => 'Customer relationship management list #%d' % Time.new.usec,
-    :description => 'A list of customers that originated from email addresses',
-    # Maximum life span is 180 days.
-    :membership_life_span => 180
-  }
-
-  operation = {
-    :operand => user_list,
-    :operator => 'ADD'
-  }
-
-  result = user_list_srv.mutate([operation])
-  user_list_id = result[:value].first[:id]
-
-  sha_digest = Digest::SHA256.new
-  hashed_emails = emails.map do |email|
-    # Remove leading and trailing whitespace and convert all characters to
-    # lowercase before generating the hashed version.
-    email = email.strip.downcase
-    sha_digest.hexdigest(email)
-  end
-
-  mutate_members_operation = {
-    :operand => {
-      :user_list_id => user_list_id,
-      :data_type => 'EMAIL_SHA256',
-      :members => hashed_emails
-    },
-    :operator => 'ADD'
-  }
-
-  mutate_members_result =
-      user_list_srv.mutate_members([mutate_members_operation])
-
-  mutate_members_result[:user_lists].each do |user_list|
-    puts "User list with name '%s' and ID '%d' was added." %
-        [user_list[:name], user_list[:id]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201603
-
-  emails = ['customer1@example.com', 'customer2@example.com',
-      ' Customer3@example.com ']
-
-  begin
-    add_crm_based_user_list(emails)
-
-  # 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/v201603/remarketing/add_rule_based_user_lists.rb

@@ -1,167 +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 example adds two rule-based remarketing user lists: one with no site
-# visit data restrictions, and another that will only include users who visit
-# your site in the next six months.
-
-require 'adwords_api'
-
-def add_rule_based_user_lists()
-  # 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')
-
-  user_list_srv = adwords.service(:AdwordsUserListService, API_VERSION)
-
-  # First rule item group - users who visited the checkout page and had more
-  # than one item in their shopping cart.
-  cart_rule_item = {
-    :xsi_type => 'StringRuleItem',
-    :key => {
-      :name => 'ecomm_pagetype'
-    },
-    :op => 'EQUALS',
-    :value => 'checkout'
-  }
-
-  cart_size_rule_item = {
-    :xsi_type => 'NumberRuleItem',
-    :key => {
-      :name => 'cartsize'
-    },
-    :op => 'GREATER_THAN',
-    :value => 1.0
-  }
-
-  # Combine the two rule items into a RuleItemGroup so AdWords will AND
-  # their rules together.
-  checkout_multiple_item_group = {
-    :items => [cart_rule_item, cart_size_rule_item]
-  }
-
-  # Second rule item group - users who checked out after October 31st
-  # and before January 1st.
-  start_date_rule_item = {
-    :xsi_type => 'DateRuleItem',
-    :key => {
-      :name => 'checkoutdate'
-    },
-    :op => 'AFTER',
-    :value => '20141031'
-  }
-
-  end_date_rule_item = {
-    :xsi_type => 'DateRuleItem',
-    :key => {
-      :name => 'checkoutdate'
-    },
-    :op => 'BEFORE',
-    :value => '20150101'
-  }
-
-  # Combine the date rule items into a RuleItemGroup.
-  checked_out_nov_dec_item_group = {
-    :items => [start_date_rule_item, end_date_rule_item]
-  }
-
-  # Combine the rule item groups into a Rule so AdWords will OR the
-  # groups together.
-  rule = {
-    :groups => [checkout_multiple_item_group, checked_out_nov_dec_item_group]
-  }
-
-  # Create the user list with no restrictions on site visit date.
-  expression_user_list = {
-    :xsi_type => 'ExpressionRuleUserList',
-    :name => 'Users who checked out in November or December OR ' +
-        'visited the checkout page with more than one item in their cart',
-    :description => 'Expression based user list',
-    :rule => rule
-  }
-
-  # Create the user list restricted to users who visit your site within the
-  # specified timeframe.
-  date_user_list = {
-    :xsi_type => 'DateSpecificRuleUserList',
-    :name => 'Date rule user list created at ' + Time.now.to_s,
-    :description => 'Users who visited the site between 20141031 and ' +
-        '20150331 and checked out in November or December OR visited the ' +
-        'checkout page with more than one item in their cart',
-    # We re-use the rule here. To avoid side effects, we need a deep copy.
-    :rule => Marshal.load(Marshal.dump(rule)),
-    # Set the start and end dates of the user list.
-    :start_date => '20141031',
-    :end_date => '20150331'
-  }
-
-  # Create operations to add the user lists.
-  operations = [expression_user_list, date_user_list].map do |user_list|
-    {
-      :operand => user_list,
-      :operator => 'ADD'
-    }
-  end
-
-  # Submit the operations.
-  response = user_list_srv.mutate(operations)
-
-  # Display the results.
-  response[:value].each do |user_list|
-    puts ("User list added with ID %d, name '%s', status '%s', " +
-        "list type '%s', accountUserListStatus '%s', description '%s'.") %
-        [user_list[:id], user_list[:name], user_list[:status],
-        user_list[:list_type], user_list[:account_user_list_status],
-        user_list[:description]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201603
-
-  begin
-    add_rule_based_user_lists()
-
-  # 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/v201603/remarketing/upload_offline_conversions.rb

@@ -1,98 +0,0 @@
-#!/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 code example imports offline conversion values for specific clicks to
-# your account. To get Google Click ID for a click, run
-# CLICK_PERFORMANCE_REPORT. To set up a conversion tracker, run the
-# add_conversion_tracker.rb example.
-
-require 'adwords_api'
-require 'date'
-
-def upload_offline_conversions(conversion_name, google_click_id,
-                               conversion_time, conversion_value)
-  # 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')
-
-  conversion_feed_srv =
-      adwords.service(:OfflineConversionFeedService, API_VERSION)
-
-  # Associate offline conversions with the existing named conversion tracker. If
-  # this tracker was newly created, it may be a few hours before it can accept
-  # conversions.
-  feed = {
-    :conversion_name => conversion_name,
-    :google_click_id => google_click_id,
-    :conversion_time => conversion_time,
-    :conversion_value => conversion_value
-  }
-  return_feeds = conversion_feed_srv.mutate([
-    {:operator => 'ADD', :operand => feed}])
-  return_feeds[:value].each do |return_feed|
-    puts ("Uploaded offline conversion value %.2f for Google Click ID '%s', " +
-        'to %s') % [return_feed[:conversion_value],
-                    return_feed[:google_click_id],
-                    return_feed[:conversion_name]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201603
-
-  begin
-    # Name of the conversion tracker to upload to.
-    conversion_name = 'INSERT_CONVERSION_NAME_HERE'
-    # Google Click ID of the click for which offline conversions are uploaded.
-    google_click_id = 'INSERT_GOOGLE_CLICK_ID_HERE'
-    # Conversion time in 'yyyymmdd hhmmss' format.
-    conversion_time = Time.new.strftime("%Y%m%d %H%M%S")
-    # Conversion value to be uploaded.
-    conversion_value = 'INSERT_CONVERSION_VALUE_HERE'.to_f
-
-    upload_offline_conversions(conversion_name, google_click_id,
-                               conversion_time, conversion_value)
-
-  # 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/v201603/reporting/download_criteria_report.rb

@@ -1,92 +0,0 @@
-#!/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 gets and downloads an Ad Hoc report from a XML report definition.
-
-require 'adwords_api'
-
-def download_criteria_report(file_name)
-  # 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')
-
-  # Get report utilities for the version.
-  report_utils = adwords.report_utils(API_VERSION)
-
-  # Define report definition. You can also pass your own XML text as a string.
-  report_definition = {
-    :selector => {
-      :fields => ['CampaignId', 'AdGroupId', 'Id', 'Criteria', 'CriteriaType',
-          'FinalUrls', 'Impressions', 'Clicks', 'Cost'],
-      # Predicates are optional.
-      :predicates => {
-        :field => 'Status',
-        :operator => 'IN',
-        :values => ['ENABLED', 'PAUSED']
-      }
-    },
-    :report_name => 'Last 7 days CRITERIA_PERFORMANCE_REPORT',
-    :report_type => 'CRITERIA_PERFORMANCE_REPORT',
-    :download_format => 'CSV',
-    :date_range_type => 'LAST_7_DAYS',
-  }
-
-  # Optional: Set the configuration of the API instance to suppress header,
-  # column name, or summary rows in the report output. You can also configure
-  # this in your adwords_api.yml configuration file.
-  adwords.skip_report_header = false
-  adwords.skip_column_header = false
-  adwords.skip_report_summary = false
-  # Enable to allow rows with zero impressions to show.
-  adwords.include_zero_impressions = false
-
-  # Download report, using "download_report_as_file" utility method.
-  # To retrieve the report as return value, use "download_report" method.
-  report_utils.download_report_as_file(report_definition, file_name)
-  puts "Report was downloaded to '%s'." % file_name
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201603
-
-  begin
-    # File name to write report to.
-    file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
-    download_criteria_report(file_name)
-
-  # 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::ReportError => e
-    puts "Reporting Error: %s" % e.message
-  end
-end