Ações de assistir propriedades comuns

Esta seção fornece os detalhes das propriedades comuns das Ações no Relógio.

Propriedades de marcação de ação

Propriedade Tipo esperado Descrição
@type Texto Obrigatório: sempre definido como WatchAction.
target EntryPoint Obrigatório: um objeto de destino que fornece o mapeamento de links diretos para várias plataformas do Google.
target.@type Texto Obrigatório: sempre definido como EntryPoint.
target.urlTemplate URL Obrigatório: um link direto que leva os usuários ao seu app ou plataforma e inicia a reprodução do conteúdo.
target.inLanguage Texto Opcional: idioma original da série no formato BCP 47.
target.actionPlatform Texto Obrigatório: as plataformas mapeadas para urlTemplate. As Ações de mídia oferecem suporte a:
  • http://schema.org/DesktopWebPlatform: plataforma de pesquisa em navegadores da Web para computador.
  • http://schema.org/MobileWebPlatform: plataforma de pesquisa em navegadores da Web para dispositivos móveis.
  • http://schema.org/AndroidPlatform: plataformas de pesquisa e PlayGuide no app Android.
  • http://schema.org/AndroidTVPlatform: plataforma Android TV no app Android TV.
  • http://schema.org/IOSPlatform: plataforma de pesquisa no app iOS.
  • http://schema.googleapis.com/GoogleVideoCast: plataformas de transmissão e Home em um dispositivo Chromecast.
  • http://schema.googleapis.com/GoogleAudioCast: plataformas Cast e Home em um dispositivo Chromecast (somente ações de ouvir).
Consulte a seção Tipos de plataforma para conferir os requisitos.
target.additionalProperty PropertyValue Obrigatório se aplicável: uma lista de pares de propriedade-valor para representar propriedades adicionais do link direto. Isso pode incluir o seguinte:
  • contentLanguage: o idioma de transmissão (dublagem), no formato BCP 47. Se o conteúdo for dublado em outro idioma, essa propriedade será obrigatória. Use uma matriz para vários códigos de idioma.
  • subtitleLanguage: os idiomas das legendas, no formato BCP 47. Use uma matriz para vários códigos de idioma.
  • cameraAngle: o ângulo da câmera do conteúdo, por exemplo, "Nível dos olhos" e "Ângulo alto". Se o conteúdo estiver disponível em diferentes ângulos de câmera, essa propriedade será obrigatória. Use uma matriz para vários ângulos de câmera.
  • videoFormat: o formato de arquivo usado para armazenar a data do vídeo digital. Por exemplo, "SD" para definição padrão e "HD" para alta definição. Os formatos de vídeo válidos incluem SD, HD, 2K, 4K e 8K. Use uma matriz para vários formatos de vídeo.
Confira o exemplo de additionalProperty.
actionAccessibilityRequirement ActionAccessSpecification Obrigatório: um objeto de especificação de acesso de ação que descreve o requisito de acesso do conteúdo. Consulte Propriedades da especificação de acesso da ação.

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

Propriedades de especificação de acesso a ações

Propriedade Tipo esperado Descrição
actionAccessibilityRequirement.@type Texto Obrigatório: sempre definido como ActionAccessSpecification.
actionAccessibilityRequirement.category Texto

Obrigatório: um requisito de acesso ao conteúdo. Para mais informações, consulte Tipo de paywall.

Se uma entidade representar um grupo de conteúdo, defina category como o requisito de acesso menos restritivo do conteúdo. Por exemplo, se um TVSeries tiver algum conteúdo TVEpisode definido como nologinrequired e alguns definidos como subscription, defina esse TVSeries como nologinrequired.
actionAccessibilityRequirement.availabilityStarts Data

Obrigatório: data após a qual a ação estará disponível, no formato ISO 8601 (incluindo o fuso horário).

  • A data pode ser definida no futuro.

É necessário que a entidade correspondente seja fornecida no feed pelo menos 7 dias antes da data de início de disponibilidade. Isso aumenta as chances de o conteúdo aparecer nas plataformas do Google no prazo.

actionAccessibilityRequirement.availabilityEnds Data Obrigatório: data final de disponibilidade da ação, no formato ISO 8601 (incluindo o fuso horário).
  • Precisa ser igual ou maior que 72 horas após availabilityStarts.
  • Se o conteúdo estiver sempre disponível após a publicação, defina essa data como 20 anos a partir da data atual.

