Gigya Job Openings

comments.analyzeMediaItem JS

Skip to end of metadata
Go to start of metadata

Description

The method analyzes the attached URL (or URLs) and returns the media item information.
 

Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer to

REST API > comments.analyzeMediaItems.

 

Syntax

 

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
categoryIDstringThe identifier of the comments category from which to analyze the media item/s.
urlsstringA comma-separated URLs of a media items embedded in the comments.

 

Response Object Data Members

FieldTypeDescription
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Response Codes and Errors table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
callId string Unique identifier of the transaction, for debugging purposes.
context object The context object passed by the application as a parameter to the API method, or null if no context object has been passed.
mediaItemsArray of objectsAn array of the embedded media, each with the following fields:
  • provider - the provider name, in lowercase
  • type - the content type - may be "video", "image" or "rich"
  • title - the title given to the media item
  • description - the description given to the media item
  • html - an auto playing HTML embed
  • width - the width of the  media item
  • height - the height of media item
  • thumbnailUrl - the thumbnail URL of the media item
  • thumbnailWidth the width of the thumbnail URL of the media item
  • thumbnailHeight the height of the thumbnail URL of the media item
  • providerIconUrl - the URL of the provider of the media item

 

Code Sample

function printResponse(response) {  
    if ( response.errorCode == 0 ) {             
        if ( null!=response.mediaItems&& response.mediaItems.length>0) {        
            var msg = "The first 3 media items are titled:\n\n";   
            for (var index in response.mediaItems) {     
                   msg += "Media item " + index + ": " + response.mediaItems[index].title + "\n\n"<font>;
            }
            </font>alert(msg);
        }
        else {
            alert('No media items were returned');
        }
    } else {
        alert('Error :' + response.errorMessage);
    }
};

var params = {
    categoryID: "12345",
    urls:"http://vimeo.com/80209061"
};

gigya.comments.analyzeMediaItem(params); 

Notes:

  • This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
  • To run the code on your own domain, add your Gigya API key to the gigya.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.
  • In some cases it is necessary to connect/login the user to a provider ? prior to calling the API method. You can learn more in the Social Login guide.