Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 4.48 KB

UserEvent.md

File metadata and controls

34 lines (25 loc) · 4.48 KB

UserEvent

One event (the feed entry and the webhook body are the same envelope; the feed adds cursor). Money is in cents — of the network currency for campaign, balance and conversion amounts, of currency where an event carries one.

Properties

Name Type Description Notes
cursor str Feed only. [optional]
id str Unique per event — dedupe on it. [optional]
type str [optional]
created_at datetime [optional]
data Dict[str, object] Always `user_id`. Per type — `ad.approved` / `ad.rejected`: `ad_id`, `ad_title`, `campaign_id`, `campaign_name`, `campaign_type`, `reviewed_at`, rejected also `reason` (and `reason_id`). `campaign.paused` / `campaign.resumed`: `campaign_id`, `campaign_name`, `campaign_type`, `reason` — paused: `manual` (you or staff), `budget_daily`, `budget_total`, `balance_empty`, `schedule` (dayparting, start/end date or a delivery cap); resumed: `manual`, `new_day`, `balance_topped_up`, `schedule`. `campaign.budget_reached`: campaign fields + `budget` (`daily` / `total`). `balance.low` / `balance.empty`: `balance_cents`, `credit_limit_cents`, `low_balance_cents`. `deposit.completed`: `deposit_id`, `amount_cents`, `currency`, `pay_type`, `completed_at` (+ `bonus_cents`). `conversion.summary`: `hour_start`, `hour_end`, `conversions`, `cost_cents`, `value_cents`, `campaigns[]` (`campaign_id`, `conversions`, `cost_cents`, `value_cents`; up to 100). `conversion.received`: `campaign_id`, `ad_id`, `zone_id`, `conv_type`, `count`, `cost_cents`, `value_cents`, `click_id`, `transaction_id`, `event_name`, `status`, `converted_at`. `payout.requested` / `payout.paid`: `payout_id`, `amount_cents`, `fee_cents`, `currency`, `payout_type` (+ `paid_on`). `site.approved` / `site.rejected`: `site_id`, `site_name`, `url`, `reviewed_at` (+ `reason`). `media_buying.report` (admanager networks; daily or weekly per buying ad zone): `adzone_id`, `period`, `from`, `to`, `currency`, `revenue`, `cost`, `profit`, `margin_pct`, `visits`, `actions` (count per change type), `failed`, `pending`, `losing` / `earning` (top 5 placements: `zone_id`, `cost`, `revenue`, `margin_pct`), `panel_url`. `media_buying.alert` (admanager networks, tracking links; when a buy needs you now): `adzone_id`, `kind` (`source_held` — the stop-loss or spend cap paused the source; `remoderation` — a change put the campaign back into the network's moderation; `source_stopped` — 10 failed pause / activate calls; `test_passed` / `test_failed` / `test_no_data` — the verdict of a launch test phase), `title`, `detail`, `panel_url`. `webhook.test`: `webhook_id`, `message`. [optional]

Example

from goadserver.models.user_event import UserEvent

# TODO update the JSON string below
json = "{}"
# create an instance of UserEvent from a JSON string
user_event_instance = UserEvent.from_json(json)
# print the JSON string representation of the object
print(UserEvent.to_json())

# convert the object into a dict
user_event_dict = user_event_instance.to_dict()
# create an instance of UserEvent from a dict
user_event_from_dict = UserEvent.from_dict(user_event_dict)

[Back to Model list] [Back to API list] [Back to README]