É necessário que todas as atualizações da data de término de disponibilidade sejam feitas no feed pelo menos 7 dias antes da data de término de disponibilidade. Isso aumenta as chances de o conteúdo deixar de aparecer nas plataformas do Google na data de término da disponibilidade.

actionAccessibilityRequirement.eligibleRegion País, Cidade, Estado, GeoShape ou Texto Obrigatório: regiões em que o conteúdo está disponível. Use a string especial EARTH se o conteúdo estiver disponível globalmente.
actionAccessibilityRequirement.ineligibleRegion País, Cidade, Estado ou GeoShape Obrigatório se aplicável: regiões em que o conteúdo está restrito. Não é necessário fornecer essa propriedade se o conteúdo estiver disponível em todos os lugares em eligibleRegion.
actionAccessibilityRequirement.requiresSubscription MediaSubscription

Obrigatório se aplicável: os detalhes da assinatura que os usuários precisam para acessar o conteúdo. Consulte Propriedades de assinatura de mídia.

  • Forneça essa propriedade se category for subscription ou externalSubscription.
actionAccessibilityRequirement.expectsAcceptanceOf Oferta Obrigatório se o conteúdo exigir uma compra: os detalhes da oferta associada ao conteúdo. Informe os dados de preço para os seguintes casos:
  • Conteúdo de compra única (rental ou purchase)
  • Conteúdo baseado em assinatura que exige uma compra extra dos assinantes (subscription ou externalsubscription)
Se o preço for 0,00, remova o objeto Offer por completo e defina o category do objeto ActionAccessSpecification como free. Consulte Propriedades da oferta.

Propriedades de assinatura de mídia

Obrigatório se actionAccessibilityRequirement.category for subscription ou externalSubscription.

Propriedade Tipo esperado Descrição
requiresSubscription.@type Texto Obrigatório: sempre definido como MediaSubscription.
requiresSubscription.@id URL Obrigatório: o ID exclusivo da assinatura. Se o conteúdo for acessível por diferentes assinaturas, cada uma delas precisará ter um ID exclusivo.
requiresSubscription.name Texto Obrigatório: o nome da assinatura. Observe o seguinte:
  • Se o conteúdo puder ser acessado por assinaturas diferentes, esse nome precisa corresponder ao nome no sistema de autenticação do usuário. Por exemplo, se um usuário pode acessar o conteúdo com base na assinatura Pacote 1, mas o sistema de autenticação usa o nome PKG1a, use PKG1.
  • Para provedores de TVE, é o nome do autenticador registrado com o autenticador de TVE. É uma string que identifica exclusivamente o nome do serviço com o autenticador de TVE.
requiresSubscription.sameAs URL A página que descreve a assinatura.
requiresSubscription.identifier Texto Obrigatório se category for subscription E commonTier for false : uma string exclusiva para essa assinatura que representa o acesso a um grupo de conteúdo no seu catálogo de mídia.
  • O Google recomenda que você use a seguinte sintaxe para o identificador:
    nome de domínio + dois-pontos (:) + nível de acesso ao conteúdo. Exemplos : example.com:basic, example.com:premium, example.com:sports
  • Essa propriedade será igual ao identificador de direito de acesso se você estiver fornecendo uma API de direito de acesso.
requiresSubscription.authenticator Organização Obrigatório se category for externalsubscription: um contêiner que fornece os detalhes do autenticador do provedor externo.
requiresSubscription.authenticator.@type Texto Obrigatório se category for externalsubscription: sempre defina como Organization.
requiresSubscription.authenticator.name Texto Obrigatório se category for externalsubscription: o nome do serviço de autenticação. Para provedores de TVE, defina como TVE.
requiresSubscription.commonTier Booleano Obrigatório se aplicável: obrigatório se a categoria estiver definida como "assinatura". Leia mais sobre o commonTier na documentação requisitos de camada comum.

Requisitos da API Entitlements

