VOD PUBLICATION DETAILS


The details property differs per Target and is specified below.

  • 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 can be returned inside of the PublicationModel, however, most values will be null unless the queryTarget parameter is set to True.

Shared

Shared properties can exist on the details object. These can be identified by the lack of a prefix (i.e. fb_, yt_, etc.).

This is useful for working with properties that do not need to respect the Target, such as embedHtml or link. Shared properties are not required to exist on every Publication type.

The isUnavailable property signals if the MediaSyndication platform could not find the VOD on the social media site. This will usually be because it is not yet uploaded, but can be that the video is deleted from the platform itself.

Facebook

Add Details

{
    "fb_title": "Post Title",
    "fb_description": "Post Description",
    "fb_noStory": true,
    "fb_embeddable": true,
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

Required: fb_title, fb_description

Update Details

{
    "fb_title": "Post Title",
    "fb_description": "Post Description",
    "fb_noStory": true,
    "fb_embeddable": true,
    "fb_videoId": "21419540",
    "fb_contentCategory": "",
    "fb_expiration": "2019-05-19T17:00:00Z",
    "fb_expirationType": "expire_only",
    "fb_expireNow": true,
    "fb_publishTime": "2019-05-19T12:45:00Z",
    "fb_contentTags": [
        "tag1"
    ],
    "fb_customLabels": [
        "label1"
    ],
    "fb_name": "videoName",
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

Permitted values for expiration type: expire_and_delete, expire_only

Permitted values for content category: 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",
    "link": "...",
    "embedHtml": "...",
    "isUnavailable": false
}

YouTube

Add Details

{
    "yt_title": "YouTube Video",
    "yt_description": "YouTube Description",
    "yt_privacyStatus": "unlisted",
    "yt_ingestionType": "rtmp",
    "yt_tags": [
        "tag1"
    ],
    "yt_categoryId": 1,
    "yt_defaultAudioLanguage": "",
    "yt_defaultLanguage": null,
    "yt_embeddable": true,
    "yt_license": "youTube",
    "yt_privacyStatus": "unlisted",
    "yt_publicStats": false,
    "yt_publishTime": "2019-05-19T12:45:00Z",
    "yt_recordingDate": "2019-05-19T12:00:00Z",
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

Required: yt_title, yt_description, yt_categoryId, yt_privacyStatus, yt_license

Permitted values for privacy status: public, private, unlisted

Permitted values for license: creativeCommon, youTube

Permitted values for category id can be obtains from the metadata API for permitted values.

Update Details

{
    "yt_title": "YouTube Video",
    "yt_description": "YouTube Description",
    "yt_privacyStatus": "unlisted",
    "yt_ingestionType": "rtmp",
    "yt_tags": [
        "tag1"
    ],
    "yt_categoryId": 1,
    "yt_defaultAudioLanguage": "",
    "yt_defaultLanguage": null,
    "yt_embeddable": true,
    "yt_license": "youTube",
    "yt_privacyStatus": "unlisted",
    "yt_publicStats": false,
    "yt_publishTime": "2019-05-19T12:45:00Z",
    "yt_recordingDate": "2019-05-19T12:00:00Z",
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

View Details

{
"yt_title": "YouTube Video",
    "yt_description": "YouTube Description",
    "yt_privacyStatus": "unlisted",
    "yt_ingestionType": "rtmp",
    "yt_tags": [
        "tag1"
    ],
    "yt_videoId": "16985713",
    "yt_categoryId": 1,
    "yt_defaultAudioLanguage": "",
    "yt_defaultLanguage": null,
    "yt_embeddable": true,
    "yt_license": "youTube",
    "yt_privacyStatus": "unlisted",
    "yt_publicStats": false,
    "yt_publishTime": "2019-05-19T12:45:00Z",
    "yt_recordingDate": "2019-05-19T12:00:00Z",
    "link": "...",
    "embedHtml": "...",
    "isUnavailable": false
}

Twitter

Add Details

{
    "tw_title": "My Tweet content here.",
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

Required: tw_title

Permitted values for privacy status: public, private, unlisted

Permitted values for license: creativeCommon, youTube

Permitted values for category id can be obtains from (metadata API)[destinations/#metadata].

Update Details

{
    "tw_tweetId": "...",
    "tw_mediaId": "...",
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

Note: Updating a Tweet is only necessary for the initial submission of the Tweet. Therefore, the automation service within MediaSyndication will call this endpoint, and currently there is no other action to perform.

View Details

{
    "tw_title": "My Tweet content here.",
    "tw_mediaId": "...",
    "tw_tweetId": "...",
    "link": "...",
    "embedHtml": "...",
    "isUnavailable": false
}