snapchat

type Ad struct {
	// Id is the id representing a single ad
	Id string `json:"id"`
	// AdSquadId is the id of the ad squad that the ad is under
	AdSquadId string `json:"ad_squad_id"`
	// CreativeId is the id of the creative associated with the ad
	CreativeId string `json:"creative_id"`
	// Name is the name of the ad
	Name string `json:"name"`
	// Status is the status of the ad
	Status string `json:"status"`
	// ReviewStatus is the status of the ad's review process
	ReviewStatus string `json:"review_status"`
	// ReviewStatusReason will contain a reason for rejection if an ad was rejected
	ReviewStatusReason string `json:"review_status_reason"`
	// Type is the type of the ad
	Type string `json:"type"`
	// CreatedAt is the time when the campaign was created
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt is the time when the campaign was last updated
	UpdatedAt time.Time `json:"updated_at"`
}

type AdAccount struct {
	// Id is the unique id associated with the ad account
	Id string `json:"id"`
	// Name is the name associated with the ad account
	Name string `json:"name"`
	// OrganizationId is the id of the organization the user is associated with
	OrganizationId string `json:"organization_id"`
	// Timezone is the timezone that is associated with the account
	Timezone string `json:"timezone"`
	// Type is the type of ad account
	Type string `json:"type"`
	// LifetimeSpendCapMicro is the lifetime spend limit for the account
	LifetimeSpendCapMicro int64 `json:"lifetime_spend_cap_micro"`
	// AdvertiserOrganizationId is the organization id of the advertiser selected
	AdvertiserOrganizationId string `json:"advertiser_organization_id"`
	// Advertiser is the name of the advertiser associated with the account
	Advertiser string `json:"advertiser"`
	// Currency is the type of currency associated with the ad account
	Currency string `json:"currency"`
	// FundingSourceIds is a list of funding source ids associated with the ad account
	FundingSourceIds []string `json:"funding_source_ids"`
}

type AdAccountResponse struct {
	// SubRequestStatus is the status of this specific ad account request
	SubRequestStatus string `json:"sub_request_status"`
	// AdAccount is the object representing an ad account
	AdAccount AdAccount `json:"adaccount"`
}

type AdAccountService service

type AdResponse struct {
	SubRequestStatus string `json:"sub_request_status"`
	Ad               Ad     `json:"ad"`
}

type AdService service

type AdSquad struct {
	// Id is the id representing a single ad squad
	Id string `json:"id"`
	// CampaignId is the id of the campaign this ad squad is associated with
	CampaignId string `json:"campaign_id"`
	// BidMicro the max bid (micro-currency)
	BidMicro int64 `json:"bid_micro"`
	// BillingEvent is the billing event associated with the ad squad
	BillingEvent string `json:"billing_event"`
	// DailyBudgetMicro is the daily spend budget (micro-currency)
	DailyBudgetMicro int64 `json:"daily_budget_micro"`
	// EndTime is the ending time of the ad squad
	EndTime time.Time `json:"end_time"`
	// StartTime is the starting time of the ad squad
	StartTime time.Time `json:"start_time"`
	// Name is the name of the ad squad
	Name string `json:"name"`
	// OptimizationGoal is the optimization goal of the ad squad
	OptimizationGoal string `json:"optimization_goal"`
	// Placement is the placement for the ad squad
	Placement string `json:"placement"`
	// Status is the status of the ad squad
	Status string `json:"status"`
	// Targeting is the targeting spec of the ad squad
	//Targeting string `json:"targeting"` // might not be a string
	// IncludedContentType is a list of content types that will be included in this ad squad
	IncludedContentType []string `json:"included_content_types"`
	// ExcludedContentType is a list of content types that will be excluded in this ad squad
	ExcludedContentType []string `json:"excluded_content_types"`
	// CapAndExclusionConfig is the frequency cap and exclusion spec
	//CapAndExclusionConfig string `json:"cap_and_exclusion_config"` // might not be a string
	// LifetimeBudgetMicro is the lifetime spend budget of the ad squad (micro-currency)
	LifetimeBudgetMicro int64 `json:"lifetime_budget_micro"`
	// AdSchedulingConfig is the schedule for running ads on this adsquad
	//AdSchedulingConfig string `json:"ad_scheduling_config"` // might not be a string
	// Type is the type of ad squad
	Type string `json:"type"`
}

type AdSquadResponse struct {
	SubRequestStatus string  `json:"sub_request_status"`
	AdSquad          AdSquad `json:"adsquad"`
}

type AdSquadService service