Uma API de direito é necessária se actionAccessibilityRequirement.category for subscription ou externalSubscription e a oferta de assinatura incluir vários pacotes ou níveis ou tiver suporte a complementos. Não inclua essa informação se a assinatura for de um nível e der acesso a todo o conteúdo do seu catálogo.

  • A Empresa A tem uma única oferta de assinatura que dá aos usuários inscritos acesso a todo o conteúdo disponível: o identificador de direito / API não é necessário
  • A Empresa B tem uma assinatura básica que dá acesso a alguns conteúdos e uma assinatura premium que dá acesso a conteúdos premium: Identificador de direito / API é obrigatório
  • A empresa C tem uma assinatura básica que dá acesso a alguns conteúdos e pacotes complementares que dão acesso a conteúdo de terceiros: Identificador de direito / API é obrigatório

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

Propriedades da oferta

Propriedade Tipo esperado Descrição
expectsAcceptanceOf.@type Texto Obrigatório: sempre definido como Offer.
expectsAcceptanceOf.price Número Obrigatório: o preço de compra do conteúdo. O preço precisa ser um valor positivo diferente de zero. Para entidades com preço 0,00, especifique a categoria como "sem custo financeiro".
expectsAcceptanceOf.priceCurrency Texto Obrigatório: é a moeda do preço no formato ISO 4217 de três letras.
expectsAcceptanceOf.seller Organização A organização que oferece a compra de conteúdo.
expectsAcceptanceOf.seller.@type Texto Sempre defina como Organization.
expectsAcceptanceOf.seller.name Texto O nome do vendedor.
expectsAcceptanceOf.seller.sameAs Texto O URL de uma página da Web que identifica o vendedor, por exemplo, a página inicial do vendedor.

Página relacionada à oferta

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

Identificadores

Os feeds de ação em mídia aceitam vários identificadores que podem ajudar a identificar uma entidade de maneira inequívoca. Esses identificadores podem ajudar a acelerar o processo de reconciliação do conteúdo do seu feed com o conteúdo dos bancos de dados do Google. Embora a maioria desses identificadores possa ser adicionada ao feed usando a propriedade identifier em vários tipos de entidade, os EIDRs têm a própria propriedade representativa. Ambas são discutidas abaixo.

Propriedades do identificador

Propriedade Tipo esperado Descrição
identifier Texto Altamente recomendado: um identificador, geralmente externo, que identifica de forma inequívoca uma determinada entidade. Vários identificadores são permitidos.

Essa propriedade está disponível em todos os tipos de entidade de ação de exibição.

A tabela abaixo lista os identificadores e subpropriedades aceitos da propriedade identifier. Consulte o Exemplo de identificador/EIDR na seção "Exemplos de feed de Watch Actions".
Propriedade Tipo esperado Descrição
@type Texto Obrigatório: sempre definido como PropertyValue.
propertyID Texto Obrigatório: aceitamos os seguintes tipos de ID:
  • TMS_ROOT_ID: o ID raiz da Gracenote (TMS), por exemplo, 15829.
    • Isso não é aplicável às entidades Organization e BroadcastService, em que apenas TMS_ID precisa ser usado.
  • TMS_ID: o ID da variante da Gracenote (TMS), por exemplo, MV000398520000.
  • WIKIDATA_ID: o ID do WikiData (por exemplo, Q134773).
  • IMDB_ID: o ID do IMDB (por exemplo, tt0109830).
  • OPTA_ID: o ID do OPTA Sports.
  • STATS_ID: o ID de execução de STATS.
  • VIP_TIMES_ID: o ID do Japão VIPTimes (Nihon Tarento Meikan) para talentos japoneses.
  • DMA_ID: o código da área de marketing designada dos EUA, usado no objeto GeoShape.
  • _PARTNER_ID_: essa propriedade precisa conter a string _PARTNER_ID_. O valor precisa ser um ID exclusivo usado por um provedor de serviços, internamente ou externamente, para identificar a entidade (por exemplo, 12345 ou a5c604e2-e9e5-4ff3-b728-245799dc37f1).
value Texto Obrigatório: o valor do sistema de identificação especificado.

Propriedades de EIDR

O EIDR (abreviação de "Registro de Identificador de Entretenimento") é um sistema de identificação globalmente exclusivo para uma ampla variedade de conteúdo de mídia, incluindo filmes e programas de televisão. O sistema de identificação resolve um identificador para um registro de metadados associado a títulos de nível superior, edições e muito mais. A tabela a seguir lista as propriedades associadas ao EIDR e o uso delas.

