InstanceSettings

From Gvp-public
Jump to navigation Jump to search

Represents the list of settings for a certain instance. These are the common configurations for a certain service and OB. Using this settings, the OB can customize the service setup.

Members

Field Data Type Description
Title String Instance name
RootChannelId int The root navigation channel ID for OTT devices. This ID can be used to build the Navigation channel tree.
HeartbeatFrequency int HeartbeatFrequency
BatchFrequency int DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside
DeviceRegistrationUrl String The url for the web application registration form
DisallowedEvents Array DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside
AgeRatings Array of AgeRating objects The Age Ratings associated with this instance.
HeaderLinks Array of Link objects The header links associated with this instance
FooterLinks Array of Link objects The footer links associated with this instance
BackgroundImages Array of Image objects DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside
LogoImages Array of Image objects DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside
RegistrationMessage String Contains the message to be shown to end user to register
RegistrationPhone String Contains the phone number to be shown to end user to register (Call center)
UserRegistrationUrl String Contains the url for registering in the service (can be an external or internal URL)
SupportedUserTypes Int Contais a value of the supported User types (UserType enum) in this instance (for registration purposes mainly).
SpeedTestImageUrl String Url of the image to perform a speed test (used by Connected TVs)
MandatorySubscriptionId int DEPRECATED. ID of the mandatory Subscription for this instance. This concept is deprecated since GVP 2.4.
MandatorySubscriptionMessage String DEPRECATED. Message to be show to the end user when the user tries to purchase a subscription and has not purchased the mandatory subscription. This concept is deprecated since GVP 2.4.
MandatoryRegistrationText HTML object DEPRECATED. HTML to show in the page for purchasing the mandatory subscription. This is a HTML HTMLType enum= 1. This concept is deprecated since GVP 2.4.
RegistrationText HTML object HTML to show in the page for User Registration mandatory subscription. This is a HTML HTMLType enum= 2.
RegistrationImages Array of Image objects Images for registration page in PC.
UseCallCenterForTefUserRegistration bool Indicates if the Telefonica user types should register using call center or registration page.
AgeRatingSystem String Name of the AgeRating System, used in Mediaroom.
CMGConnectorEndPoint String Url of the CMG connector endpoint of this instance (for MR communication).
CustomizationCssPath String Url of the Css to customize PC client.
LicenseIssuerUrl String DEPRECATED. Url of Widevine license issuer. This setting is deprecated since GVP 2.4.
EmmUrl String DEPRECATED. Url of Widevine Emm server. This setting is deprecated since GVP 2.4.
SignonUrl String DEPRECATED. Url of Widevine singon server. This setting is deprecated since GVP 2.4.
Portal String DEPRECATED. Widevine portal setting. This setting is deprecated since GVP 2.4.
LegalConditions HTML object HTML to show in the PC for legal conditions. This is a HTML HTMLType enum= 3.
CountryCodes Array of Strings Array of strings containing the country codes (COUNTRIES) associated with this instance. The code is in the ISO-3166 format.
DisableContactus bool Indicates if the contact us page should be shown to the users or not for this instance
RecoverPasswordEmailFrom String Email to be used in the FROM field of password recovery emails
PurchaseEmailFrom String Email to be used in the FROM field of purchase notification emails
RegistrationEmailFrom String Email to be used in the FROM field of registration notification emails
Copyright String Service Copyright to be displayed in the applications
GalNonDelegateAuthenticationFlag bool Flag that indicates if the instance has NonDelegatedAuthentication enabled or not.
SiteTitle String Title for the website
EnablePlaylists bool Indicates if the instance has Playlist enabled or not
MinimumAgeForRegistration int Integer with the minimum age for user registration. If the user indicates an age lower than this, the registration will be blocked.
RootIptvChannelId int Channel ID root for IPTV VOD Channel tree
MaxConcurrentPlaybackStreams int Maximun number of concurrent playback sessions allowed in this instance (Concurrence control)
ConcurrentAdditionalDeviceBehaviour int Indicates the Concurrent Session control behavior (kick oldest 1 / kick newest 0). See ConcurrentAdditionalDeviceBehaviour enum.
PlaybackHeartbeatInterval int Heartbeat interval for Playback. Determines the frequency that the player should send heartbeat during playback.
PlaybackHeartbeatInterval int Heartbeat interval for Playback. Determines the frequency that the player should send heartbeat during playback.
EnableLiveOtt bool Indicates if the instance has LiveOTT enabled.
FooterScripts String Contains the footer scripts code for Web client
ExternalLandingPage String Indicates the External Landing Page url for embedding it into PC client
ExternalLandingPageHeight int Height in pixels of the External landing page header
GooglePlayUrl String URL of the google play store for Android application
AppleStoreId int ID of the apple store item
AppleStoreUrl String URL of the apple store for iOS application
EnableDtp bool Indicates if the instance has Download to Play functionality enabled
RootCatchupId int Channel ID root for Catchup Channel tree
TimeShiftDeferralTime int Deferral time for time shift functionality
TimeShiftCapacity int Maximum number of users allowed for Timeshift in this instance
ThumbBoxUrl int Channel ID root for Catchup Channel tree
EnableTimeShift int Channel ID root for Catchup Channel tree
AllowLoginBeforeConfirmation boolean New in GVP 4.0.If true, instance allows login before confirmation email.


