Propriedades de marcação de conteúdo de eventos de TV ao vivo

Esta seção fornece os detalhes das propriedades de marcação de conteúdo para o tipo de entidade BroadcastEvent. Para entender melhor a relação entre esses tipos, revise os conceitos de eventos de LiveTV.

Tabela de especificação de BroadcastEvent

Propriedade Tipo esperado Descrição
@context Texto Obrigatório – Sempre defina como ["http://schema.org", {"@language": "xx"}]
  • Substitua xx pelo código de idioma da entidade no formato BCP 47, por exemplo, "en".
@type Texto Obrigatório: sempre defina como BroadcastEvent.
@id URL Obrigatório: o identificador do conteúdo no formato URI. Por exemplo, https://example.com/1234abc.
@id precisa atender aos seguintes requisitos:
  • Exclusivo globalmente no seu catálogo
  • Estático O ID precisa ser estável e não pode mudar ao longo do tempo, mesmo que a propriedade de URL do programa mude. Ele será tratado como uma string opaca e não precisa ser um link em funcionamento.
  • Na forma de URI (Identificador de recurso unificado)
  • O domínio usado para o valor @id precisa ser da sua organização.
Como o url de uma entidade atende a todos os requisitos de identificador, recomendamos que você use o url dela como @id. Consulte a seção Identificador para mais detalhes.
name Texto Obrigatório: o título do programa ou evento.
description Texto A descrição do programa ou evento. Limista de 300 caracteres. Use uma matriz para incluir as descrições em vários idiomas e comprimentos.
startDate Data Obrigatório: é o horário de início do evento no formato ISO 8601 com fuso horário.
endDate Data É o horário de término do evento no formato ISO 8601 com fuso horário.
publishedOn BroadcastService Obrigatório, se aplicável: especifique a entidade BroadcastService que transmite esse programa ou evento.

Se o conteúdo for transmitido em um canal de TV, essa propriedade será obrigatória. Se o conteúdo não estiver associado a nenhum canal de TV, não forneça essa propriedade.
publishedOn.@type Texto Defina como BroadcastService.
publishedOn.@id URL O @id da entidade BroadcastService que transmite esse programa ou evento.
workPerformed CreativeWork Obrigatório, se aplicável: use essa propriedade quando o conteúdo for um dos seguintes tipos de entidade: Movie, TVSeries e TVEpisode.
É altamente recomendável que uma entidade BroadcastEvent inclua pelo menos uma das seguintes opções:
  • workPerformed
  • broadcastOfEvent
  • contentToBeAnnounced teve o endereço definido como true
  • offAir teve o endereço definido como true
workPerformed.@type Texto Defina como Movie, TVSeries ou TVEpisode.
workPerformed.@id URL O @id da entidade de conteúdo.
broadcastOfEvent SportsEvent Obrigatório se aplicável: use essa propriedade se o conteúdo for um evento ao vivo:
  • Para um evento esportivo, esta propriedade precisa se referir a uma entidade SportsEvent.

É altamente recomendável que uma entidade BroadcastEvent inclua pelo menos uma das seguintes opções:
  • workPerformed
  • broadcastOfEvent
  • contentToBeAnnounced teve o endereço definido como true
  • offAir teve o endereço definido como true
broadcastOfEvent.@type Texto Defina como SportsEvent.
broadcastOfEvent.@id URL O @id da entidade do evento. A entidade do evento precisa existir no feed e ter um @id diferente daquele de BroadcastEvent.
location Text ou Country Obrigatório se BroadcastEvent for para um SportsEvent, ou seja, tiver a propriedade broadcastOfEvent: o país em que o SportsEvent pode ser transmitido. Este campo pode ser uma lista de países se vários países puderem transmitir o SportsEvent.
videoFormat Texto A definição de qualidade mais alta suportada neste serviço de transmissão. por exemplo,
  • "SD" para definição padrão.
  • "HD" para alta definição.
  • "2 mil" para a resolução 2K.
  • "4K" para a resolução 4K.
  • "8 mil" para resolução 8K.
