5983 Search Results for "KickApps"
- most relevant
- most recent
- highest rated
- most viewed
- top favorites
- most comments
-
Javascript Event System Suppor Javascript Event System Supported Events
- From: KristinS
-
Description:
As of KickApps version 4.0, an [[Javascript_Event_System|event system]] has been added to all hosted pages. The KickApps event system provides hooks throughout the platform, allowing developers to create plugins such as our [[Using_Facebook_Connect_With_KickApps|Facebook Connect]] plugin.
The following is a list of all events currently exposed and supported by KickApps. This list is likely to grow over time with each new release. If you have a specific need, please let us know by posting on the [http://community.kickdeveloper.com/service/displayMessageBoard.kickAction?as=764 KickDeveloper Message boards].
== Global Events ==
==== Page Events ====
* [[Javascript Event System - global-before-page-render|global-before-page-render]]
* [[Javascript Event System - global-after-page-render|global-after-page-render]]
* [[Javascript Event System - global-page-before-unload|global-page-before-unload]]
==== Login Popup ====
* [[Javascript Event System - global-login-popup-display|global-login-popup-display]]
* [[Javascript Event System - global-login-popup-before-submit|global-login-popup-before-submit]]
==== Popups ====
* [[Javascript Event System - global-popup-before-init|global-popup-before-init]]
* [[Javascript Event System - global-popup-after-init|global-popup-after-init]]
* [[Javascript Event System - global-popup-create|global-popup-create]]
== Groups Page ==
==== General ====
* [[Javascript Event System - group-page-load|group-page-load]]
==== Joining & Leaving ====
* [[Javascript Event System - group-page-after-join|group-page-after-join]]
* [[Javascript Event System - group-page-after-leave|group-page-after-leave]]
==== Commenting ====
* [[Javascript Event System - group-page-before-add-comment|group-page-before-add-comment]]
* [[Javascript Event System - group-page-after-add-comment|group-page-after-add-comment]]
==== Tagging ====
* [[Javascript Event System - group-page-before-add-tag|group-page-before-add-tag]]
* [[Javascript Event System - group-page-after-add-tag-success|group-page-after-add-tag-success]]
* [[Javascript Event System - group-page-after-add-tag-error|group-page-after-add-tag-error]]
== Facebook Connect ==
==== General ====
* [[Javascript Event System - fbc-before-init|fbc-before-init]]
* [[Javascript Event System - fbc-after-init|fbc-after-init]]
* [[Javascript Event System - fbc-after-post-success|fbc-after-post-success]]
== Profile Page ==
==== General ====
* [[Javascript Event System - profile-page-load|profile-page-load]]
* [[Javascript Event System - profile-page-toggle-about-me|profile-page-toggle-about-me]]
* [[Javascript Event System - profile-page-toggle-more-tags|profile-page-toggle-more-tags]]
* [[Javascript Event System - profile-page-after-rating|profile-page-after-rating]]
==== Friends & Fans ====
* [[Javascript Event System - profile-page-before-add-friend|profile-page-before-add-friend]]
* [[Javascript Event System - profile-page-after-add-friend|profile-page-after-add-friend]]
==== Commenting ====
* [[Javascript Event System - profile-page-before-display-comment-form|profile-page-before-display-comment-form]]
* [[Javascript Event System - profile-page-after-display-comment-form|profile-page-after-display-comment-form]]
<br/>
* [[Javascript Event System - profile-page-before-hide-comment-form|profile-page-hide-comment-form]]
* [[Javascript Event System - profile-page-after-hide-comment-form|profile-page-hide-comment-form]]
<br/>
* [[Javascript Event System - profile-page-before-add-comment|profile-page-before-add-comment]]
* [[Javascript Event System - profile-page-after-add-comment|profile-page-after-add-comment]]
<br/>
* [[Javascript Event System - profile-page-before-flag-comment|profile-page-before-flag-comment]]
* [[Javascript Event System - profile-page-after-flag-comment|profile-page-after-flag-comment]]
<br/>
* [[Javascript Event System - profile-page-before-delete-comment|profile-page-before-delete-comment]]
* [[Javascript Event System - profile-page-after-delete-comment|profile-page-after-delete-comment]]
<br/>
* [[Javascript Event System - profile-page-before-load-comments|profile-page-before-load-comments]]
* [[Javascript Event System - profile-page-after-load-comments|profile-page-after-load-comments]]
==== Profile Feeds ====
* [[Javascript Event System - profile-page-before-load-feeds|profile-page-before-load-feeds]]
* [[Javascript Event System - profile-page-after-load-feeds|profile-page-after-load-feeds]]
<br/>
* [[Javascript Event System - profile-page-before-display-feed|profile-page-before-display-feed]]
* [[Javascript Event System - profile-page-after-display-feed|profile-page-after-display-feed]]
<br/>
* [[Javascript Event System - profile-page-feed-error|profile-page-feed-error]]
== Media Play Page ==
==== General ====
* [[Javascript Event System - play-page-load|play-page-load]]
* [[Javascript Event System - play-page-before-delete|play-page-before-delete]]
* [[Javascript Event System - play-page-after-rating|play-page-after-rating]]
==== Favorites ====
* [[Javascript Event System - play-page-before-add-favorite|play-page-before-add-favorite]]
* [[Javascript Event System - play-page-after-add-favorite|play-page-after-add-favorite]]
* [[Javascript Event System - play-page-before-remove-favorite|play-page-before-remove-favorite]]
* [[Javascript Event System - play-page-after-remove-favorite|play-page-after-remove-favorite]]
==== Commenting ====
* [[Javascript Event System - play-page-before-add-comment|play-page-before-add-comment]]
* [[Javascript Event System - play-page-after-add-comment|play-page-after-add-comment]]
==== Related Media Lists ====
* [[Javascript Event System - play-page-before-load-related-media|play-page-before-load-related-media]]
* [[Javascript Event System - play-page-after-load-related-media|play-page-after-load-related-media]]
* [[Javascript Event System - play-page-before-display-related-media|play-page-before-display-related-media]]
* [[Javascript Event System - play-page-after-display-related-media|play-page-after-display-related-media]]
==== Tagging ====
* [[Javascript Event System - play-page-before-add-tag|play-page-before-add-tag]]
* [[Javascript Event System - play-page-after-add-tag-success|play-page-after-add-tag-success]]
* [[Javascript Event System - play-page-after-add-tag-error|play-page-after-add-tag-error]]
== New Member Registration Page ==
==== General ====
* [[Javascript Event System - register-user-page-load|register-user-page-load]]
* [[Javascript Event System - register-user-page-before-submit|register-user-page-before-submit]]
* [[Javascript Event System - register-user-page-coppa-cookie-found|register-user-page-coppa-cookie-found]]
== Adding new media & blogs ==
==== Adding Videos ====
* [[Javascript Event System - add-video-page-load|add-video-page-load]]
* [[Javascript Event System - add-video-page-before-submit|add-video-page-before-submit]]
==== Adding Blogs ====
* [[Javascript Event System - add-blog-page-load|add-blog-page-load]]
* [[Javascript Event System - add-blog-page-before-submit|add-blog-page-before-submit]]
==== Adding Photos ====
* [[Javascript Event System - add-photo-page-load|add-photo-page-load]]
* [[Javascript Event System - add-photo-page-before-submit|add-photo-page-before-submit]]
==== Adding Audio tracks ====
* [[Javascript Event System - add-audio-page-load|add-audio-page-load]]
* [[Javascript Event System - add-audio-page-before-submit|add-audio-page-before-submit]]
== Media List & Management ==
==== General ====
* [[Javascript Event System - media-list-page-load|media-list-page-load]]
* [[Javascript Event System - media-add-success|media-add-success]]
== Message Boards ==
==== General ====
* [[Javascript Event System - mb-forum-list-page-load|mb-forum-list-page-load]]
* [[Javascript Event System - mb-discussion-list-page-load|mb-discussion-list-page-load]]
==== Create Discussion ====
* [[Javascript Event System - mb-create-discussion-page-load|mb-create-discussion-page-load]]
* [[Javascript Event System - mb-create-discussion-before-submit|mb-create-discussion-before-submit]]
==== Discussion Thread ====
* [[Javascript Event System - mb-view-discussion-page-load|mb-view-discussion-page-load]]
==== Discussion Thread Replies ====
* [[Javascript Event System - mb-create-discussion-thread-page-load|mb-create-discussion-thread-page-load]]
* [[Javascript Event System - mb-create-discussion-thread-before-submit|mb-create-discussion-thread-before-submit]]
== My Home ==
==== General ====
* [[Javascript Event System - my-home-page-page-load|my-home-page-page-load]]
==== Feeds ====
* [[Javascript Event System - my-home-page-before-load-feeds|my-home-page-before-load-feeds]]
* [[Javascript Event System - my-home-page-before-display-feed|my-home-page-before-display-feed]]
* [[Javascript Event System - my-home-page-feed-error|my-home-page-feed-error]]
* [[Javascript Event System - my-home-after-display-feed|my-home-after-display-feed]]
* [[Javascript Event System - my-home-page-after-load-feeds|my-home-page-after-load-feeds]]
== List Page ==
==== General ====
* [[Javascript Event System - list-page-load|list-page-load]]
* [[Javascript Event System - search-results-page-load|search-results-page-load]]
== Future Events ==
<span style="color:#CC2200;">'''Note''': The following list represents a sneak peak at some of the events that are slated for the next version of the KickApps platform. They may not be available in the current version of the KickApps platform, and are unsupported at this time.</span>
* [[Javascript Event System - custom-page-loaded|custom-page-loaded]]
[[category:Javascript API]] - Widget
- 1 day ago
- Views: 8
- Not yet rated
-
Retrieve Media Ratings Retrieve Media Ratings
- From: KristinS
-
Description:
== Overview ==
Retrieve media ratings issued by the member, or all ratings for the specific media id. Ratings on KickApps use a scale of 1 to 5, with 1 being the lowest (worst, negative) value and 5 being the highest (best, positive) value.
:'''NOTE''': Webmasters and editors get a rating multiplier of 10, meaning a rating from them of 3 stars would be stored as a value of 30 (3 x 10). Keep this in mind when seeing responses including ratings like 10, 20, 30, 40 or 50.
You can make an HTTP POST or GET request when using this call.
Your request will look something like the following:
<code>http://api.kickapps.com/rest/ratings/{mediaType}/{mediaId}/{as}</code>
== Parameters ==
As shown above, your call will include the following parameters:
* '''mediaType'''. The media type. audio, photo, blog, user, emedia, sets or video.
* '''mediaId'''. Integer. The id of the media to be rated. This is specific to both the affiliate site and the media's type.
* '''as'''. The site Id to search. as is unique for each of the affiliate's sites.
== Post Parameters ==
{{DefaultPostParameters}}
* '''userId'''. Optional. The numeric Id for a particular user. For example, pass a userId to see if the member has issued a rating for a certain video or on a certain affiliate site.
* '''url'''. Required only for the emedia mediaType.
== JSON Payload ==
On success, a payload that begins with "status":"1","error":"", containing the following for each media item the member rated that matches the search parameters.
* '''id'''. The numeric Id for the media.
* '''rated'''. The rating the member posted.
* '''ratedCount'''. The number of times the media was rated by the user.
* '''userId'''. The numeric if for the member who posted the media.
* '''lastRatedAt'''. A nested object stating when the media was last rated. All times are returned as Greenwich Mean Time (GMT) dayOfMonth month hour:minute:second GMT. This would appear as follows: "createdAt":"22 Feb 2008 02:07:19 GMT".
* '''numOfTimesRated'''. The number of times this media item was rated.
* '''name'''. The media’s title.
* '''pathToPreview'''. The path to the media preview for one of the following media types.
::{| cellpadding="20" cellspacing="0" border="1"
|video
|The file is transcoded and then five random screens are grabbed from the file. An affiliate can choose the preview image from among these screens, upload their own image, or use the default image.
|-
|photo
|A path to a thumbnail version of the image. This image was manually uploaded by the member and then automatically resized to for the thumbnail or is the default image.
|-
|audio
|A path either to a selected preview image loaded by the member or to the default image.
|}
* '''views'''. The number of times this media item was viewed. Increments each time the media item is viewed if the item is hosted by KickApps through Akamai.
* '''averageRating'''. The average rating calculated using all the ratings issued for this media.
* '''username'''. The username of the member who uploaded the media.
* '''pathToIcon'''. The path to the stored thumbnail for this media. - Widget
- 1 day ago
- Views: 4
- Not yet rated
-
How to do Nested Widgets How to do Nested Widgets
- From: KristinS
-
Description:
== This example shows how to use the KickApps [[Add Media Comment]] and [[Retrieve Comments]] REST API to handle nested comments. ==
<br/>
<code php>
<?php
/**
* This is a nested comment example.
* This comes as is, with no guarantees.
* This has no error checking and is only meant for a proof of concept
*
* @author Bill Van Pelt
* @copyright KickApps 2010
*
*/
/**
* KickApps Configuration Information
*/
$ka = array("as" => xxxxx,
"apiKey" => "xxxxxx",
"kaUserName" => "username",
"kaEmail" => "ka@email.com",
"kaSiteName" => "KA SiteName");
/**
* External Media URL. This is what we will be commenting on
*/
$url = "http://url/to/comment/on";
/**
* If the form is posted, add the comment
*/
if($_POST){
// Adds the comment then redirects back to the same URL we were just on.
addComment($url, $_POST['comment'], $_POST['parentThreadId']);
Header("Location: " . $_SERVER['PHP_SELF']);
}
/**
* Grabs the list of comments for the url we are commenting on
*/
$comments = getComments($url);
?>
</code>
<code html4strict>
<html>
<head>
<title>COMMENT THREADING</title>
<style>
body{
font-size: 13px;
font-family: verdana;
}
a {
font-size: 12px;
color: red;
text-decoration: none;
text-transform: lowercase;
}
ul{
padding: 4px;
margin-left: 20px;
margin-bottom: 5px;
list-style-type: square;
}
</style>
<script type="text/javascript">
function reply(id){
document.getElementById('parent').value = id;
document.getElementById('comment').focus();
}
</script>
</head>
<body>
</code>
<code php><?php echo printNestedComment(NULL, $comments); ?></code>
<code html4strict>
<hr/>
<form action="" method="POST">
<p>Comment:</p>
<textarea name="comment" id="comment" rows="10" cols="60"></textarea><br/>
<input type="submit" value="Submit" />
<input type="hidden" name="url" id="url" value="<?php echo $info->media->pathToMedia; ?>" />
<input type="hidden" name="parentThreadId" id="parent" value="" />
</form>
</body>
</html>
</code>
<code php>
<?php
/**
* KickApps create token API call.
* @global array $ka - KickApps configuration from above
* @return string - Token string
*/
function createToken(){
global $ka;
if(empty($SESSION['token'])){
$url = 'http://api.kickapps.com/rest/token/create/' . $ka['kaUserName'] . "/" . $ka['as'];
$ch = curl_init($url);
curl_setopt ($ch, CURLOPT_POST, 1);
curl_setopt ($ch, CURLOPT_POSTFIELDS, "developerKey=" . $ka['apiKey']);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$buf = curl_exec ($ch);
$arr = json_decode($buf);
$SESSION['token'] = $arr->TOKEN;
return $arr->TOKEN;
}else{
return $SESSION['token'];
}
}
/**
* Add the comment to a specific URL
* @global array $ka - KickApps configuration from above
* @param string $url - URL To comment on
* @param string $comment - Comment to add
* @param integer $parent - Parent Thread ID
* @return array
*/
function addComment($url, $comment, $parent = false){
global $ka;
$rest_url = "http://api.kickapps.com/rest/comment/add/v2/emedia/12345/" . $ka['as'];
$postFields = 't=' . createToken() . '&comment=' . $comment . "&url=" . $url . "&parentThreadId=" . $parent;
$ch = curl_init($rest_url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$buf = curl_exec ($ch);
curl_close ($ch);
return json_decode($buf);
}
/**
* Get comments for a URL
* @global array $ka - KickApps configuration from above
* @param $url - URL to get the comments for
* @return array of comments
*/
function getComments($url, $oldest = "F"){
global $ka;
$rest_url = 'http://api.kickapps.com/rest/comments/' . $ka['as'];
$postFields = 't=' . createToken() . '&url=' . $url . '&mediaType=emedia&userId=0&sortOldestFirst=' . $oldest;
$ch = curl_init($rest_url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$buf = curl_exec ($ch);
curl_close ($ch);
$c = json_decode($buf);
foreach ($c->results as $k => $comment) {
$arr[] = array('id' => $comment->commentId,
'parent_id' => $comment->parentThreadId,
'message' => $comment->body,
'created' => $comment->createdAt,
'createdBy' => $comment->createdByUsername);
}
return $arr;
}
/**
* Print the nested comments
* @param integer $parent - ID of the parent
* @param array $comments_array - Array of all comments
* @return string - HTML of output
*/
function printNestedComment($parent, $comments_array) {
foreach ($comments_array as $comment) {
if($parent == $comment['parent_id']) {
$html .= '<ul>' . "\n";
$html .= '<li>' . $comment['message'] . ' <b>at</b> <i>' . $comment['created'] . '</i> <b>by</b> <i>' . $comment['createdBy'] . '</i> - <a href="javascript:reply(\'' . $comment['id'] . '\');">Reply</a></li>' . "\n" ;
$html .= printNestedComment($comment['id'], $comments_array);
$html .= '</ul>' . "\n";
}
}
return $html;
}
</code>
<br/>
<b>Here is what this will output with a valid URL:</b><br/>
----
[[Image:Screen shot 2010-01-27 at 5.45.42 PM.PNG]]
[[category:Comments & Ratings]] - Widget
- 1 day ago
- Views: 9
- Not yet rated
-
Edit or Delete Comments Edit or Delete Comments
- From: KristinS
-
Description:
You can moderate comments in your community in two ways: you can review and moderate all comments in your community from one page, or you can browse to the details page for a specific media item or member and moderate the associated comments there.
To review and moderate comments in your community from the central comment moderation page,
- Log in to the Affiliate Center.
- Click the Manage tab, and then the Comments sub-tab.
To edit or delete comments on a particular member or media item from its details page,
- Log in to the Affiliate Center.
- Click the Manage tab.
- If the comment has been made on a media item, search for that media item on this page. If the comment was made on a member's profile page, click the Members tab in the subnav, and search for the member on that page.
- When you find the media item or member, click on his/her/its thumbnail or title/name.
- You'll land on the details page for the media item or member. Near the bottom of the left column on this page you'll find a list of comments.
- Click "edit" or "delete" to edit or delete a comment.
- Click Save.
[[category:Affiliate Center]][[category:Comments & Ratings]]
- Widget
- 1 day ago
- Views: 16
- Not yet rated
-
How To Make A Dropdown Box For How To Make A Dropdown Box For Categories
- From: KristinS
-
Description:
A couple of affiliates have asked us how to make a "Switch Category" dropdown box like the one that can be found on the <a mce_href="http://upload.youintroduce.bet.com/kickapps/service/searchEverything.kickAction?as=4140&mediaType=video&sortType=recent&tab=yes&includeVideo=on" href="http://upload.youintroduce.bet.com/kickapps/service/searchEverything.kickAction?as=4140&mediaType=video&sortType=recent&tab=yes&includeVideo=on">BET site</a>:
<p></p>
<img class="screenshotLg" mce_src="http://www.kickdeveloper.com/images/bet_dropdown.gif" src="http://www.kickdeveloper.com/images/bet_dropdown.gif"><hr id="system-readmore">
<p>
When users select a video category from this dropdown box, the page refreshes, returning a list page composed of videos that belong to the selected category. While we don't yet offer a pre-built dropdown box for media categories like this one, it's easy to build one yourself! Here's a brief tutorial based on the process that we used to make the one for BET:
</p>
<ol type="1">
<li>
Make the categories that you want to appear in this dropdown box in the <a mce_href="http://affiliate.kickapps.com/kickapps/user/displayAffiliateLoginPage.kickAction" target="_blank" title="KickApps Affiliate Center" href="http://affiliate.kickapps.com/kickapps/user/displayAffiliateLoginPage.kickAction">Affiliate Center</a>
under Configure > Media Categories.
</li>
<li>
Upload the media that you want to be accessible through your dropdown box, making sure to assign the proper category to each item.
</li>
<li>
After your media has been uploaded, pick an admin tag for each category.
</li>
<li>
Login to the Affiliate Center and browse to Manage > Media.
</li>
<li>
For each of the pending media items that you see displayed, click Details, and on the page that comes up, fill in the admin tag that you've picked for the category that this media item has been assigned to (you'll see the category on the left, a little beneath the admin tags box).
</li>
<li>
In the right column on the same page, check to make sure that the Approve radio button under Current Status is selected.
</li>
<li>
Click save.
</li>
<li>
Now all we need to do is build the HTML dropdown box and write the JavaScript that will drive it. Fortunately, I've taken care of that for you:
<br>
<br>
<pre xml:javascript=""> <script type="text/javascript">
function switchcat(categories){
var cat = (categories.options[categories.selectedIndex].value);
if(cat!==''){ window.location="/kickapps/service/searchEverything.kickAction?keywords="+cat+"
&as=AS_NUMBER&mediaType=MEDIA_TYPE_LOWERCASE&includeVideo=on";
}
}
</script>
<select name="categories" onChange="switchcat(this)" id="category_dropdown">
<option value="" selected>Pick A Category</option>
<option value="admintag1">Category1</option>
<option value="admintag2">Category2</option>
</select>
</pre>
</li>
<li>
Copy this code into your favorite text editor.
</li>
<li>
Replace "Category1" with the name of the first category that you created in Step 1. Replace "admintag1" with the name of the admin tag that you picked in Step 3. Repeat for the rest of the <option>s, and make as many new <option>s as you need to cover all of the categories that you want in your dropdown box.
</li>
<li>
Notice the very end of the window.location rule, where it says "&includeVideo=on". What this means is that this rule will pull up all of the videos that fall under the category that you select in the dropdown box.
If you'd rather have audio, photos, blogs, members, or groups instead of videos, replace &includeVideo=on with &includeAudio=on, &includePhoto=on, &includeBlog=on, &includeUser=on, or &includeGroups=on. If you'd like to pull up any combination of these media types, you can append any of these terms to the end of the rule.
</li>
<li>
Once you've modified this code to your satisfaction, log back into the Affiliate Center and navigate to Configure > Pages > Global Page Template.
</li>
<li>
Paste the code you just modified into the <head></head> section.
</li>
<li>
Click save.
</li>
<li>
View your site. You now have a BET-style dropdown box.
</li>
</ol>
<p>
Did you enjoy this tutorial? Have questions, comments, or want to submit one of your own? <a mce_href="http://www.kickdeveloper.com/support/index.php" href="http://www.kickdeveloper.com/support/index.php">Contact us at support@kickapps.com</a>.</p>
[[category:Page Customization]] - Widget
- 1 day ago
- Views: 3
- Not yet rated
-
Add Blog Post Add Blog Post
- From: KristinS
-
Description:
Blogs use a different data structure within the KickApps platform and as a result the API uses a slightly different URI:
<code>http://api.kickapps.com/rest/blog/save/add/{as}</code>
We use “add” instead of “upload” because this call doesn’t include a media file upload – only textual data is being sent to the server.
==Parameters==
* '''as'''. The affiliate site that the media will be associated with. Each affiliate site has a unique as.
==Post Parameters==
{{DefaultPostParameters}}
* '''name'''. Required. The name for this media. Max length 125 characters.
* '''description'''. Optional. The body text for the blog that is being added.
* '''tags'''. One or more comma-separated keyword tags. Enclose multi-word tags inside quotations ("tag tag",tag). You can also add tags to an existing media item using the separate Add Tags call.
Each mediaId can have a maximum of 512 characters of associated tags, including the commas that separate each tag. Each tag must not be longer than 20 characters, not including the commas that separate each tag. Use URL-encoded space characters (%20) to create spaces between words. Tags cannot include special characters, only letters, numbers, and spaces.
* '''adminTags'''. One or more comma-separated tags. You must be logged in as an administrator in order to add admin tags. Enclose multi-word tags inside quotations ("tag tag",tag). Each mediaId can have a maximum of 512 characters of associated tags, including the commas that separate each tag. Each tag must not be longer than 20 characters, not including the commas that separate each tag. Use URL-encoded space characters (%20) to create spaces between words. Tags cannot include special characters, only letters, numbers, and spaces.
* '''category'''. Optional. Up to three levels of categories that members can use to find this media, written in the following format level1name/level2name/level3name. Level names should be preexisting categories for this site. An error will be returned if you try to add a category that does not already exist.
* '''country'''. The member's country. The values in your upload form must exactly match those used by KickApps.
If country is 1 for the United States of America, 2 for Canada, or 15 for Australia, the value for the Zip or Postal Code field will also be validated.
* '''state'''. The abbreviation for the member's state. The value selected in the upload form will correspond to those shown on this page: [[Geographic Values for Media Uploads]].
* '''stateOrProvince'''. The abbreviation for the member's province. The value selected in the upload form will correspond to those shown on this page: [[Geographic Values for Media Uploads]].
* '''AusState'''. The abbreviation for the member's state. The value selected in the upload form will correspond to those shown on this page: [[Geographic Values for Media Uploads]]
* '''otherStateOrProvince'''. The abbreviation for the member's state or province if country is not 1 for the United States of America, 2 for Canada, or 15 for Australia. Zip and postal codes are not validated for these values.
* '''city'''. The member's city. The max character length for this field is 128 characters.
* '''zipcode'''. The member's zip or postal code. The max character length for this field is 32 characters. If country is 1 for the United States of America, 2 for Canada, or 15 for Australia, the value for the Zip or Postal Code field will also be validated.
* '''updatedAt'''. Optional. The date on which the media should be marked as modified. If its not passed the the time this call is made will be used. Format: mm/dd/yyyy hh:mm
*'''createdAt'''. Optional. The date on which the media should be marked as created. If its not passed the the time this call is made will be used. Format: mm/dd/yyyy hh:mm
* '''isPrivacyEnabled'''. True or False. True if the media is private. False if media is public.
* '''isAddToMediaSetAllowed'''. True or False. True if other community members can add this media to their sets. False if other community members are not permitted to add this media to their sets.
*'''allowPublicTagging'''. true or false. Whether members can tag this media.
*'''allowPublicCommenting'''. true or false. Default is true. By default, form is set to true. Whether members can comment on this media.
* '''status'''. Optional. active or pending. To bypass the moderation settings and post media as active i.e. available on site immidiately set the status to be "active. To add the media as pending for webmaster approval set status to be "pending". If no value is passed the media will be given a status based on the default moderation settings. This param can only be accessed by the webmaster or the editor.
==Payload==
On success, a return that begins with "status":1 and the mediaId of the blog that was added.
<code>{"payload_type":"json","status":1,"error":"","mediaId":2573559}</code>
{{Categorize by apps}}
[[Category:REST]] - Widget
- 1 day ago
- Views: 7
- Not yet rated
-
Audio Player Audio Player
- From: KristinS
-
Description:
The audio player can play files in the following formats:
* <tt>.mp3</tt>
* <tt>.flv</tt>
The audio player can be a bit tricky to understand at first because its visual representation is hidden by default in the Advanced Audio Player template. To find it, click on "Audio Player Component 1" in the Layers panel.
Though the audio player can be used without any controls by having its '''Play on load''' setting enabled, it is typically operated by a '''scrubber''', '''volume control''', and buttons programmed (via [[Events and Actions#Audio_Component | Events]] and [[Events and Actions#Audio_Component_2 | Actions]]) to play, pause, and change to the previous and next audio tracks in the audio player's feed or playlist.
[[Image:AudioComponent.png| border]]
==Properties==
; Scrubber
: Select a [[Scrubber | Scrubber]] component from the dropdown. If the dropdown is empty, add a Scrubber to your widget by dragging a Scrubber component from the Components panel on the left.
; Volume Control
: Select a [[Volume Control | Volume Control]] component from the dropdown. If the dropdown is empty, add a Volume Control to your widget by dragging a Volume Control component from the Components panel on the left.
; Playback Options
::;Play on load
:::Start playing the first track when the player loads.
::;Auto-play
:::When one track ends, play the next track in the feed/playlist.
::;Auto-advance
:::When a track ends, advance to the next track in the feed/playlist.
==Content==
* Feed
** Pick a previously saved feed from the dropdown, or enter the URL to an mRSS feed, <tt>.mp3</tt>, or <tt>.flv</tt> file.
* Playlist
** Select audio tracks from your KickApps library to compose a playlist
==Background & Border==
;Background Colors
:Choose two different colors to create a gradient or, for a solid color, choose the same color in both options.
;Background Opacities
:Set the opacity of the top and bottom halves of the audio component. Accepts integer values from 0 (transparent) to 100 (opaque).
;Highlight Opacities
:Create a highlight effect by altering the opacity of the first and second quarters of the component.
;Icon Color
:Choose the color for the audio component's icon.
;Border Color
:Choose the color of the audio component's border.
;Border Thickness
:Set the thickness of the audio component's border.
==Layout==
{{Layout Panel}}
==Events==
{{Standard Events}}
===Audio Player Events===
{{Audio Component Events}}
==Actions==
{{Standard Actions}}
===Audio Player Actions===
{{Audio Component Actions}}
[[Category:Widgets & Video Players]] - Widget
- 1 day ago
- Views: 5
- Not yet rated
-
Advertising Plug-Ins Advertising Plug-Ins
- From: KristinS
-
Description:
App Studio Advertising Plug-Ins enable you to run ads in your video players from a number of ad networks and other ad providers. This list is always growing, so please [http://www.kickapps.com/contact-us/index.php contact us] if you need support for an ad provider that's not listed here.
=Run ads in your video player=
To run ads in a video player, drag one of the Advertising Plug-Ins from the Advertising panel onto your video player. You can then configure the advertising in the ad plug-in's properties panel, which will appear in the right column of the App Studio. Details on configuring each Advertising Plug-In are available below.
=Disable player controls during ad playback=
You probably don't want player controls to be functional while an ad is playing (so that the user can skip the ad, play another video over the ad, etc.). To effectively disable the rest of your widget while a video ad is running, we recommend the following:
# Create [[Rectangle|rectangle components]] that cover your entire widget area except for the video player.
# Set all of them to transparent by turning down the opacity control at the top right of the stage to 0.
# [[Containers_and_Layout_Constraints|Group these rectangles into a new Container component]].
# Move this Container to the top [[Layers|layer]] of your widget.
# Use the video player's [[Actions#Video_Component|"Video ad start" and "Video ad end" events]] to trigger a show/hide actions on this Container.
=Advertising Plug-Ins=
==24/7 OAS==
Our 24/7 Advertising Plug-In supports the following features:
* In-stream '''video ads''' that can be played before, after, or at any point during the playback of the current video.
* Run an unlimited number of '''video ads''' before, after, or at any point during the playback of a content video
** Click-through URL available on each video ad
** Video ad tags are applied to a video player with a frequency setting to determine how many content videos will play between each video ad slot (i.e., 'play 2 videos between each ad slot')
* 5 different slots for '''companion ads'''. When the player receives the XML from 24/7 it will pass an array of companion ad objects for each of these slots to a JS function on the page called <tt>KATwentyFourSevenCompanionAd</tt>. The JS objects will look like this:
::<code javascript>
{position, width, height, imageURL, clickURL, title}
</code>
* Tracking tags for
** user clicked on video ad
** video ad start
** video ad middle
** video ad end
* Video player can pass the ID of the current video to 24/7 if you include <tt>[mediaId]</tt> in your ad tag, like so:
::<code html4strict>
http://oascentral.blahblahblah/RealMedia/ads/adstream_sx.ads/blahblahblah/blah?mediaid=[mediaId]
</code>
To use the 24/7 advertising plug-in,
# Configure your 24/7 account to output XML in the following format:<br /> <code xml>
<?xml version="1.0" encoding="UTF-8"?>
<!-- 24/7 Real Media XML Template for KickApps Widget -->
<!-- Last Update : 02/10/2009 -->
<VideoXML>
<!-- URL to count XML download -->
<CoD_URL/>
<Keyword/>
<!-- Instream Ad Setup Begins -->
<Playlist>
<!-- Pre-roll Setup Begins -->
<!-- duration = length in sec, playafter = delay in sec -->
<Track id="" duration="" playafter="">
<!-- Pre-roll URL-->
<videoURL/>
<!-- Video click-through URL -->
<videoClickURL/>
<!-- URL to count click-throughs -->
<TrackVideoClickURL/>
<!-- URL to count pre-roll start -->
<TrackStartURL/>
<!-- URL to count pre-roll mid -->
<TrackMidURL/>
<!-- URL to count pre-roll end -->
<TrackEndURL/>
</Track>
<!-- Pre-roll Setup Ends -->
<Track id="" duration="" playafter="">
<videoURL/>
<videoClickURL/>
<TrackStartURL/>
<TrackMidURL/>
<TrackEndURL/>
</Track>
</Playlist>
<!-- Instream Ad Setup Ends -->
<CompanionAd position="sponsor" width="" height="">
<ImageURL/>
<ClickURL/>
<Title/>
</CompanionAd>
<!-- Top Companion Ad Begins -->
<CompanionAd position="top" width="" height="">
<ImageURL/>
<ClickURL/>
<Title/>
</CompanionAd>
<!-- Top Companion Ad Ends -->
<!-- Right Companion Ad Begins -->
<CompanionAd position="right" width="" height="">
<ImageURL/>
<ClickURL/>
<Title/>
</CompanionAd>
<!-- Right Companion Ad Ends -->
<!-- Bottom Companion Ad Begins -->
<CompanionAd position="bottom" width="" height="">
<ImageURL/>
<ClickURL/>
<Title/>
</CompanionAd>
<!-- Bottom Companion Ad Ends -->
<!-- Left Companion Ad Begins -->
<CompanionAd position="left" width="" height="">
<ImageURL/>
<ClickURL/>
<Title/>
</CompanionAd>
<!-- Left Companion Ad Ends -->
</VideoXML></code>
# In the App Studio, drag and drop the 24/7 plug-in from the Advertising panel onto your video player.
# Generate a 24/7 ad tag URL that will return XML in the format above. Paste that tag into the 24/7 properties panel at the top of the rightmost column.
'''Sample ad tag'''
<code html4strict>
http://flexonrails.net/bits/twofourseven.xml
</code>
==Adap.tv==
# Drag the adap.tv plug-in onto your video player.
# Enter your Publisher ID in the adap.tv properties panel at the top of the rightmost column and click Apply.
# Ensure that the "Adap.tv ads enabled" checkbox is selected.
==Atlas==
Microsoft Atlas is built on the [http://www.iab.net/vast VAST] IAB ad standard, so you can use this plug-in to run any VAST-compliant ads, not just those delivered by Microsoft.
To use the Atlas plug-in,
# Drag the Atlas plug-in from the Advertising panel onto your video player.
# Enter one or more ad tags in the Atlas properties panel at the top of the rightmost column.
* Pre-roll and Post-roll tabs
** Select the Pre-roll tab to define pre-roll ads to be run before content videos in the selected video player; Select the Post-roll ad to define post-roll ads to be run after content videos in the selected video player.
* Frequency
** Define how many content videos should play before a pre- or post-roll ad.
* Plus sign icon
** Click the plus sign icon to define a new pre- or post-roll ad
* Tag URL
** Enter the Atlas ad tag URL that will return your video ad.
* Trash can icon
** To delete an ad, click a row in the list above, then click this icon.
'''Please note:''' If you enter '''multiple pre- or post-roll ads''', the plug-in will '''randomly''' select one ad from your list of ads when it needs to make an ad request.
'''Sample Atlas ad tag'''
<code html4strict>
http://api.atdmt.com/adserv.api/viewad/sa=ndgtrpnb0110000195ado;sf=VAST_PreRoll_XML_V2;pf=FLV;br=500;strm=1
</code>
'''Passing the ID of the current video to Atlas or another VAST-compliant ad server'''
The KickApps video player can pass the ID of the current video in with your ad request if you include <tt>[mediaId]</tt> in your ad tag, like so:
<code html4strict>
http://api.atdmt.com/adserv.api/viewad/sa=ndgtrpnbado;sf=VAST_PreRoll_XML_V2;pf=FLV;br=500;strm=1?mediaid=[mediaId]
</code>
==DoubleClick for Publishers==
# Drag the DoubleClick plug-in from the Advertising panel onto your video player.
# Enter one or more ad tags in the DoubleClick properties panel at the top of the rightmost column.
* Pre-roll and Post-roll
** Select the Pre-roll tab to define pre-roll ads to be run before content videos in the selected video player; Select the Post-roll ad to define post-roll ads to be run after content videos in the selected video player.
* Frequency
** Define how many content videos should play before a pre- or post-roll ad.
* Plus sign icon
** Click the plus sign icon to define a new pre- or post-roll ad
* Tag URL
** Enter the DoubleClick ad tag URL that will return your video ad.
* Companion
** Enter the URL to a companion display ad. Just before the Doubleclick plug-in plays the video ad that corresponds to this companion ad, it will make this companion ad URL available to a JavaScript function on the page on which the player is embedded.
* Trash can icon
** To delete an ad, click a row in the list above, then click this icon.
'''Please note:''' If you enter '''multiple pre- or post-roll ads''', the plug-in will '''randomly''' select one ad from your list of ads when it needs to make an ad request.
==Google AdSense for Video==
# Drag the Google plug-in from the Advertising panel onto your video player.
# Enter your Pub ID, Host, and Channel in the Google properties panel at the top of the rightmost column and click Apply.
# Ensure that the "Google ads enabled" checkbox is selected.
==Scanscout==
# Drag the Scanscout plug-in onto your video player.
# Enter your Publisher ID in the Scanscout properties panel at the top of the rightmost column and click Apply.
# Ensure that the "Scanscout ads enabled" checkbox is selected.
==Pre-roll==
The Pre-roll Advertising Plug-In enables you to run pre-roll ads against the videos in the selected video player. You define a pre-roll ad by entering a video URL for the ad, and, optionally, a click-through URL.
* Frequency
** Define how many content videos should play in your player before a pre-roll ad should play.
* Video
** Enter a URL of your video ad. The URL should return an <tt>.flv</tt>, <tt>.mp4</tt>, <tt>.mov</tt>, <tt>.m4v</tt>, or <tt>rtmp</tt> stream.
* Link
** Enter a URL for use as a click-through link. When viewers click on the video player while the corresponding pre-roll ad is playing, they will be redirected to this URL.
'''Please note:''' If you enter '''multiple pre- or post-roll ads''', the plug-in will '''randomly''' select one ad from your list of ads when it needs to make an ad request.
You can also use the [http://www.kickdeveloper.com/api/index.php/Events_and_Actions#Video_Component "video ad start" and "video ad end" events] to trigger other behavior, like requesting a tracking pixel before and after your ad runs.
==Post-roll==
The Post-roll Advertising Plug-In enables you to run post-roll ads against the videos in the selected video player. You define a post-roll ad by entering a video URL for the ad, and, optionally, a click-through URL.
* Frequency
** Define how many content videos should play in your player before a post-roll ad should play.
* Video
** Enter a URL of your video ad. The URL should return an <tt>.flv</tt>, <tt>.mp4</tt>, <tt>.mov</tt>, <tt>.m4v</tt>, or <tt>rtmp</tt> stream.
* Link
** Enter a URL for use as a click-through link. When viewers click on the video player while the corresponding post-roll ad is playing, they will be redirected to this URL.
'''Please note:''' If you enter '''multiple pre- or post-roll ads''', the plug-in will '''randomly''' select one ad from your list of ads when it needs to make an ad request.
You can also use the [http://www.kickdeveloper.com/api/index.php/Events_and_Actions#Video_Component "video ad start" and "video ad end" events] to trigger other behavior, like requesting a tracking pixel before and after your ad runs.
[[Category: Widgets & Video Players]] - Widget
- 1 day ago
- Views: 4
- Not yet rated
-
Advertising in KickApps Video Advertising in KickApps Video Players
- From: KristinS
-
Description:
==Overview==
KickApps video players have built in support for video ads from the following ad networks and ad servers, right out of the box:
* DoubleClick
* Atlas (Microsoft)
* Google AdSense for Video
* 24/7 Realmedia Open Ad Server (OAS)
* ScanScout
* Adap.tv
In addition, we also offer generic pre- and post-roll ad components that you can use to run any .flv as an ad in your video players.
==How to run ads in your video players==
To run an ad in a video player,
# Log in to the Affiliate Center and click the App Studio tab.
# Click the Players tab and drag a video player to the stage.
# Click the Advertising tab and drag and drop the advertising component you'd like to use onto your video player (make sure there's not another component on top of your video player; if there is, hide it by clicking on it and then clicking the eye icon next to its listing in the Layers panel).
# You'll see a properties panel for your ad component. Enter your Account ID and/or your desired ad URLs into this panel, if the panel includes these options. Note, in the DoubleClick panel, the "companion" column can be used to specify any companion banner ads that you’d like to be displayed in concert with the pre- or post-roll ad on the page that the widget is installed on. (Get the companion ad URLs from DoubleClick.)
# Some ad components also let you control how frequently you'd like the pre- and/or post-roll ads to be played. This setting refers to the number of videos that should play before the player should play an ad from the service and/or URL you've entered. The DoubleClick and Atlas ad components also let you enter as many pre- and post-roll ad URLs as you please (click the plus sign icon). The ads in these pre- and post-roll lists will be played at random.
That's it! Switch to Preview mode to confirm your settings. Note that you'll only see an ad if the ad provider returns one; depending on the keywords of your content and a number of other factors, they don't always do this. If you think there's a problem, you can confirm that the player is in fact making the request to your ad provider by viewing the http requests under the Net tab in [http://getfirebug.com | Firebug].
==Running ads from 24/7 Real Media's Open AdStream (OAS)==
To run a video ad campaign with 24/7 OAS, set-up your OAS account to return XML in the pattern below. <tt><Track></tt> nodes define video ads. You can add as many as you please. Within the <tt><Track></tt> node, <tt>duration</tt> refers to the length of the video ad in seconds and <tt>playafter</tt> refers to how many seconds of content video playback should occur before this video ad begins playing. Nodes within the <tt><Track></tt> node are populated by URLs for the video ad creative, click-through URL, and tracking pixels.
The KickApps video player will request ad XML from 24/7 before each video in its feed or playlist, so each <tt><Track></tt> in the 24/7 XML's <tt><Playlist></tt> node will apply only to the content video that the video player is currently playing.
<code xml>
<?xml version="1.0" encoding="utf-8"?>
<VideoXML>
<CoD_URL></CoD_URL>
<Keyword>%%QUERY%%</Keyword>
<Playlist>
<Track id="..." duration="30" playafter="1">
<videoURL>...</videoURL>
<videoClickURL>...</videoClickURL>
<TrackStartURL>...</TrackStartURL>
<TrackMidURL>...</TrackMidURL>
<TrackEndURL>...</TrackEndURL>
</Track>
</Playlist>
</VideoXML>
</xml>
</code>
==Advertising Screencast==
<object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" codebase="http://fpdownload.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,0,0" width="420" height="338" id="kickWidget_764_27226" ><param name="movie" value="http://serve.a-widget.com/service/getWidgetSwf.kickAction"></param><param name="FlashVars" value="affiliateSiteId=764&widgetId=27226&width=420&height=338&autoPlay=0&kaShare=1&mediaType_mediaID=video_355462" ></param><param name="wmode" value="window" ></param><param name="allowFullScreen" value="true" ></param><param name="allowScriptAccess" value="always" ></param><embed src="http://serve.a-widget.com/service/getWidgetSwf.kickAction" name="kickWidget_764_27226" width="420" height="338" pluginspage="http://www.macromedia.com/go/getflashplayer" type="application/x-shockwave-flash" wmode="window" allowScriptAccess="always" allowFullScreen="true" FlashVars="affiliateSiteId=764&widgetId=27226&width=420&height=338&autoPlay=0&kaShare=1&mediaType_mediaID=video_355462"></embed></object>
[[Category:Widgets & Video Players]]
[[Category:Advertising]] - Widget
- 1 day ago
- Views: 16
- Not yet rated