Example

{
    "Title": "Homolog",
    "RootChannelId": 43,
    "HeartbeatFrequency": 500,
    "BatchFrequency": 60000,
    "DeviceRegistrationUrl": "http://ottpre.labs.gvp.telefonica.com/",
    "DisallowedEvents": [],
    "AgeRatings": [
      {
        "ID": 3,
        "Title": "G",
        "Name": "G",
        "Icon": {
          "ID": 119,
          "Url": "http://media-pre.labs.gvp.telefonica.com/storagearea0/IMAGES/00/00/00/119_8A9FC9B6E01FCCB2.png",
          "Width": 75,
          "Height": 75,
          "Type": 4,
          "Ext": ".png"
        },
          "Age": 0,
          "IsAdult": false
         },
         {
           "ID": 145,
           "Title": "L",
           "Name": "Livre para todos os públicos",
           "Icon": {
             "ID": 27660,
             "Url": "http://media-pre.labs.gvp.telefonica.com/storagearea0/IMAGES/00/00/02/27660_D9D4E5A1088951B6.png",
             "Width": 80,
             "Height": 80,
             "Type": 1,
             "Ext": ".png"
           },
           "Age": 1,
           "IsAdult": false
         }
    ],
    "HeaderLinks": [
         {
           "ID": 3,
           "Url": "http://www.prnewswire.com/news-releases/telefonica-and-moremagic-solutions-expand-international-recharge-of-movistar-mobile-phones-throughout-latin-america-84363322.html",
           "Title": "Press Releases",
           "Type": 1,
           "Html": ""
         },
         {
           "ID": 4,
           "Url": "http://www.telefonica.com/en/home/jsp/home.jsp",
           "Title": "HotSite",
           "Type": 1,
           "Html": ""
         }
    ],
    "BackgroundImages": [],
    "LogoImages": [],
    "RegistrationMessage": "",
    "RegistrationPhone": "",
    "CurrencyFormat": "$%1",
    "UserRegistrationUrl": "http://ottpre.labs.gvp.telefonica.com/Home/Index?message=openregister",
    "SupportedUserTypes": 3,
    "SpeedTestImageUrl": "http://b5019.cdn.telefonica.com/5019/Speed_Test.jpg",
    "MandatorySubscriptionId": 0,
    "MandatorySubscriptionMessage": "Teste",
    "MandatoryRegistrationText": {
      "ID": 2,
      "Name": "Mandatory Registration",
      "Source": 1,
      "Subject": "",
      "HtmlType": 1,
      "Language": 1,
      "Html": "<h3>enjoy info</h3>\r\n<div class=\"info\">\r\n\t<h5>enjoy</h5>\r\n\t<p>\r\n\t\t<strong>Enjoy</strong>\r\n\t\tour videoclub cataloque, you will have all kind of contents, with a code in the case of adult content in order to minors cannot gain access.\r\n\t</p>\r\n\t<p>\r\n\t\tOur contents are available both\r\n\t\t<strong>HD</strong>\r\n\t\tand SD, in different languages and with different subtitles.\r\n\t</p>\r\n\t{0}\r\n</div>"
    },
    "RegistrationText": {
         "ID": 1,
         "Name": "Registration",
         "Source": 1,
         "Subject": "",
         "HtmlType": 2,
         "Language": 1,
         "Html": "<h3>Register</h3>\r\n<div class=\"info\">\r\n\t<h5>enjoy</h5>\r\n\t<p>\r\n\t\t<strong>Enjoy</strong>\r\n\t\tour contents are available both <strong>HD</strong> and <strong>SD</strong>, in different languages and with diferrent subtitles.\r\n\t</p>\r\n\t{0}\r\n</div>"
    },
    "RegistrationImages": [
         {
           "ID": 112,
           "Url": "http://media-pre.labs.gvp.telefonica.com/storagearea0/IMAGES/00/00/00/112_A355D0ED83DDAAF9.jpg",
           "Width": 250,
           "Height": 200,
           "Type": 7,
           "Ext": ".jpg"
         },
         {
           "ID": 236,
          "Url": "http://media-pre.labs.gvp.telefonica.com/storagearea0/IMAGES/00/00/00/236_CFE327AE727524E9.png",
          "Width": 250,
           "Height": 200,
           "Type": 7,
           "Ext": ".png"
         }
    ],
    "UseCallCenterForTefUserRegistration": false,
    "AgeRatingSystem": "MJBrasil",
    "CMGConnectorEndPoint": "http://mrconnector1.ottpreprod.gvp.telefonica.com/",
    "CustomizationCssPath": "https://posters-cert.labs.gvp.telefonica.com/storagearea0/GVP_WEB/css/skin_movistar_spain_2_2_1.css",
    "LicenseIssuerUrl": "",
    "EmmUrl": "",
    "LogUrl": "",
    "SignonUrl": "",
    "Portal": "",
    "LegalConditions": {
         "ID": 72,
         "Name": "Legal Condition Ottpre-labs",
         "Source": 1,
         "Subject": "",
         "HtmlType": 3,
         "Language": 1,
         "Html": "<h3>\r\nLegal Condition\r\n</h3>"
    },
    "CountryCodes": [
         "br",
         "gb",
        "xx",
         "es",
         "eu",
         "--",
         "il"
    ],
    "DisableContactus": true,
    "RecoverPasswordEmailFrom": "gvp@labone.net",
    "PurchaseEmailFrom": "GVP_LabOne <gvp@labone.net>",
    "RegistrationEmailFrom": "GVP_LabOne <gvp@labone.net>",
    "Copyright": "© Telefonica Pre-Prod S.A.",
    "GalNonDelegateAuthenticationFlag": true,
    "GalAsynchronousCancellation": true,
    "SiteTitle": "Pre-Prod Homolog",
    "EnablePlaylists": true,
    "MinimumAgeForRegistration": 0,
    "RootIptvChannelId": 96,
    "MaxConcurrentPlaybackStreams": 1,
    "ConcurrentAdditionalDeviceBehaviour": 0,
    "PlaybackHeartbeatInterval": 60,
    "EnableLiveOtt": true,
    "FooterScripts": "<script type=\"text/javascript\" src=\"https://d3skgb39wax964.cloudfront.net/TEFGVP/OTTAnalytics_TEFGVP_1_0_1.js\"></script>",
    "ExternalLandingPage": "",
    "ExternalLandingPageHeight": 0,
    "GooglePlayUrl": "https://play.google.com/store/apps/details?id=com.tid.enjoy&hl=en",
    "AppleStoreId": "665941149",
    "EnableDtp": true,
    "AppleStoreUrl": "https://itunes.apple.com/es/app/movistar-tv/id665941149",
    "RootCatchupId": 0,
    "TimeShiftDeferralTime": 0,
    "TimeShiftCapacity": 10000,
    "ThumbBoxUrl": "http://thumbbox-pre.labs.gvp.telefonica.com/Image/{RESIZE_TYPE}/{RETURN_TYPE}/w/{WIDTH}/h/{HEIGHT}?imageUrl={IMAGE_URL}",
    "EnableTimeShift": true,
    "AllowLoginBeforeConfirmation": false
}


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial data type implementation Harley Cabral
2.1 Added new fields to the InstanceSettings object
  • MaxConcurrentPlaybackStreams
  • ConcurrentAdditionalDeviceBehaviour
  • PlaybackHeartbeatInterval
  • EnableLiveOtt
 Francisco Milagro
2.2 Added new fields to the InstanceSettings object
  • FooterScripts
  • ExternalLandingPage
  • GooglePlayUrl
  • AppleStoreId
  • EnableDtp
  • AppleStoreUrl
 Francisco Milagro
2.3 Added new fields to the InstanceSettings object
  • RootCatchupId
  • TimeShiftDeferralTime
  • ThumbBoxUrl
  • EnableTimeShift
 Francisco Milagro
2.4 Deprecated some member fields:
  • BatchFrequency
  • DisallowedEvents
  • FooterLinks
  • BackgroundImages
  • LogoImages
  • MandatorySubscriptionId
  • MandatorySubcriptionMessage
  • CMGConnectorEndPoint
  • LicenseIssuerUrl
  • EmmUrl
  • SignonUrl
  • Portal
 Francisco Milagro 2.1 Added new field to the InstanceSettings object
  • AllowLoginBeforeConfirmation
 Cristina Peña


See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=InstanceSettings&oldid=1816"