contentToBeAnnounced Booleano Obrigatório, se aplicável: use essa propriedade se o conteúdo for desconhecido no momento da criação do feed.

Defina como true quando o provedor não tiver informações atualizadas sobre o que será transmitido false. Caso contrário, false.
É altamente recomendável que uma entidade BroadcastEvent inclua pelo menos um destes elementos:
  • workPerformed
  • broadcastOfEvent
  • contentToBeAnnounced teve o endereço definido como true
  • offAir teve o endereço definido como true
offAir Booleano Obrigatório se for o caso: use essa propriedade se não houver uma transmissão de conteúdo planejada para o horário.
É altamente recomendável que uma entidade BroadcastEvent inclua pelo menos um dos itens a seguir:
  • workPerformed
  • broadcastOfEvent
  • contentToBeAnnounced teve o endereço definido como true
  • offAir teve o endereço definido como true
isLiveBroadcast Booleano Defina como true se este for um evento ao vivo. como um evento esportivo ou show.
potentialAction WatchAction Obrigatório, se aplicável: se o conteúdo for transmitido como um canal que não faz transmissões ao vivo de evento (com contentToBeAnnounced definido como false ou offAir definido como false), use essa propriedade para fornecer o link direto do evento.
identifier PropertyValue ID externo que identifica o conteúdo de transmissão. Consulte a seção Propriedades do identificador para mais detalhes.
  • Observação: o tipo de entidade BroadcastEvent só aceita valores propertyID de TMS_ID ou TMS_ROOT_ID.
  • Essa propriedade só precisa ser fornecida nos casos em que uma entidade Movie, TVSeries, TVEpisode ou SportsEvent de nível superior totalmente formada não é referenciada usando a propriedade workPerformed ou broadcastOfEvent.
  • O valor da propriedade precisa refletir o TMS_ID ou TMS_ROOT_ID da entidade Movie, TVSeries, TVEpisode ou SportsEvent que você gostaria de referenciar usando a propriedade workPerformed ou broadcastOfEvent.
  • É preferencial usar TMS_ID em vez do valor TMS_ROOT_ID.
contentRating Text ou Rating Obrigatório para conteúdo adulto, mas altamente recomendado. Caso contrário, Por quê? - Classificação geral do conteúdo transmitido. Se a classificação do conteúdo for dada na forma de uma string de texto, duas variações serão aceitas:
  • A agência precedida pela classificação com um espaço em branco no meio. Por exemplo, "PG-13" classificação da agência "MPAA" nos EUA deve ser descrita como "MPAA PG-13". Consulte a lista de agências.
  • Um valor de "CLASSIFICAÇÃO NÃO CONHECIDA" (não diferencia maiúsculas de minúsculas) para indicar que você não sabe a classificação do Filme.
contentRating.author Organização Obrigatório se contentRating usar Rating: é o nome da agência de classificação.
contentRating.ratingValue Texto Obrigatório se contentRating usar Rating: o valor da classificação.
contentRating.advisoryCode Texto O código consultivo do conteúdo. Os valores aceitos incluem D, FV, L, S e V. D = diálogo, FV = violência fantasiosa, L = idioma, S = conteúdo sexual, V = violência.

Exemplos

Um episódio de TV é transmitido na rede de televisão Example TV. (BroadcastService) das 21h às 21h30 do dia 12 de outubro de 2019:

BroadcastEvent

{
  "@context": ["http://schema.org", {"@language": "en"}],
  "@type": "BroadcastEvent",
  "@id": "http://example.com/live/event/my_favorite_tv_series/new_episode",
  "name": "My Favorite TV Series - Season 6 - Episode 2 - Three Mice",
  "description": "Three mice leave the town and the trip turns into something more.",
  "startDate": "2019-10-12T21:00-08:00",
  "endDate": "2019-10-12T21:30-08:00",
  "videoFormat": "HD",
  "isLiveBroadcast": false,
  "publishedOn": {
    "@type": "BroadcastService",
    "@id": "http://example.com/stations/example_tv"
  },
  "workPerformed": {
    "@type": "TVEpisode",
    "@id": "http://example.com/tv_series/my_favorite_tv_series/s6/e2_three_mice"
  }
}

