VOD Publications 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 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,
    "fb_unpublishedContentType": null,
    "fb_thumbnailUrl": "https://server.com/path/to/image.jpg",
    "fb_overrideResourceId": "123456789",
    "publishAt": null,
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}
  • permitted values for fb_unpublishedContentType: please refer to Facebook’s video documentation
  • fb_thumbnailUrl, if provided, should be a URL to a downloadable .jpg or .png file. If not accessible the upload may fail.
  • fb_overrideResourceId allows you to distribute to a specified resource (i.e. Page), requires a Facebook Destination without a default ResourceId.
  • publishAt should be an ISO8601 date time string. If not provided then the video will publish as soon as possible.
    • If this value is within 10 minutes of the completed upload time, then this value will be pushed back. This is a requirement on Facebook’s side when uploading.

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",
    "fb_thumbnailUrl": "https://server.com/path/to/image.jpg",
    "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",
    "yt_notifySubscribers": true,
    "yt_playlistId": "12345",
    "yt_thumbnailUrl": "https://server.com/path/to/file.png",
    "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.
  • yt_notifySubscribers will default to True.
  • yt_playlistId can be provided to set add the video to a single Playlist post-upload.
  • yt_thumbnailUrl, if provided, should be a URL to a downloadable .jpg or .png file. If not accessible the upload will complete without setting the thumbnail.
  • 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",
    "yt_notifySubscribers": true,
    "yt_playlistId": "12345",
    "yt_thumbnailUrl": "https://server.com/path/to/file.png",
    "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"
    ]
}
  • publishAt should be an ISO8601 date time string. If not provided then the video will publish as soon as possible.

Required: tw_status

Update Details 

{
    "tw_status": "Example Tweet content to be Edited",
    "publishAt": null,
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}
  • tw_status must be different from the existing text otherwise no update to the Tweet will be performed.

Required: tw_status

View Details 

{
    "tw_title": "Example Tweet content here.",
    "tw_mediaId": "...",
    "tw_tweetId": "...",
    "publishAt": null,
    "published": true,
    "link": "...",
    "embedHtml": "...",
    "isUnavailable": false
}