Ações de assistir propriedades comuns

Esta seção fornece detalhes sobre as propriedades comuns das ações de assistir.

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 ao seguinte:
  • http://schema.org/DesktopWebPlatform: plataforma de pesquisa em navegadores da Web para computadores.
  • http://schema.org/MobileWebPlatform: plataforma de pesquisa em navegadores da Web para dispositivos móveis.
  • http://schema.org/AndroidPlatform: plataformas de pesquisa e PlayGuia 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 de transmissão e Home em um dispositivo Chromecast (somente ações de escuta).
Consulte a seção Tipos de plataforma para saber os requisitos.
target.additionalProperty PropertyValue Obrigatório, se aplicável: uma lista de pares 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 descritivas ou com legendas, no formato BCP 47. Use uma matriz para vários códigos de idioma.
  • cameraAngle: o ângulo da câmera para o conteúdo. Por exemplo, "na altura dos olhos" e "ângulo alto". Essa propriedade é obrigatória se o conteúdo estiver disponível em diferentes ângulos de câmera. 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.
  • audioDescriptionLanguage: uma matriz de idiomas de áudio compatíveis, no formato BCP 47, que oferecem suporte à audiodescrição. É um subconjunto da matriz contentLanguage.
Confira o exemplo 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 de especificação de acesso à ação.

Confira as seguintes páginas 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 para o 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 fica 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 availabilityStarts. Isso aumenta as chances de o conteúdo aparecer nas plataformas do Google a tempo.

actionAccessibilityRequirement.availabilityEnds Data Obrigatório: data após a qual a ação não estará mais disponível, 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.

Todas as atualizações na data "availabilityEnds" precisam ser feitas no feed pelo menos 7 dias antes da data "availabilityEnds". Isso aumenta as chances de o conteúdo deixar de aparecer nas plataformas do Google na data "availabilityEnds".