BroadcastService

{
  "@context":"http://schema.org",
  "@type":"BroadcastService",
  "@id":"http://example.com/stations/example_tv",
  "name":"EXAMPLE-TV",
  "broadcastDisplayName":"ABCD",
  "callSign": "EXA-TV",
  "videoFormat":"SD",
  "broadcastTimezone":"America/Los_Angeles",
  "broadcastAffiliateOf":{
    "@type":"Organization",
    "@id":"http://example.com/networks/abcd-network"
  },
  "identifier": [
   {
     "@type": "PropertyValue",
     "propertyID": "TMS_ID",
     "value": "12258"
   },
   {
     "@type": "PropertyValue",
     "propertyID": "_PARTNER_ID_",
     "value": "exampletv-123456"
   }
  ],
  "potentialAction": {
    "@type": "WatchAction",
    "target": {
      "@type": "EntryPoint",
      "urlTemplate": "http://example.com/livestream",
      "actionPlatform": [
        "http://schema.org/DesktopWebPlatform",
        "http://schema.org/MobileWebPlatform",
        "http://schema.org/AndroidPlatform",
        "http://schema.org/IOSPlatform",
        "http://schema.googleapis.com/GoogleVideoCast",
        "http://schema.org/AndroidTVPlatform"
      ]
    },
    "actionAccessibilityRequirement": {
      "@type": "ActionAccessSpecification",
      "category": "externalsubscription",
      "availabilityStarts": "2018-07-21T10:35:29Z",
      "availabilityEnds": "2019-10-21T10:35:29Z",
      "requiresSubscription": {
        "@type": "MediaSubscription",
        "@id": "http://example.com/subscription",
        "name": "ABCD",
        "sameAs": "http://example.com/subscription",
        "identifier": "example.com:basic",
        "commonTier": false
      },
      "eligibleRegion": [
        {
          "@type": "Country",
          "name": "US"
        }
      ]
    }
  }
}

Exemplo que mostra o uso da propriedade contentToBeAnnounced quando o conteúdo a ser transmissão na rede de televisão Example TV (BroadcastService) das 21h às 21h30 do dia 12 de outubro de 2019 é desconhecido no momento da criação do feed:

BroadcastEvent

{
  "@context": ["http://schema.org", {"@language": "en"}],
  "@type": "BroadcastEvent",
  "@id": "http://example.com/randomUniqueEventId",
  "name": "To Be Announced"
  "startDate": "2019-10-12T21:00-08:00",
  "endDate": "2019-10-12T21:30-08:00",
  "publishedOn": {
    "@type": "BroadcastService",
    "@id": "http://example.com/stations/example_tv"
  },
  "contentToBeAnnounced": true
}

BroadcastService

{
  "@context":"http://schema.org",
  "@type":"BroadcastService",
  "@id":"http://example.com/stations/example_tv",
  "name":"EXAMPLE-TV",
  "broadcastDisplayName":"ABCD",
  "callSign": "EXA-TV",
  "videoFormat":"SD",
  "broadcastTimezone":"America/Los_Angeles",
  "broadcastAffiliateOf":{
    "@type":"Organization",
    "@id":"http://example.com/networks/abcd-network"
  },
  "identifier": [
   {
     "@type": "PropertyValue",
     "propertyID": "TMS_ID",
     "value": "12258"
   },
   {
     "@type": "PropertyValue",
     "propertyID": "_PARTNER_ID_",
     "value": "exampletv-123456"
   }
  ],
  "potentialAction": {
    "@type": "WatchAction",
    "target": {
      "@type": "EntryPoint",
      "urlTemplate": "http://example.com/livestream",
      "actionPlatform": [
        "http://schema.org/DesktopWebPlatform",
        "http://schema.org/MobileWebPlatform",
        "http://schema.org/AndroidPlatform",
        "http://schema.org/IOSPlatform",
        "http://schema.googleapis.com/GoogleVideoCast",
        "http://schema.org/AndroidTVPlatform"
      ]
    },
    "actionAccessibilityRequirement": {
      "@type": "ActionAccessSpecification",
      "category": "externalsubscription",
      "availabilityStarts": "2018-07-21T10:35:29Z",
      "availabilityEnds": "2019-10-21T10:35:29Z",
      "requiresSubscription": {
        "@type": "MediaSubscription",
        "@id": "http://example.com/subscription",
        "name": "ABCD",
        "sameAs": "http://example.com/subscription",
        "identifier": "example.com:basic",
        "commonTier": false
      },
      "eligibleRegion": [
        {
          "@type": "Country",
          "name": "US"
        }
      ]
    }
  }
}

