VOD PUBLICATION DETAILS¶
The details
property exists for each Vod Publication and differs per Target.
- Add objects can be used to represent the initial data sent into the system when Creating.
- Update objects can be used to represent the updated data sent into the system when Updating.
- View objects are returned inside of the PublicationModel, most of these values will be null unless
queryTarget
is set toTrue
.
Facebook¶
Add Details¶
{
"fb_title": "Post Title",
"fb_description": "Post Description",
"fb_noStory": true,
"fb_embeddable": true,
"fb_unpublishedContentType": null,
"publishAt": null,
"callbackUrls": [
"http://my-callback-url.com/Publication/Update"
]
}
Permitted values for fb_unpublishedContentType
: refer to Facebook’s video documentation
PublishAt should be an ISO8601 date time string. If not provided then the video will Publish as soon as possible.
If PublishAt is within 10 minutes of the completed upload, then this value will be pushed back. This is a requirement on Facebook’s side.
Required: none.
Update Details¶
{
"fb_contentCategory": "",
"fb_description": "",
"fb_expireAt": "2019-05-19T17:00:00Z",
"fb_expirationType": "expire_only",
"fb_expireNow": false,
"fb_embeddable": false,
"fb_name": "videoName",
"publishAt": null,
"callbackUrls": [
"http://my-callback-url.com/Publication/Update"
]
}
Permitted values for expiration type: expire_and_delete
, expire_only
Permitted values for fb_contentCategory
: please refer to Facebook’s video documentation
View Details¶
{
"fb_title": "Post Title",
"fb_description": "Post Description",
"fb_embeddable": true,
"fb_noStory": true,
"fb_videoId": "2147581300458",
"publishAt": null,
"published": true,
"link": "...",
"embedHtml": "...",
"isUnavailable": false
}
YouTube¶
Add Details¶
{
"yt_title": "YouTube Video",
"yt_description": "YouTube Description",
"yt_tags": [
"tag1"
],
"yt_categoryId": 1,
"yt_defaultAudioLanguage": "en",
"yt_defaultLanguage": "en",
"yt_embeddable": true,
"yt_license": "YouTube",
"yt_privacyStatus": "Unlisted",
"yt_publicStats": false,
"yt_recordingDate": "2019-05-19T12:00:00Z",
"publishAt": null,
"callbackUrls": [
"http://my-callback-url.com/Publication/Update"
]
}
Permitted values for privacy status: Public
, Private
, Unlisted
Permitted values for license: CreativeCommon
, YouTube
Permitted values for yt_categoryId
can be obtained from the metadata API.
PublishAt should be an ISO8601 date time string. If not provided then the video will Publish as soon as possible.
Update Details¶
{
"yt_title": "YouTube Video",
"yt_description": "YouTube Description",
"yt_tags": [
"tag1"
],
"yt_categoryId": 1,
"yt_defaultAudioLanguage": "en",
"yt_defaultLanguage": "en",
"yt_embeddable": true,
"yt_license": "YouTube",
"yt_privacyStatus": "Unlisted",
"yt_publicStats": false,
"yt_recordingDate": "2019-05-19T12:00:00Z",
"publishAt": null,
"callbackUrls": [
"http://my-callback-url.com/Publication/Update"
]
}
View Details¶
{
"yt_title": "YouTube Video",
"yt_description": "YouTube Description",
"yt_tags": [
"tag1"
],
"yt_categoryId": 1,
"yt_defaultAudioLanguage": "en",
"yt_defaultLanguage": "en",
"yt_embeddable": true,
"yt_license": "YouTube",
"yt_privacyStatus": "Unlisted",
"yt_publicStats": false,
"yt_recordingDate": "2019-05-19T12:00:00Z",
"callbackUrls": [
"http://my-callback-url.com/Publication/Update"
],
"yt_videoId": "16985713",
"publishAt": null,
"published": true,
"link": "...",
"embedHtml": "...",
"isUnavailable": false
}
Twitter¶
Add Details¶
{
"tw_status": "Example Tweet content to be Published",
"publishAt": null,
"callbackUrls": [
"http://my-callback-url.com/Publication/Update"
]
}
Required: tw_status
PublishAt should be an ISO8601 date time string. If not provided then the video will Publish as soon as possible.
Update Details¶
{
"tw_status": "Example Tweet content to be Edited",
"publishAt": null,
"callbackUrls": [
"http://my-callback-url.com/Publication/Update"
]
}
Required: tw_status
If the provided tw_status
matches the existing text, no update will be performed.
View Details¶
{
"tw_title": "Example Tweet content here.",
"tw_mediaId": "...",
"tw_tweetId": "...",
"publishAt": null,
"published": true,
"link": "...",
"embedHtml": "...",
"isUnavailable": false
}