Propriedade Tipo esperado Descrição
titleEIDR Texto Altamente recomendado: um identificador EIDR (Registro de Identificador de Entretenimento) representa, no nível mais geral/abstrato, uma obra de cinema ou televisão.

Essa propriedade está disponível nas páginas de especificação de entidade TVSeries, TVSeason, TVEpisode e Movie.

Por exemplo, o titleEIDR do filme "Ghostbusters" é "10.5240/7EC7-228A-510A-053E-CBB8-J".

Consulte o exemplo de identificador/EIDR na seção "Exemplos de feeds de ações de visualização".
editEIDR Texto Altamente recomendado: um identificador EIDR (registro de identificador de entretenimento) representa uma edição específica de um filme ou programa de TV.

Essa propriedade está disponível nas páginas de especificação de entidade TVEpisode e Movie.

Por exemplo, o filme "Ghostbusters", cujo titleEIDR é "10.5240/7EC7-228A-510A-053E-CBB8-J", tem várias edições, por exemplo, "10.5240/1F2A-E1C5-680A-14C6-E76B-I" e "10.5240/8A35-3BEE-6497-5D12-9E4F-3". A propriedade titleEIDR é obrigatória quando editEIDR é fornecida.

Consulte o exemplo de identificador/EIDR na seção "Exemplos de feed de ações de exibição".

Agências de classificação de conteúdo

Use os valores nesta tabela para BroadcastService.contentRating, Movie.contentRating e TVSeries.contentRating. A agência de classificação precisa ser adicionada ao valor da classificação. Exemplos:

  • Um filme classificado como "R" nos EUA precisa ter um valor Movie.contentRating de "MPAA R".
  • Uma série de TV classificada como "TV-MA" nos EUA precisa ter um valor TVSeries.contentRating de "TV_PG TV-MA".

País Agência de classificação de TV Agência de classificação de filmes
Albânia (AL) Indisponível Indisponível
Angola (AO) Indisponível CCE
Antígua e Barbuda (AG) Indisponível MPAA
Argentina (AR) INCAA INCAA
Armênia (AM) Indisponível MKRF/RÚSSIA
Aruba (AW) Indisponível Indisponível
Austrália (AU) ACB TV Filmes da ACB
Áustria (AT) FSK FSK
Azerbaijão (AZ) Indisponível MKRF/RÚSSIA
Barein (BH) Indisponível MPAA
12345…12

Propriedades do GeoShape

Um objeto GeoShape contém um dos seguintes tipos de dados:

Propriedade Tipo esperado Descrição
@id URL Obrigatório: o identificador da região geográfica no formato URI.
@type Texto Obrigatório: sempre definido como GeoShape.
addressCountry Texto Obrigatório: o código de país ISO 3166-1 alfa-2 com duas letras.
postalCode Texto Opcional: lista de um ou mais códigos postais e/ou códigos de área de classificação direta (FSA, na sigla em inglês).
identifier PropertyValue Opcional: um ID da área designada do mercado (DMA, na sigla em inglês), que é um identificador de uma região nos Estados Unidos em que as pessoas recebem os mesmos canais e programas de televisão.
identifier.@type Texto Obrigatório: sempre definido como PropertyValue.
identifier.propertyID Texto Obrigatório: sempre definido como DMA_ID.
identifier.value Texto Obrigatório: o código da DMA da região.

Exemplo de objeto GeoShape que contém uma lista de códigos postais:

{
  "@type": "GeoShape",
  "@id": "http://example.com/area1",
  "addressCountry": "US",
  "postalCode": [
    "94118",
    "94119"
  ]
}

Exemplo de objeto GeoShape que contém uma combinação de FSA (área de classificação direta) e códigos postais:

{
  "@type": "GeoShape",
  "@id": "http://example.com/area2",
  "addressCountry": "CA",
  "postalCode": [
    "1A1",
    "K1A",
    "K1AOB1"
  ]
}

Exemplo de objeto GeoShape que contém um ID de DMA:

{
  "@type": "GeoShape",
  "@id": "http://example.com/area3",
  "addressCountry": "US",
  "identifier": [
    {
      "@type": "PropertyValue",
      "propertyID": "DMA_ID",
      "value": "501"
    }
  ]
}