The Campaign Object
A Campaign on Usher can be represented as a JSON Object.
Pieces of the object are distributed across different storage mechanisms to deliver on the immutability of Campaign Terms but mutability of Campaign Details and Brand/Advertiser Profile.
Once fully processed, a Campaign in its raw form, looks like this:
"description": "files are uploaded"
"name": "ArDrive Referral Program",
"description": "Refer users to ArDrive and earn when files are uploaded.",
"description": "Upload files forever!",
All properties within the Campaign Object except for
advertiserare stored immutably on the compute blockchain that the Brand decides to conduct the Partnership Program on.
advertiserare stored on the Ceramic Network, where data is mutable and write-access is owned by the Brand.
Object Property Name/Key
The identifier of the Campaign. This can be an ID within a Smart Contract or an Blockchain Transaction Address, depending on the
The blockchain identifer. ie.
The Wallet Address of the Brand/Advertiser
An array of Conversion Events. These Events represent points throughout the Referred User journey at which Conversions are Tracked
Reward rate for the event. For the
An arbitrary value that limits the conversions that can be processed for this given event for the referred/native user. Where a
If no reward
A description for when the event will trigger. The word "when" is prepended to this description in the Usher Partner App UI
The name of the rewarded token. ie. "Ether", "Arweave", "My Cool NFT"
The ticker for the rewarded token. ie. "ETH", "AR", "MYCNFT"
The type of the token rewared to Partners. This is an enumerator with values:
A limit on the rewards for the entire campaign. When the amount of claimed rewards reaches this limit, the Campaign is considered complete.
The URL that Campaign Partners will redirect users to.
Name for the Campaign to be recognisable by Partners
A description for the Campaign detailing when and how users are converted once the
A hosted image URL to further enhance recognisability of the Campaign
A URL Partners can visit to receive more information about the Campaign. Can be a landing page promoting the partnership program
Name of the Advertiser
A hosted image URL of the Advertiser's Brand Icon
A description of the Advertiser and their related services or propositions
A URL that Partners can visit to learn more about the Advertiser
A Twitter URL that Partners can visit to learn more and get updates from the Advertiser
Determines whether the Campaign will show on the Usher Explore Page. Partnership Programs that wish to remain private, and/or include a Whitelist of Partners can opt to set this to
An array of Partner Identifiers. By default, Campaigns will not include the Whitelist feature.
A URL where a Form or other form of data collection is hosted. Partners can use this URL to submit their application to participate in the Partner program.