Skip to content

creating entities #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eugene-katsevman wants to merge 2 commits into
base: master
Choose a base branch
from
Open

creating entities #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad6595d
creating stuff
eugene-katsevman Feb 11, 2016
a854f00
prints removed
eugene-katsevman Feb 11, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 164 additions & 12 deletions outbrain/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,44 @@ def __init__(self, outbrain_config=None):
self.base_url = outbrain_config['base_url']
if not self.base_url.endswith('/'):
self.base_url += '/'

self.verify = outbrain_config.get('verify', True)
if not self.verify:
requests.packages.urllib3.disable_warnings()
self.token = self.get_token(self.user, self.password)
self.locale = pytz.timezone("US/Eastern") # Outbrain's reporting is in Eastern time

def _request(self, path, params={}):
url = self.base_url + path
r = requests.get(url, headers={'OB-TOKEN-V1': self.token}, params=params)
r = requests.get(url, headers={'OB-TOKEN-V1': self.token}, params=params, verify=self.verify)
if r.status_code == 404:
return None
return json.loads(r.text)

def _post_request(self, path, params={}):
url = self.base_url + path
r = requests.post(url, headers={'OB-TOKEN-V1': self.token}, params=params, verify=self.verify)
if r.status_code == 404:
return None
return json.loads(r.text)

def _put_request(self, path, params={}):
url = self.base_url + path
r = requests.put(url, headers={'OB-TOKEN-V1': self.token}, params=params, verify=self.verify)
if r.status_code == 404:
return None
return json.loads(r.text)

def _detete_request(self, path, params={}):
url = self.base_url + path
r = requests.delete(url, headers={'OB-TOKEN-V1': self.token}, params=params, verify=self.verify)
if r.status_code == 404:
return None
return json.loads(r.text)

def get_token(self, user, password):
token_url = self.base_url + 'login'
basic_auth = requests.auth.HTTPBasicAuth(user, password)
r = requests.get(token_url, auth=basic_auth)
r = requests.get(token_url, auth=basic_auth, verify=self.verify)
results = json.loads(r.text)
return results['OB-TOKEN-V1']

Expand Down Expand Up @@ -72,15 +97,16 @@ def get_campaign(self, campaign_id):
result = self._request(path)
return result

def get_campaign_ids(self):
return [c['id'] for c in self.get_campaigns()]
def get_campaign_ids(self, include_archived=True):
return [c['id'] for c in self.get_campaigns(include_archived=include_archived)]

def get_campaigns(self):
return [c for c in self._yield_all_campaigns()]
def get_campaigns(self, include_archived=True):
return [c for c in self._yield_all_campaigns(include_archived=include_archived)]

def _yield_all_campaigns(self):
marketer_ids = self.get_marketer_ids()
marketer_campaigns = self.get_campaigns_per_marketer(marketer_ids)
def _yield_all_campaigns(self, marketer_ids = [], include_archived=True):
if not marketer_ids:
marketer_ids = self.get_marketer_ids()
marketer_campaigns = self.get_campaigns_per_marketer(marketer_ids, include_archived=include_archived)
for m in marketer_campaigns.keys():
for c in marketer_campaigns[m]:
yield c
Expand All @@ -98,12 +124,111 @@ def get_campaigns_per_marketer(self, marketing_ids, include_archived=True):
campaigns = {}
for marketing_id in marketing_ids:
path = 'marketers/{0}/campaigns'.format(marketing_id)
params = {'includeArchived': 'true' if include_archived else 'false'}
params = {'include_archived': 'true' if include_archived else 'false'}
results = self._request(path, params)
marketer_campaigns = results.get('campaigns', [])
campaigns[marketing_id] = marketer_campaigns
return campaigns

# ----------------------------------------------------------------------------------------------
# Methods to create and update entities
# ----------------------------------------------------------------------------------------------
def create_budget(self, marketer_id, name, amount, start_date, end_date, runForever, type, pacing, dailyTarget):
params = """
{{
"name": "{}",
"amount": {},
"startDate": "{}",
"endDate": "{}",
"runForever": "{}"
"type": "{}"
"pacing": "{}",
"dailyTarget": "{}"
}}
""".format(name, amount, start_date, end_date, runForever, type, pacing, dailyTarget)
path = "marketers/{}/budgets".format(marketer_id)
results = self._post_request(path, params)
return results

