Impact Ads
Guide to integrate your Impact Ads with Sprinkle
Pipeline Concepts
Before setting up the datasource, learn about datasource concepts here
Step by Step Guide
STEP-1: Configure Connection
To learn about Connection, refer here
Log into Sprinkle application
Navigate to Ingest -> Connections Tab -> New Connection ->
Select Impact Ads
Provide all the mandatory details
Name: Name to identify this connection
Account SID: Login to the Impact console. Go to settings and then search for Technical Settings then click on API Access. If not enable, Click Enable API Access Now. Copy the Account SID.
Auth Token: Login to the Impact console. Go to settings and then search for Technical Settings then click on API Access. Of not enable, Click Enable API Access Now. Copy the Auth Token.
Advance Settings : Refer here
Test Connection
Create
STEP-2: Configure Pipeline
To learn about datasource, refer here
Navigate to Ingest -> Pipeline Tab -> Add ->
Select Impact Ads
Provide the name -> Create
Connection Tab:
From the drop-down, select the name of connection created in STEP-2
Update
STEP-3: Create Dataset
Datasets Tab: To learn about Dataset, refer here. Add Dataset for each report/dataset that you want to integrate, providing following details
Table Types (Required): Select from the drop-down:
Accounts
Actions
ActionInquiries
ActionUpdates
Ads
Campaigns
Deals
Catalogs
Catalogs_Items
Catalogs_ItemSearch
Clicks
Contracts
Active_Contracts
PublicTerm_Contracts
Invoices
MediaProperties
Reports
Users
WithdrawalSettings
Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type.
Destination Schema (Required) : Data warehouse schema where the table will be ingested into
Destination Table name (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds_<pipelinename>_<tablename>
Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. Learn more on how to use this field.
Create
STEP-4: Run and schedule Ingestion
In the Ingestion Jobs tab:
Trigger the Job, using Run button
To schedule, enable Auto-Run. Change the frequency if needed
Advanced Connection Settings
API Read Timeout (In seconds) : Maximum time of inactivity between two data packets when waiting for the server's response. The default value is 30 seconds
API Connection Timeout (In seconds) : Time period within which a connection between a client and a server must be established.
Retry Limit : Number of retries allowed when an API call fails. For example if an API call fails and retry limit is 5 then it will check 5 times for that API call and if it succeeded then it will stop checking.
Retry Sleep Time (In milliseconds) : Given time, after which retry should happen in case an API call fails.
Dataset Fields
Accounts
companyname
primarypromotionalmethod
promotionalmethods
website
primaryphonenumber
primaryphonenumbercountry
secondaryphonenumber
secondaryphonenumbercountry
minimumcontactrating
timezone
currency
registeredforindirecttax
indirecttaxnumber
organizationtype
einssnforeigntaxid
corporateaddress_addressline1
corporateaddress_addressline2
corporateaddress_city
corporateaddress_state
corporateaddress_postalcode
corporateaddress_country
billingaddress_addressline1
billingaddress_addressline2
billingaddress_city
billingaddress_state
billingaddress_postalcode
billingaddress_country
financialcontact_userid
financialcontact_name
financialcontact_email
financialcontact_workphonenumber
financialcontact_workphonenumbercountry
financialcontact_cellphonenumber
financialcontact_cellphonenumbercountry
technicalcontact_userid technicalcontact_name
technicalcontact_email
technicalcontact_workphonenumber
technicalcontact_workphonenumbercountry
technicalcontact_cellphonenumber
technicalcontact_cellphonenumbercountry
commercialcontact_userid
commercialcontact_name
commercialcontact_email
commercialcontact_workphonenumber
commercialcontact_workphonenumbercountry
commercialcontact_cellphonenumber
commercialcontact_cellphonenumbercountry
uri
Actions
Id
CampaignId
CampaignName
ActionTrackerId
ActionTrackerName
State
AdId
Payout
Amount
Currency
ReferringDate
EventDate
LockingDate
ClearedDate
ReferringDomain
PromoCode
Oid
SubId1
SharedId
Uri
ActionInquiries
Id
MediaPartnerInquiryId
CampaignId
CampaignName
OrderId
TransactionDate
TransactionAmount
CustomerId
InquiryDate
InquiryType
ExpectedPayout
ResolutionDeadlineDate
Comments
InquiryNotes
TrackingLink
ActionId
ActionUri
AutoApprovalDate
ResolutionStatus
RejectReason
FinalPayout
ResolutionDate
CreationDate
Ads
Id
Name
Description
CampaignId
CampaignName
Type
TrackingLink
LandingPageUrl
AdvertiserId
AdvertiserName
Code
IFrameCode
Width
Height
CreativeUrl
Labels
AllowDeepLinking
MobileReady
Language
StartDate
EndDate
Season
Uri
Campaigns
AdvertiserId
AdvertiserName
AdvertiserUrl
CampaignId
CampaignName
CampaignUrl
CampaignDescription
ShippingRegions
CampaignLogoUri
PublicTermsUri
ContractStatus
ContractUri
TrackingLink
AllowsDeeplinking
DeeplinkDomains
Catalogs
Id
Name
Language
AdvertiserId
AdvertiserName
AdvertiserLocation
CampaignId
CampaignName
NumberOfItems
DateLastUpdated
Locations
FTPLocations
ItemsUri
Uri
Clicks
Id
CampaignId
CampaignName
ProfileId
IpAddress
EventDate
MediaId
MediaName
AdId
AdName
AdType
DealName
DealType
DealScope
ProductSku
CustomerArea
CustomerCity
CustomerRegion
CustomerCountry
DeviceType
DeviceFamily
Browser
Os
ReferringUrl
ReferringDomain
LandingPageUrl
SubId1
SubId2
SubId3
SharedId
TrafficCategory
TrafficSource
BidKeyword
CpcBid
UniqueClick
Payout
Contracts
Id
CampaignId
Status
StartDate
EndDate
BrandSignatory
BrandSignatoryDate
PartnerSignatory
PartnerSignatoryDate
DateCreated
DateLastUpdated
EventPayouts
SpecialTermsList
ChangeNotificationPeriod
ReturnPolicy
MaxReturnPercentage
ActionLimit
ActionLimitPeriod
SpendLimit
SpendLimitPeriod
MinEarningPerClick
ContractStartSlottingFee
FirstActionSlottingFee
MonthlySlottingFee
CustomCreativePayer
PdfUri
Uri
Deals
Id
Name
Description
CampaignId
State
Type
Scope
Public
Product
PurchaseLimitQuantity
StartDate
EndDate
DateCreated
DateLastUpdated
Uri
Invoices
Id
CreatedDate
RecipientId
RecipientName
Currency
TotalAmount
TotalVatAmount
LineItems
PDF
URI
Media
Id
Name
Thumbnail
Description
Tags
RevenueModel
Url
Type
MonthlyUniqueVisitors
AlexaRating
QuantcastRating
OwnershipVerified
MobilePlatform
AppStoreRating
Installs
Price
SocialPlatform
Followers
Handle
Users
Id
FirstName
LastName
Type
State
Language
AccessRights
JoinedDate
DateLastUpdated
CreatedBy
Uri
Withdrawal Settings
PaymentMethod
PaypalEmailAddress
BeneficiaryAccountName
BankCountry
BeneficiaryClassification
BeneficiaryAlternativeName
BeneficiaryTaxPayerId
BankAccountType
BankAccountNumber
SwiftCode
RoutingCode
VoCode
AgencyCode
BankAddress
BankPostalCode
BankCity
BankState
BranchCode
PaymentSchedulingType
PaymentThreshold
PaymentDay
Last updated