Optional Parameter
Name | Type | Description |
---|---|---|
targetUrl |
String | A valid URL that must begin with the merchant's default campaign URL. |
The default target URL that the merchant has specified, can be replaces using the "targetUrl" parameter. The "targetUrl" parameter must begin with the merchant's default campaign URL.
For example, if the merchant default campaign URL was "https://www.example.com/", then "https://www.example.com/deep/link" is an acceptable deep link.
On the other hand, if the merchant default campaign URL was "https://www.example.com/deep/link", then "https://www.example.com/" is not an acceptable deep link, because it does not begin with the merchant's default campaign URL.
GET https://api.commissionfactory.com/V1/Affiliate/Banners/1?apiKey=ABC123&targetUrl=http%3A%2F%2Fwww.example.com%2Fdeep%2Flink
{ "Id": 1, "DateCreated": "2000-01-01T00:00:00.000", "DateModified": "2000-01-01T00:00:00.000", "MerchantId": 1, "MerchantName": "Example Pty Ltd", "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png", "GroupName": " Default Group", "Name": "Banner 1", "TargetUrl": "https://www.example.com/deep/link", "Size": "Full Banner", "Width": 468, "Height": 60, "ImageUrl": "https://t.cfjump.com/a/1/1", "AltText": "Example Pty Ltd Banner", "TrackingUrl": "https://t.cfjump.com/0/b/1?Url=http%3A%2F%2Fwww.example.com%2Fdeep%2flink", "TrackingCode": "<a href=\"https://t.cfjump.com/0/b/1?Url=http%3A%2F%2Fwww.example.com%2Fdeep%2flink\" referrerpolicy=\"no-referrer-when-downgrade\" rel=\"nofollow sponsored\" onmousedown=\"this.rel = 'nofollow sponsored';\"><img style=\"border: none; vertical-align: middle;\" alt=\"Example Pty Ltd Banner\" referrerpolicy=\"no-referrer-when-downgrade\" src=\"https://t.cfjump.com/a/1/1\" /></a>" }
<Banner xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate"> <Id>1</Id> <DateCreated>2000-01-01T00:00:00.000</DateCreated> <DateModified>2000-01-01T00:00:00.000</DateModified> <MerchantId>1</MerchantId> <MerchantName>Example Pty Ltd</MerchantName> <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl> <GroupName> Default Group</GroupName> <Name>Banner 1</Name> <TargetUrl>https://www.example.com/</TargetUrl> <Size>Full Banner</Size> <Width>468</Width> <Height>60</Height> <ImageUrl>https://t.cfjump.com/a/1/1</ImageUrl> <AltText>Example Pty Ltd Banner</AltText> <ExpiryDate>2000-01-01T00:00:00.000</ExpiryDate> <TrackingUrl>https://t.cfjump.com/0/b/1?Url=http%3A%2F%2Fwww.example.com%2Fdeep%2flink</TrackingUrl> <TrackingCode><a href="https://t.cfjump.com/0/b/1?Url=http%3A%2F%2Fwww.example.com%2Fdeep%2flink" referrerpolicy="no-referrer-when-downgrade" rel="nofollow sponsored" onmousedown="this.rel = 'nofollow sponsored';"><img style="border: none; vertical-align: middle;" alt="Example Pty Ltd Banner" referrerpolicy="no-referrer-when-downgrade" src="https://t.cfjump.com/a/1/1" /></a></TrackingCode> </Banner>