get_search_num.py

import custom_exceptions, reusable_funcs
from advertisement_api import AdAPI
from tabulate import tabulate
from tqdm import tqdm
import requests, time
import pandas as pd
import numpy as np

@reusable_funcs.ReAttemptUntilFailure(max_attempt=10, time=30) #IF THE RESPONSE IF INVALID, REATTEMPTS FOR 'max_attempt' attempts, for 'time' seconds.
def GetNumSearch(keywords, ad_api):
	'''
	Takes in a list object containing five keywords
	Returns a list object with lenght of five, that provides the monthly number of searches for the each keywords given as the argument.
	'''
	# global BASE_URL, CUSTOMER_ID, API_KEY, SECRET_KEY

	uri = '/keywordstool'
	method = 'GET'	
	query = {
		'siteId:': '',
		'biztpId':'',
		'hintKeywords':keywords,
		'event':'',
		'mont':'1',
		'showDetail':"1"
	}	
	response = requests.get(ad_api.BASE_URL + uri, params=query, headers=ad_api.get_header(method,uri))
       
	if response.status_code == 200:
		data_response = response.json()
		data_response = data_response['keywordList'][:5]
		time.sleep(0.17)
		return data_response
	else:
		raise custom_exceptions.ResponseError(response.status_code)

def SortResponse(arr1, arr2):
	'''
	Sorts arr2 so that it is the same as arr1
	Returns sorted arr2
	'''
	arr1 = list(map(str.upper,arr1))
	order_dict = {color: index for index, color in enumerate(arr1)}
	arr2.sort(key=lambda x: order_dict[x["relKeyword"]])

	return arr2

def CheckCorruptData(data, k):
	'''
	IF THE monthlyMobileQcCnt or monthlyPcQcCnt is smaller than 10, then the API returns a str '< 10'.
	This function filters that string and fills that data with 0
	'''
	if data[k]["monthlyMobileQcCnt"] == '< 10':
		data[k]["monthlyMobileQcCnt"] = 0
	if data[k]["monthlyPcQcCnt"] == '< 10':
		data[k]["monthlyPcQcCnt"] = 0

def add_numSearch(table: pd.DataFrame, ad_api):
	'''
	Takes in the dataframe object 'table' which contains all the keywords
	Returns nothing, instead, modifies the 'table' variable in the main function, since dataframes are mutable when passed as argument.
	adds monthly search num, average click num and competitive index
	'''
	num_search = []
	num_click = []
	compIdx = []
	for i in tqdm(range(5, 6001, 5)):
		keywords = table["Keywords"][i-5:i]

		try:
			data = GetNumSearch(keywords, ad_api)
			data = SortResponse(keywords, data)
			for k in range(5):
				CheckCorruptData(data, k)
				num_search.append(data[k]["monthlyMobileQcCnt"] + data[k]["monthlyPcQcCnt"])
				num_click.append(data[k]["monthlyAvePcClkCnt"] + data[k]["monthlyAveMobileClkCnt"])
				compIdx.append(data[k]["compIdx"])
		except custom_exceptions.ReAttemptFail as e:
			print(e.messaage)
			num_search += [np.nan] * 5
			num_click += [np.nan] * 5
			compIdx += [np.nan] * 5
			
	table["Monthly_num_search"] = num_search
	table["Avg_monthly_click"] = num_click
	table["Competitiveness"] = compIdx

def main():       
	ad_api = AdAPI()
	table = pd.read_csv(f"./data/m_top10_keywords.csv", encoding="euc-kr")
	add_numSearch(table, ad_api) #Modifies the table so that it contains the monthly number of searches
	table.to_csv(f"./data/m_top10_keywords.csv", encoding="euc-kr", index=False)

if __name__ == "__main__":
      main()