#!/usr/bin/python
#
# Copyright 2008, Google Inc. All Rights Reserved.
#
# 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 sample retrieves traffic estimate for the requested keyword."""

import SOAPpy


# Provide AdWords login information.
email = 'INSERT_LOGIN_EMAIL_HERE'
password = 'INSERT_PASSWORD_HERE'
client_email = 'INSERT_CLIENT_LOGIN_EMAIL_HERE'
useragent = 'INSERT_COMPANY_NAME: AdWords API Python Sample Code'
developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
application_token = 'INSERT_APPLICATION_TOKEN_HERE'

# Define SOAP headers.
headers = SOAPpy.Types.headerType()
headers.email = email
headers.password = password
headers.clientEmail = client_email
headers.useragent = useragent
headers.developerToken = developer_token
headers.applicationToken = application_token

# Set up service connection. To view XML request/response, change value of
# estimator_service.config.debug to 1. To send requests to production
# environment, replace "sandbox.google.com" with "adwords.google.com".
namespace = 'https://sandbox.google.com/api/adwords/v12'
estimator_service = SOAPpy.SOAPProxy(namespace + '/TrafficEstimatorService',
                                     header=headers)
estimator_service.config.debug = 0

# Create keyword structure.
keyword = {
  'text': 'mars cruise',
  'maxCpc': SOAPpy.Types.untypedType('1000000'),
  'type': SOAPpy.Types.untypedType('Broad')
}

# Estimate keyword traffic.
estimates = estimator_service.estimateKeywordList([keyword])

# Convert to a list if we get back a single object.
if len(estimates) > 0 and not isinstance(estimates, list):
  estimates = [estimates]

# Display estimate info.
for index in range(len(estimates)):
  print 'Estimates for keyword with text "%s":' % (keyword['text'])
  print '  Lower average position is "%s".' % \
      (estimates[index]['lowerAvgPosition'])
  print '  Upper average position is "%s".' % \
      (estimates[index]['upperAvgPosition'])
  print '  Lower clicks per day is "%s".' % \
      (estimates[index]['lowerClicksPerDay'])
  print '  Upper clicks per day is "%s".' % \
      (estimates[index]['upperClicksPerDay'])
  print '  Lower cpc is "%s".' % (estimates[index]['lowerCpc'])
  print '  Upper cpc is "%s".' % (estimates[index]['upperCpc'])
  print