def change_budget(self, budget_id, amount=None, start_date=None, end_date=None, runForever = None, dailyTarget = None):
values = {"id" : budget_id}
if amount is not None:
values["amount"] = amount
if start_date is not None:
values["start_date"] = start_date
if end_date is not None:
values["end_date"] = end_date

if runForever is not None:
values["runForever"] = runForever

if dailyTarget is not None:
values["dailyTarget"] = dailyTarget

params = json.dumps(values)
path = "budgets/{}".format(budget_id)
results = self._put_request(path, params)
return results


def create_campaign(self, name, cpc, budgetId, platforms, tracking_code, feeds):
params = """
{{
"name": "{}",
"cpc": {},
"enabled": true,
"budgetId": "{}",
"targeting": {{
"platform": [
{}
]
}},
"suffixTrackingCode": "{}",
"feeds": [
{}
]
}}
""".format(name, cpc, budgetId, ", ".join(platforms), tracking_code, ", ".join(feeds))
path = "campaigns"
results = self._post_request(path, params)
return results

def change_campaign(self, campaign_id, name=None, enabled=None, platforms=None, tracking_code=None):
values = {"id": campaign_id}
if name is not None:
values["name"] = name
if enabled is not None:
values["enabled"] = enabled
if platforms is not None:
values["targeting"] = {"platform": platforms}
if tracking_code is not None:
values["suffixTrackingCode"] = tracking_code
params = json.dumps(values)

path = "campaigns/{}".format(campaign_id)
results = self._put_request(path, params)
return results

def create_promoted_link(self, campaign_id, text, url, imageUrl):
params = """
{{"text": "{}",
"url": "{}",
"enabled": true,
"imageUrl": "{}"
}}
""".format(text, url, imageUrl)
path = "campaigns/{}/promotedLinks".format(campaign_id)
results = self._post_request(path, params)
return results

def change_promoted_link(self, link_id, enabled):
values = {"id": link_id}
values["enabled"] = enabled
params = json.dumps(values)
path = "promotedLinks/{}".format(link_id)
results = self._post_request(path, params)
return results

# ----------------------------------------------------------------------------------------------
# Methods to acquire specific performance information
# ----------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -146,6 +271,20 @@ def get_marketers_performace_per_section(self, marketer_ids, start_day, end_day)
performance[m][data['id']] = data
return performance


def get_marketers_performance(self, marketer_ids, start_day, end_day):
"""
:returns: performance_data
"""
performance = dict()
for m in marketer_ids:
path = 'marketers/{0}/performanceByDay'.format(m)
performance[m] = dict()
result = self._page_performance_data(path, start_day, end_day)
for data in result:
performance[m] = data
return performance

def get_publisher_performace_per_marketer(self, marketer_ids, start_day, end_day):
"""
:returns: dict[marketer_id][publisher_id] = performance_data
Expand All @@ -172,6 +311,19 @@ def get_campaign_performace_per_section(self, campaign_ids, start_day, end_day):
performance[c][data['id']] = data
return performance

def get_campaign_performace_per_day(self, campaign_ids, start_day, end_day):
"""
:returns: dict[campaign_id][section] = performance_data
"""
performance = dict()
for c in campaign_ids:
path = 'campaigns/{0}/performanceByDay'.format(c)
performance[c] = dict()
result = self._page_performance_data(path, start_day, end_day)
for data in result:
performance[c] = data
return performance

# ----------------------------------------------------------------------------------------------
# "Private" helper methods for acquiring/paging performance information
# ----------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -199,7 +351,7 @@ def _get_performance_data(self, path, start, end, limit, offset):
'offset': offset,
'from': start.strftime('%Y-%m-%d'),
'to': end.strftime('%Y-%m-%d')}
result = self._request(path, params)
result = self._request(path +"/", params)
return result.get('details', [])

# ----------------------------------------------------------------------------------------------
Expand Down