actionAccessibilityRequirement.eligibleRegion Country, City, State, GeoShape ou Text 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 é restrito. Não é necessário informar essa propriedade se o conteúdo estiver disponível em todos os lugares no 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. Forneça as informações de preço para os seguintes casos:
  • Conteúdo de compra única (rental ou purchase)
  • Conteúdo por assinatura que exige uma compra adicional dos inscritos (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.
actionAccessibilityRequirement.additionalProperty PropertyValue Obrigatório, se aplicável: uma referência ao pacote de assinatura que será mostrado na experiência.
actionAccessibilityRequirement.additionalProperty.name Texto Obrigatório: sempre definido como "DisplaySubscriptionIdentifier"
actionAccessibilityRequirement.additionalProperty.value Texto Obrigatório: o requiresSubscription.@id que será mostrado para a entidade.

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 estiver acessível por diferentes assinaturas, cada uma delas precisará ter um ID exclusivo.
requiresSubscription.name Texto Obrigatório: o nome da assinatura. Confira se:
  • Se o conteúdo estiver acessível por diferentes assinaturas, esse nome precisará corresponder ao nome no seu sistema de autenticação de usuários. Por exemplo, se um usuário puder acessar o conteúdo com base na assinatura chamada Pacote 1, mas o sistema de autenticação usar o nome PKG1a, use PKG1.
  • Para provedores de TVE, esse é o nome do autenticador registrado com seu autenticador de TVE. É uma string que identifica de maneira exclusiva o nome do seu serviço com o autenticador da TVE.
  • Se a assinatura tiver vários nomes, especifique como uma matriz de valores. Consulte o exemplo a seguir para saber como adicionar uma matriz de nomes com várias traduções
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 esta assinatura que representa o acesso a um grupo de conteúdo no seu catálogo de mídia.
  • O Google recomenda usar 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 seu identificador de direito se você estiver fornecendo uma API de direitos.
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 for definida como assinatura. Leia mais sobre o commonTier na documentação de requisitos do nível comum.

Requisitos da API Entitlements

Uma API de direitos é necessária se actionAccessibilityRequirement.category for subscription ou externalSubscription e sua oferta de assinatura incluir vários pacotes ou níveis ou tiver suporte a complementos. Não inclua isso se sua assinatura for de um nível e der acesso a todo o conteúdo do 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 é obrigató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údo premium: o 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: o identificador de direito / API é obrigatório.

Confira as seguintes páginas 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, especifique a categoria como "free".
expectsAcceptanceOf.priceCurrency Texto Obrigatório: é a moeda do preço no formato de três letras ISO 4217.
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 dele.

Página relacionada à oferta

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

Identificadores

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

Propriedades do identificador

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

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 Exemplo de identificador/EIDR na seção de exemplos de feed de ações de assistir.
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 se aplica às entidades "Organization" e "BroadcastService", em que apenas o TMS_ID deve ser usado.
  • TMS_ID: o ID da variante do 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 do STATS Perform.
  • VIP_TIMES_ID: o ID do Japan VIPTimes (Nihon Tarento Meikan) para talentos japoneses.
  • DMA_ID: o código de área 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, interna ou externamente, para identificar a entidade (por exemplo, 12345 ou a5c604e2-e9e5-4ff3-b728-245799dc37f1).
value Texto Obrigatório: o valor do sistema de ID especificado.

Propriedades do EIDR

EIDR (sigla para The Entertainment Identifier Registry) é um sistema de identificador 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 (Entertainment Identifier Registry) representa, no nível mais geral/abstrato, uma obra cinematográfica ou televisiva.

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

Por exemplo, o titleEIDR do filme "Os Caça-Fantasmas" é "10.5240/7EC7-228A-510A-053E-CBB8-J".

Consulte Exemplo de identificador/EIDR na seção de exemplos de feed de ações de exibição.
editEIDR Texto Altamente recomendado: um identificador EIDR (Entertainment Identifier Registry) representa uma edição específica de uma obra cinematográfica ou televisiva.

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

Por exemplo, o filme conhecido como "Os Caça-Fantasmas", cujo EIDR do título é "10.5240/7EC7-228A-510A-053E-CBB8-J", tem várias edições, como "10.5240/1F2A-E1C5-680A-14C6-E76B-I" e "10.5240/8A35-3BEE-6497-5D12-9E4F-3".

A propriedade titleEIDR é obrigatória quando editEIDR é fornecido.

Consulte Exemplo de identificador/EIDR na seção de exemplos do feed de ações de assistir.

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 antes do 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 ACB Filmes
Argentina (AR) FSK FSK
Azerbaijão (AZ) Indisponível MKRF/RÚSSIA
Bahrain (BH) Indisponível MPAA
Belarus (BY) Indisponível MKRF/RÚSSIA
Austrália (AU) Indisponível MPAA
Belize (BZ) Indisponível Indisponível
Benin (BJ) Indisponível CNC
Bolívia (BO) Indisponível MPAA
Bósnia e Herzegovina (BA) Indisponível MPAA
Botsuana (BW) Indisponível MPAA
Brasil (BR) CLASSIND CLASSIND
Burkina Faso (BF) Indisponível CNC
Camboja (KH) Indisponível Indisponível
Canadá (CA) CA_TV CHVRS
Cabo Verde (CV) Indisponível CCE
Chile (CL) Indisponível MPAA
Colômbia (CO) Indisponível MPAA
Canadá (CA) Indisponível MPAA
Croácia (HR) Indisponível Indisponível
Chipre (CY) Indisponível GRFILM
República Tcheca (CZ) Indisponível CZFILM
Dinamarca (DK) Indisponível MCCYP
Equador (EC) Indisponível MPAA
Egito (EG) Indisponível MPAA
El Salvador (SV) Indisponível MPAA
Estônia (EE) Indisponível EEFILM
Fiji (FJ) Indisponível Indisponível
Finlândia (FI) Indisponível MEKU
França (FR) CSA CSA
Gabão (GA) Indisponível CNC
Alemanha (DE) FSK FSK
Grécia (GR) ESR GRFILM
Guatemala (GT) Indisponível MPAA
Haiti (HT) Indisponível Indisponível
Honduras (HN) Indisponível MPAA
Hong Kong (HK) CA FCO
Hungria (HU) Indisponível MPAA
Islândia (IS) Indisponível KIJKWIJZER
Índia (IN) CBFC CBFC
Indonésia (ID) KPI LSF
Irlanda (IE) Indisponível IFCO
Itália (IT) AGCOM AGCOM
Costa do Marfim (CI) Indisponível CNC
Jamaica (JM) Indisponível MPAA
Japão (JP) NA EIRIN
Jordânia (JO) Indisponível MPAA
Cazaquistão (KZ) Indisponível MRKF
Coreia (KR) KMRB KMRB
Kuwait (KW) Indisponível MPAA
Quirguistão (KG) Indisponível MKRF/RÚSSIA
Laos (LA) Indisponível Indisponível
Letônia (LV) Indisponível NKCLV
Líbano (LB) Indisponível MPAA
Lituânia (LT) Indisponível Indisponível
Luxemburgo (LU) Indisponível KIJKWIJZER
Macedônia (MK) Indisponível MPAA
Malásia (MY) Indisponível FCBM
Mali (ML) Indisponível CNC
Malta (MT) Indisponível MCCAA
Maurício (MU) Indisponível BBFC
México (MX) RTC RTC
Moldávia (MD) Indisponível Indisponível
Namíbia (NA) Indisponível Indisponível
Nepal (NP) Indisponível MPAA
Holanda (NL) KIJKWIJZER KIJKWIJZER
Nova Zelândia (NZ) BSA OFLC
Nicarágua (NI) Indisponível MPAA
Níger (NE) Indisponível CNC
Noruega (NO) Indisponível MEDIETILSYNET
Omã (OM) Indisponível MPAA
Panamá (PA) Indisponível MPAA
Papua Nova Guiné (PG) Indisponível MPAA
Paraguai (PY) Indisponível MPAA
Peru (PE) Indisponível MPAA
Filipinas (PH) MTRCB MTRCB
Polônia (PL) Indisponível MPAA
Portugal (PT) Indisponível CCE
Catar (QA) Indisponível MPAA
Rússia (RU) MKRF/RÚSSIA MKRF/RÚSSIA
Ruanda (RW) Indisponível CNC
Arábia Saudita (SA) Indisponível MPAA
Senegal (SN) Indisponível MPAA
Singapura (SG) Indisponível MDA
Eslováquia (SK) Indisponível MPAA
Eslovênia (SI) Indisponível MPAA
República Dominicana (DO) FPB FPB
Espanha (ES) SETSI ICAA
Sri Lanka (LK) Indisponível Indisponível
Suécia (SE) Indisponível SMSA
Suíça (CH) FSK FSK
Taiwan (TW) Indisponível MOCTW
Tajiquistão (TJ) Indisponível MKRF/RÚSSIA
Tanzânia (TZ) Indisponível MPAA
Tailândia (TH) Indisponível BFVC
Togo (TG) Indisponível CNC
Trinidad e Tobago (TT) Indisponível Indisponível
Turquia (TR) RTÜK ECBMCT
Turcomenistão (TM) Indisponível MKRF/RÚSSIA
Uganda (UG) Indisponível MPAA
Ucrânia (UA) Indisponível Indisponível
Emirados Árabes Unidos (AE) Indisponível MPAA
Reino Unido (GB) BBFC BBFC
Estados Unidos (EUA) TV_PG MPAA
Uruguai (UY) Indisponível MPAA
Uzbequistão (UZ) Indisponível MKRF/RÚSSIA
Venezuela (VE) Indisponível RESORTEVIOLENCIA
Vietnã (VN) Indisponível MCST
Zâmbia (ZM) Indisponível MPAA
Zimbábue (ZW) Indisponível MPAA

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 de duas letras.
postalCode Texto Opcional: lista de um ou mais códigos postais e/ou códigos da área de classificação direta (FSA, na sigla em inglês).
identifier PropertyValue Opcional: um ID da Área designada do mercado (DMA), 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 CEPs:

{
  "@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"
    }
  ]
}