type Campaign struct {

	// Id is the id representing a single campaign
	Id string `json:"id"`
	// AdAccountId is the Ad Account ID that this campaign is under
	AdAccountId string `json:"ad_account_id"`
	// Name is the name of the campaign
	Name string `json:"name"`
	// Status is the status of the campaign (ACTIVE, PAUSED)
	Status string `json:"status"`
	// MeasurementSpec contains the apps to be tracked for this campaign
	MeasurementSpec CampaignMeasurementSpec `json:"measurement_spec"`
	// EndTime is the time when the campaign will end
	EndTime time.Time `json:"end_time"`
	// StartTime is the time when the campaign will start
	StartTime time.Time `json:"start_time"`
	// CreatedAt is the time when the campaign was created
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt is the time when the campaign was last updated
	UpdatedAt time.Time `json:"updated_at"`
	// DailyBudgetMicro is the daily spend cap for the campaign(micro-currency)
	DailyBudgetMicro int64 `json:"daily_budget_micro"`
	// LifetimeSpendCapMicro is the lifetime spend cap for the campaign (microcurrency)
	LifetimeSpendCapMicro int64 `json:"lifetime_spend_cap_micro"`
	// contains filtered or unexported fields
}

type CampaignMeasurementSpec struct {
	// IosAppId is the ios app id of the app to use for measurement tracking
	IosAppId string `json:"ios_app_id"`
	// AndroidAppUrl is the android app url of the app to use for measurement tracking
	AndroidAppUrl string `json:"android_app_url"`
}

type CampaignResponse struct {
	SubRequestStatus string   `json:"sub_request_status"`
	Campaign         Campaign `json:"campaign"`
}

type CampaignService service

type Client struct {

	// Users is the service used to get the authenticated user
	Users *UserService
	// Organizations is the service used to interact with organizations
	Organizations *OrganizationService
	// AdAccounts is the service used to interact with ad accounts
	AdAccounts *AdAccountService
	// Campaigns is the service used to interact with campaigns
	Campaigns *CampaignService
	// FundingSources is the service used to interact with campaigns
	FundingSources *FundingSourceService
	// AdSquads is the service used to interact with ad squads
	AdSquads *AdSquadService
	// Ads is the service used to interact with ads
	Ads *AdService
	// Measurements is the service used to interact with ads
	Measurements *MeasurementService
	// contains filtered or unexported fields
}

type ErrBadRequest struct{}

type ErrForbidden struct{}

type ErrGone struct{}

type ErrInternalServerError struct{}

type ErrMethodNotAllowed struct{}

type ErrNotAcceptable struct{}

type ErrNotFound struct{}

type ErrServiceUnavailable struct{}

type ErrTooManyRequests struct{}

type ErrUnauthorized struct{}

type FundingSource struct {
	// Id is the unique id associated with the funding source
	Id string `json:"id"`
	// Type is the type of funding source
	Type string `json:"type"`
	// Status is the status of the funding source
	Status string `json:"status"`
	// BudgetSpentMicro is the total budget spent (micro-currency)
	BudgetSpentMicro int64 `json:"budget_spent_micro"`
	// Currency is the type of currency associated with the funding source
	Currency string `json:"currency"`
	// TotalBudgetMicro is the total budget (micro-currency)
	TotalBudgetMicro int64 `json:"total_budget_micro"`
	// AvailableCreditMicro is the amount of credit available (micro-currency)
	AvailableCreditMicro int64 `json:"available_credit_micro"`
	// CardType is the type of credit card associated with this funding source
	CardType string `json:"card_type"`
	// Name is the name of the funding source
	Name string `json:"name"`
	// Last4 is the last four digits of the credit card associated with this funding source
	Last4 string `json:"last_4"`
	// ExpirationYear is the expiration year of the credit card associated with this funding source
	ExpirationYear string `json:"expiration_year"`
	// ExpirationMonth is the expiration year of the credit card associated with this funding source
	ExpirationMonth string `json:"expiration_month"`
	// DailySpendLimitMicro is the daily spend limit for the credit card associated with this funding source (micro-currency)
	DailySpendLimitMicro int64 `json:"daily_spend_limit_micro"`
	// DailySpendLimitMicro is the currency of the  daily spend limit for the credit card associated with this funding source
	DailySpendLimitCurrency string `json:"daily_spend_limit_currency"`
	// ValueMicro is the value of the coupon (micro-currency)
	ValueMicro int64 `json:"value_micro"`
	// StartDate is the start date of the coupon
	StartDate time.Time `json:"start_date"`
	// EndDate is the end date of the coupon
	EndDate time.Time `json:"end_date"`
	// Email is the email associated with the funding source
	Email string `json:"email"`
	// CreatedAt is the time when the funding source was created
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt is the time when the funding source was last updated
	UpdatedAt time.Time `json:"updated_at"`
}