O canal da rede de televisão Example TV(BroadcastService) está fora do ar entre 12h e 20h e transmite 1 programa chamado My favorite show entre 20h e 12h:

BroadcastEvent

{
   "@context": ["http://schema.org", {"@language": "en"}],
   "@type": "BroadcastEvent",
   "@id": "http://example.com/randomUniqueEventId1",
   "name": “Off Air”,
   "startDate": "2019-10-12T00:00-08:00",
   "endDate": "2019-10-12T20:00-08:00",
   "publishedOn": {
       "@type": "BroadcastService",
       "@id": "http://example.com/stations/example_tv"
   },
   "offAir": true
},
{
  "@context": ["http://schema.org", {"@language": "en"}],
  "@type": "BroadcastEvent",
  "@id": "http://example.com/randomUniqueEventId2",
  "startDate": "2019-10-12T20:00-08:00",
  "endDate": "2019-10-13T00:00-08:00",
  "videoFormat": "HD",
  "isLiveBroadcast": false,
  "name": "My favorite show",
  "workPerformed": {
    ...
  },
  "publishedOn": {
    "@type": "BroadcastService",
    "@id": "http://example.com/stations/example_tv"
  },

}

BroadcastService

{
  "@context":"http://schema.org",
  "@type":"BroadcastService",
  "@id":"http://example.com/stations/example_tv",
  "name":"EXAMPLE-TV",
  "broadcastDisplayName":"ABCD",
  "callSign": "EXA-TV",
  "videoFormat":"SD",
  "broadcastTimezone":"America/Los_Angeles",
  "broadcastAffiliateOf":{
    "@type":"Organization",
    "@id":"http://example.com/networks/abcd-network"
  },
  "identifier": [
   {
     "@type": "PropertyValue",
     "propertyID": "TMS_ID",
     "value": "12258"
   },
   {
     "@type": "PropertyValue",
     "propertyID": "_PARTNER_ID_",
     "value": "exampletv-123456"
   }
  ],
  "potentialAction": {
    "@type": "WatchAction",
    "target": {
      "@type": "EntryPoint",
      "urlTemplate": "http://example.com/livestream",
      "actionPlatform": [
        "http://schema.org/DesktopWebPlatform",
        "http://schema.org/MobileWebPlatform",
        "http://schema.org/AndroidPlatform",
        "http://schema.org/IOSPlatform",
        "http://schema.googleapis.com/GoogleVideoCast",
        "http://schema.org/AndroidTVPlatform"
      ]
    },
    "actionAccessibilityRequirement": {
      "@type": "ActionAccessSpecification",
      "category": "externalsubscription",
      "availabilityStarts": "2018-07-21T10:35:29Z",
      "availabilityEnds": "2019-10-21T10:35:29Z",
      "requiresSubscription": {
        "@type": "MediaSubscription",
        "@id": "http://example.com/subscription",
        "name": "ABCD",
        "sameAs": "http://example.com/subscription",
        "identifier": "example.com:basic",
        "commonTier": false
      },
      "eligibleRegion": [
        {
          "@type": "Country",
          "name": "US"
        }
      ]
    }
  }
}

Confira as páginas a seguir para os tópicos relacionados a essas propriedades: