Gigya Job Openings

Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

RequiredField NameTypeDescription
Yes
categoryIDstringThe identifier of the comments category to which the stream of discussion belongs.
Yes
streamIDstringThe unique ID of the stream to which you would like to set information. Note: the string is limited to 150 characters and is case-sensitive.
Yes
IDstringThe unique identifier for the comment.
Varies
commentTextstringThe message body of a comment. The text may be maximum 5,000 characters long.
* This parameter is Required given the following conditions:
  • If you are posting to a categoryID that is defined with 'Operation mode: Rating & Reviews'.
  • And, in the Comments Settings of the relevant categoryID, 'Enable Comment Body:' is set to 'Show' and ‘Required.
  • Or, the parentID parameter is specified (i.e. you are posting a comment to a review).

In any other case the commentText is irrelevant and is ignored.

Varies
commentTitlestringA title for the comment. The title may be maximum 250 characters long.
* This parameter is Required given the following conditions:
  • If you are posting to a categoryID that is defined with 'Operation mode: Rating & Reviews'.
  • And, in the Comments Settings of the relevant categoryID, 'Enable Comment Titles:' is set to 'Enable'.
  • And, the parentID parameter is not specified (i.e. you are posting a Review and not a comment to a review).

In any other case the commentTitle is irrelevant and is ignored.

Varies
ratingsJSON objectAn object that defines user ratings for this stream. The object structure is: {"_overall": ratingValue, "dim1ID": dim1RatingValue}, where the ratingValue and dim1RatingValue are integers between 1-5, and dim1 is the ID of a ratings dimension defined in the category settings.
* This parameter is Required given the following conditions:
  • If you are posting to a categoryID that is defined with 'Operation mode: Rating & Reviews'.
  • And, in the Comments Settings of the relevant categoryID, 'Enable Ratings:' is set to 'Enable'.
  • And, the parentID parameter is not specified (i.e. you are posting a Review and not a comment to a review).

In any other case the ratings is irrelevant and is ignored.
Note: Rating a stream is permitted only for a logged in user, which hasn't rated this stream before (each user may rate each stream only once). This method will return an error to a forbidden rating attempt.

Varies
UIDstringThe unique ID of a logged-in user, with which this method call is associated. See User.UID for more information. If the user is not a guest (guestName parameter is not defined) this field is Required

Note: If you are using account linking then the UID would be your site user ID. To learn more about Social Login with account linking (best practice), please refer to the Login Implementation guide.

Varies
guestNamestringGuest user name. This field is relevant if the user who posted this comment is a guest user, in which case this field is Required.
Varies
guestEmailstringGuest user email. This field is relevant if the user who posted this comment is a guest user, in which case this field is Required.
No
parentIDstringThe identifier of the parent comment. In case this comment is a reply to another comment, this field is the ID of the comment to which this comment replies.
No
cidstringA string of maximum 100 characters length. This string is associated with each transaction and will later appear on reports generated by Gigya in the "Context ID" combo box. The cid allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. The "Context ID" combo box lets you filter the report data by site/application context.
No
tagsarrayThis parameter is a strings array representing a list of tags, e.g.: ["tag_a","tag_b"]. Each tag in the array is assigned to the posted comment. Tags can be used to filter comments when calling comments.getComments, to get only comments that match the tag.
No
statestringThe state of the comments for import. The optional values for this parameter are: 'approved' (default), 'pending', or 'rejected'.
No
createDateintegerThe date the comment was created as a unix timestamp in milliseconds.
No
ipstringThe IP address from which the comment was posted.
No
photoURLstringThe photo of the commenter.
No
profileURLstringThe profile URL of the commenter.

 

...