type FundingSourceResponse struct {
	SubRequestStatus string        `json:"sub_request_status"`
	FundingSource    FundingSource `json:"fundingsource"`
}

type FundingSourceService service

type GetAdAccountsResponse struct {
	// RequestStatus is the status of the get ad account request
	RequestStatus string `json:"request_status"`
	// RequestId is the id associated with the request
	RequestId string `json:"request_id"`
	// AdAccounts is a list of individual ad account responses
	AdAccounts []*AdAccountResponse `json:"adaccounts"`
}

type GetAdSquadsResponse struct {
	RequestStatus string             `json:"request_status"`
	RequestId     string             `json:"request_id"`
	AdSquads      []*AdSquadResponse `json:"adsquads"`
}

type GetAdsResponse struct {
	RequestStatus string        `json:"request_status"`
	RequestId     string        `json:"request_id"`
	Ads           []*AdResponse `json:"ads"`
}

type GetCampaignsResponse struct {
	RequestStatus string              `json:"request_status"`
	RequestId     string              `json:"request_id"`
	Campaigns     []*CampaignResponse `json:"campaigns"`
}

type GetFundingSourcesResponse struct {
	RequestStatus  string                   `json:"request_status"`
	RequestId      string                   `json:"request_id"`
	FundingSources []*FundingSourceResponse `json:"fundingsources"`
}

type GetMeasurementsResponse struct {
	RequestStatus string        `json:"request_status"` // the status of the request
	RequestId     string        `json:"request_id"`     // the id of the request
	TotalStats    []*TotalStats `json:"total_stats"`    // the object containing total stats for this entity
}

type GetOrganizationsResponse struct {
	RequestStatus string                  `json:"request_status"`
	RequestId     string                  `json:"request_id"`
	Organizations []*OrganizationResponse `json:"organizations"`
}

type MeasurementService service

type MeasurementStats struct {
	Impressions      int   `json:"impressions"`        // number of impressions
	Swipes           int   `json:"swipes"`             // number of swipe-ups
	Spend            int64 `json:"spend"`              // amount spent (micro-currency)
	FirstQuartile    int   `json:"quartile_1"`         // number of video views to 25%
	SecondQuartile   int   `json:"quartile_2"`         // number of video views to 50%
	ThirdQuartile    int   `json:"quartile_3"`         // number of video views to 75%
	ScreenTimeMillis int64 `json:"screen_time_millis"` // total time spent on top snap ad (milliseconds)
	ViewCompletion   int   `json:"view_completion"`    // the number of views to completion
	VideoViews       int   `json:"video_views"`        // the total number of impressions that meet the qualifying video view criteria of at least 2 seconds of consecutive watch time or a swipe up action on the Top Snap
}

type Organization struct {
	// Id is the unique id associated with the organization
	Id string `json:"id"`
	// Name is the name of the organization
	Name string `json:"name"`
	// AddressLine1 is the street address associated with the organization
	AddressLine1 string `json:"address_line_1"`
	// Locality is the region/city associated with the account
	Locality string `json:"locality"`
	// AdministrativeDistrictLevel1 is the region/state associated with the organization
	AdministrativeDistrictLevel1 string `json:"administrative_district_level_1"`
	// County is the country associated with the organization
	Country string `json:"country"`
	// PostalCode is the postal code associated with the organization
	PostalCode string `json:"postal_code"`
	// Type is the type of organization
	Type string `json:"type"`
	// CreatedAt is the time when the organization was created
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt is the time when the organization was last updated
	UpdatedAt time.Time `json:"updated_at"`
}

type OrganizationResponse struct {
	SubRequestStatus string       `json:"sub_request_status"`
	Organization     Organization `json:"organization"`
}

type OrganizationService service

type TotalStat struct {
	Id          string           `json:"id"`          // the id of the entity
	Type        string           `json:"type"`        // the type of the entity
	Granularity string           `json:"granularity"` // the level of granulatiry for stats reporting
	Stats       MeasurementStats `json:"stats"`       // the object containing actual metrics
}

type TotalStats struct {
	SubRequestStatus string    `json:"sub_request_status"`
	TotalStat        TotalStat `json:"total_stat"`
}

type User struct {
	// Id is the unique id associated with the user
	Id string `json:"id"`
	// Email is the email associated with the user
	Email string `json:"email"`
	// OrganizationId is the id of the organization associated with the user
	OrganizationId string `json:"organization_id"`
	// DisplayName is the display name of the user
	DisplayName string `json:"display_name"`
	// CreatedAt is the time when the user was created
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt is the time when the user was last updated
	UpdatedAt time.Time `json:"updated_at"`
}

type UserService service