Os usuários preferem assistir ou ouvir conteúdo que já podem acessar, como o conteúdo da assinatura. Se o Google souber o conteúdo que um usuário pode acessar no seu app ou plataforma, ele poderá criar um resultado de pesquisa ou resposta melhor para direcionar o usuário a esse conteúdo.

Identificar os requisitos de acesso ao conteúdo
É necessário identificar o requisito de acesso para cada pacote de conteúdo no catálogo. Ao fazer isso, considere as seguintes perguntas:
- Os usuários precisam fazer login no app ou na plataforma para acessar o conteúdo?
Os usuários precisam de uma assinatura?
Apenas Ações de assistir:
- Os usuários precisam de uma assinatura de um provedor de serviços externo?
- Você oferece uma assinatura em níveis, com vários pacotes ou complementos?
Apenas ações de visualização:os usuários precisam alugar ou comprar o conteúdo?
O requisito de acesso muda com o tempo?
O requisito de acesso depende da localização do dispositivo?
Tipos de restrição de acesso
Há dois tipos de restrições de acesso:
Tipo de paywall
É possível restringir o acesso ao conteúdo pelo tipo de paywall. A tabela a seguir detalha os diferentes tipos de paywall:
Tipo de paywall | Exemplo | Categoria |
---|---|---|
Não é necessário fazer login nem comprar nada. | Crackle | nologinrequired |
O usuário precisa estar conectado, mas não precisa ter uma assinatura paga. | Vudu (AVOD) | free |
O usuário precisa ter uma assinatura ativa. O acesso é independente do nível de assinatura. | Netflix |
|
O usuário precisa ter uma assinatura ativa. O acesso depende do nível de assinatura. | Hulu (complementos) |
|
O conteúdo fica disponível por um período limitado após a compra. | Vudu | rental |
O conteúdo fica disponível por um período indefinido após a compra. | Vudu | purchase |
O conteúdo está disponível por assinatura de TV a cabo. | HBO Go | externalSubscription |
Tipo de paywall para ações de assistir vídeos
Para especificar o tipo de paywall de conteúdo para ações de visualização, use a propriedade
category
na
especificação de acesso à ação:
"potentialAction": {
"@type":"WatchAction",
"target": { … },
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"availabilityStarts": "2018-06-01T10:35:29Z",
"availabilityEnds": "2019-05-31T10:35:29Z",
"eligibleRegion": {
"@type": "Country",
"name": "US"
}
},
...
}
Tipo de paywall para ações de ouvir conteúdo
Para especificar o tipo de paywall de conteúdo para ações de escuta, use a propriedade
category
no
objeto de oferta:
"potentialAction": {
"@type":"ListenAction",
"target": { … },
"expectsAcceptanceOf":{
"@type":"Offer",
"category":"subscription",
"availabilityStarts": "2018-06-01T10:35:29Z",
"availabilityEnds": "2019-05-31T10:35:29Z",
"eligibleRegion": {
"@type":"Country",
"name":"US"
}
},
...
}
Área geográfica
É necessário especificar as áreas geográficas em que o conteúdo está disponível. Use uma ou ambas das seguintes propriedades:
- A propriedade
eligibleRegion
de um objeto especificação de acesso de ação. Essa propriedade é obrigatória. - A propriedade
ineligibleRegion
de um objeto especificação de acesso de ação.
Um usuário pode acessar o conteúdo se o local do dispositivo estiver em qualquer região especificada em eligibleRegion
e não estiver em nenhuma região especificada em ineligibleRegion
.
As propriedades eligibleRegion
e ineligibleRegion
permitem os seguintes
valores:
- Uma lista de
Country
,City
eState
. - Um objeto
GeoShape
Consulte a seção PropriedadesGeoShape
para conferir os requisitos detalhados. - Uma lista de objetos
GeoShape
.
Se o conteúdo estiver disponível globalmente, use o seguinte valor especial para
eligibleRegion
:
"eligibleRegion": "EARTH",
Casos de uso de eligibleRegion
Confira abaixo exemplos de casos de uso da propriedade eligibleRegion
:
- Exemplo 1:
eligibleRegion
com uma lista de países. - Exemplo 2:
eligibleRegion
com um objetoGeoShape
que contém uma lista de CEPs. - Exemplo 3:
eligibleRegion
com um objetoGeoShape
que contém uma lista de códigos da área de classificação direta (FSA, na sigla em inglês). - Exemplo 4:
eligibleRegion
com um objetoGeoShape
que contém um ID de DMA. - Exemplo 5:
eligibleRegion
com uma lista de objetosGeoShape
. Cada um deles contém um ID de DMA. - Exemplo 6:
ineligibleRegion
com CEPs bloqueados.
Exemplo 1
eligibleRegion
com uma lista de países:
"actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "requiresSubscription": { "@type": "MediaSubscription", "@id": "http://www.example.com/north_america_network/subscription", "name": "Example Subscription", "commonTier": true }, "eligibleRegion": [ { "@type": "Country", "name": "US" }, { "@type": "Country", "name": "CA" } ] }
Exemplo 2
eligibleRegion
com um objeto GeoShape
que
contém uma lista de CEPs:
"actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "requiresSubscription": { "@type": "MediaSubscription", "@id": "http://www.example.com/local_tv_network/subscription", "name": "Example Subscription", "commonTier": true }, "eligibleRegion": { "@type": "GeoShape", "@id": "http://example.com/area1", "addressCountry": "US", "postalCode": [ "94118", "94119" ] } }
Exemplo 3
eligibleRegion
com um objeto GeoShape
que
contém uma lista de códigos da área de classificação direta (FSA):
"actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "requiresSubscription": { "@type": "MediaSubscription", "@id": "http://www.example.com/local_tv_network/subscription", "name": "Example Subscription", "commonTier": true }, "eligibleRegion":{ "@type": "GeoShape", "@id": "http://example.com/area2", "addressCountry": "CA", "postalCode": [ "1A1", "K1A" ] } }
Exemplo 4
eligibleRegion
com um objeto GeoShape
que
contém um ID de DMA:
"actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "requiresSubscription": { "@type": "MediaSubscription", "@id": "http://www.example.com/abcd/subscription", "name": "Example Subscription", "commonTier": true }, "eligibleRegion":{ "@type": "GeoShape", "@id": "http://example.com/area3", "addressCountry": "US", "identifier": [ { "@type": "PropertyValue", "propertyID": "DMA_ID", "value": "501" } ] } }
Example 5
eligibleRegion
com uma lista de objetos GeoShape
.
Cada uma contém um ID de DMA:
"actionAccessibilityRequirement" : { "@type" : "ActionAccessSpecification", "eligibleRegion" : [ { "@id" : "http://example.com/dma/601", "@type" : "GeoShape", "addressCountry" : "US", "identifier" : { "@type" : "PropertyValue", "propertyID" : "DMA_ID", "value" : "601" } }, { "@id" : "http://example.com/dma/602", "@type" : "GeoShape", "addressCountry" : "US", "identifier" : { "@type" : "PropertyValue", "propertyID" : "DMA_ID", "value" : "602" } } ] }
Exemplo 6
ineligibleRegion
com CEPs bloqueados:
"actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "requiresSubscription": { "@type": "MediaSubscription", "@id": "http://www.example.com/local_tv_network/subscription", "name": "Example Subscription", "commonTier": true }, "eligibleRegion": { "@type": "Country", "name": "US" }, "ineligibleRegion": { "@type": "GeoShape", "@id": "http://example.com/area1", "addressCountry": "US", "postalCode": [ "94118", "94119" ] } }
Identificador de direito
O identificador de direito, entitlementId
, se refere a uma string que representa
o acesso a um grupo de conteúdo no seu catálogo de mídia. Para determinar se um usuário
tem acesso ao seu conteúdo, o Google segue estas etapas:
- Fazemos uma chamada de API para seu endpoint de direitos para receber os identificadores de direitos do usuário.
- Procuramos os identificadores de direitos necessários do conteúdo no seu feed de ações de mídia.
- Fazemos a correspondência do
entitlementId
de um usuário com a propriedadeidentifier
do objeto media subscription no seu feed. Se pelo menos umentitlementId
corresponder, vamos determinar que o usuário pode acessar o conteúdo.

O Google recomenda que você use a seguinte sintaxe para entitlementId
:
<domain name> + colon (:) + <access level to content>
Exemplos de sintaxe:
example.com:basic
example.com:premium
example.com:sports
Exemplo de identificador de direito
O feed da MediaExampleCompany especifica que Movie XYZ
requer o
example.com:basic
entitlementId
, conforme mostrado:
{ "@context": ["http://schema.org", {"@language": "en"}], "@type": "Movie", "@id": "www.example.com/movie_xyz", "url": "www.example.com/movie_xyz", "name": "Movie XYZ", "potentialAction": { "@type": "WatchAction", "target": [ … ], "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "requiresSubscription": { "@type": "MediaSubscription", "@id": "http://www.example.com/basic_subscription", "name": "Basic subscription", "commonTier": true ... }, ... } }, ... }
Casos de uso comuns de acesso
Confira a seguir casos de uso comuns de acesso:
- Sem custo financeiro (sem necessidade de fazer login): o conteúdo está disponível sem login, assinatura ou compra.
- Sem custo financeiro (requer login): o conteúdo exige que os usuários façam login, mas não exige uma assinatura.
- Assinatura de camada única:o conteúdo exige uma assinatura. Todos os assinantes podem acessar o mesmo conteúdo, sejam filmes ou episódios, independentemente do pacote de assinatura.
- Assinatura em vários níveis:o conteúdo exige uma assinatura. Os assinantes podem acessar conteúdo diferente, seja filmes ou episódios, com base no nível da assinatura. Por exemplo, Prata em vez de Ouro.
- Assinatura do complemento:o conteúdo exige uma assinatura. Os assinantes podem adicionar conteúdo premium à assinatura normal.
- Compra única:o conteúdo pode ser comprado e, depois, o usuário pode acessá-lo indefinidamente.
- TV ao vivo:uma assinatura inclui acesso a canais locais, nacionais e premium.
- Assinatura de terceiros:o conteúdo exige que o usuário faça login com o provedor de cabo.
Sem custo financeiro (não é necessário fazer login)
Nenhum login necessário
O conteúdo está disponível sem login ou assinatura.
{ "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "nologinrequired", "availabilityStarts": "2015-01-01T00:00Z", "availabilityEnds": "2015-12-31T00:00Z", "eligibleRegion": { "@type": "Country", "name": "US" } } }
- Defina
category
comonologinrequired
. - Não inclua
expectAcceptanceOf
.
Sem custo financeiro (é necessário fazer login)
É necessário fazer login
O conteúdo exige que os usuários façam login, mas não requer uma assinatura.
{ "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "free", "availabilityStarts": "2015-01-01T00:00Z", "availabilityEnds": "2015-12-31T00:00Z", "eligibleRegion": { "@type": "Country", "name": "US" } } }
- Defina
category
comofree
. - Não inclua
expectAcceptanceOf
.
Assinatura de camada única
Em um modelo de assinatura de camada única, um provedor de serviços tem um nível de assinatura. Todos os assinantes podem acessar o mesmo conteúdo, seja filmes ou episódios, independentemente do pacote de assinatura.
{ "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "availabilityStarts": "2015-01-01T00:00Z", "availabilityEnds": "2015-12-31T00:00Z", "requiresSubscription": { "@type": "MediaSubscription", "name": "Example Package", "commonTier": true, "@id": "http://www.example.com/example_package" }, "eligibleRegion": { "@type": "Country", "name": "US" } } }
Assinatura de vários níveis
Em um modelo de assinatura em camadas, um provedor de serviços tem vários níveis de assinatura, como Gold, Silver e Bronze. Os usuários com a assinatura de nível superior podem acessar todo o conteúdo do nível inferior. No entanto, os usuários com a assinatura de nível inferior não podem acessar o conteúdo do nível superior.

Pense no seguinte cenário:
- Jane assina o nível Ouro. O endpoint de direitos
retorna os seguintes identificadores
entitlementId
:example.com:bronze
example.com:silver
example.com:gold
- João assina o nível Bronze. O endpoint de direitos
retorna o seguinte
entitlementId
:example.com:bronze
- O feed de Ações de mídia descreve os seguintes requisitos:
- Filme A requer
example.com:bronze
. - Filme B requer
example.com:silver
.
- Filme A requer
Nesse cenário, o Google determina os seguintes níveis de acesso para Joana e João:
- Joana e João têm acesso ao Filme A.
- Joana tem acesso ao Filme B, mas João não.
{ "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "requiresSubscription": { "@type": "MediaSubscription", "@id": "http://www.example.com/basic_subscription", "name": "Bronze", "commonTier": true ... }, ... } }
Assinatura de complemento
Em um modelo de assinatura de complementos, um provedor de serviços permite que os usuários ampliem os direitos e adicionem canais a uma assinatura básica. Os usuários podem adicionar quantos canais quiserem.

Pense no seguinte cenário:
- Jane tem PRO e Sportz, além da assinatura
Básica. O endpoint de direitos retorna os seguintes identificadores
entitlementId
:example.com:basic
example.com:pro
example.com:sportz
- João só tem a assinatura Básica. O endpoint de direitos
retorna o seguinte
entitlementId
:example.com:basic
- O feed de Ações de mídia descreve os seguintes requisitos:
- Filme A requer
example.com:basic
. - Filme B requer
example.com:pro
.
- Filme A requer
Nesse cenário, o Google determina os seguintes níveis de acesso para Joana e João:
- Joana e João têm acesso ao Filme A.
- Joana tem acesso ao Filme B, mas João não.
{ "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "availabilityStarts": "2015-01-01T00:00Z", "availabilityEnds": "2015-12-31T00:00Z", "eligibleRegion": { "@type": "Country", "name": "US" "requiresSubscription": [ { "@type": "MediaSubscription", "@id": "https://www.example.com/package/basic", "name": "Basic", "sameAs": "https://www.example.com/package/basic", "commonTier": true }, { "@type": "MediaSubscription", "@id": "https://www.example.com/packages/basic/pro", "name": "PRO", "sameAs": "https://www.example.com/package/pro", "identifier": "example.com:pro", "commonTier": false }, { "@type": "MediaSubscription", "@id": "https://www.example.com/package/sportz", "name": "Sportz", "sameAs": "https://www.example.com/package/sports", "identifier": "example.com:sportz", "commonTier": false } } } }
Compra única
Compras
O conteúdo fica disponível por um período indefinido após a compra.
{ "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "purchase", "availabilityStarts": "2015-01-01T00:00Z", "availabilityEnds": "2015-12-31T00:00Z", "eligibleRegion": { "@type": "Country", "name": "US" }, "expectsAcceptanceOf": { "@type": "Offer", "price": 7.99, "priceCurrency": "USD", "seller": { "@type": "Organization", "name": "Example", "sameAs": "http://www.example.com/" } } } }
- Defina
category
comopurchase
. - Inclua
expectAcceptanceOf
emactionAccessibilityRequirement
para indicar o preço da compra.
Aluguel
O conteúdo fica disponível por um período limitado após a compra.
{ "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "rental", "availabilityStarts": "2015-01-01T00:00Z", "availabilityEnds": "2015-12-31T00:00Z", "eligibleRegion": { "@type": "Country", "name": "US" }, "expectsAcceptanceOf": { "@type": "Offer", "price": 7.99, "priceCurrency": "USD", "seller": { "@type": "Organization", "name": "Example", "sameAs": "http://www.example.com/" } } } }
- Defina
category
comorental
. - Inclua
expectAcceptanceOf
emactionAccessibilityRequirement
para indicar o preço do aluguel.
TV ao vivo
Em um feed de ações de mídia, é possível restringir o acesso a um canal ou evento de TV ao vivo com base nas seguintes condições do usuário:
-
A localização do dispositivo do usuário
Para restringir o acesso ao canal de TV, especifique a área em que os usuários têm acesso a ele. Essa condição geralmente se aplica a canais de TV de transmissão locais.
-
O status da conta do usuário
Se o acesso a um canal de TV depender da configuração no nível da conta de um usuário, use identificadores de direito para representar a restrição.
Essa condição geralmente se aplica aos seguintes casos de uso:
- Pacote:os canais nacionais geralmente são incluídos em pacotes, e os usuários escolhem em qual pacote querem se inscrever.
- Complemento:alguns canais premium exigem que os usuários adicionem canais extras à assinatura.
- Rede esportiva regional (RSN, na sigla em inglês): as RSNs geralmente são associadas ao local "principal" de um usuário. Os usuários podem assistir conteúdo na RSN mesmo quando viajam para fora do local "de origem".
Assinatura de terceiros
Assinatura de terceiros
O conteúdo está disponível para os assinantes de um serviço diferente.
{ "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "externalsubscription" "availabilityStarts": "2015-01-01T00:00Z", "availabilityEnds": "2015-12-31T00:00Z", "requiresSubscription":{ "@type": "MediaSubscription", "@id": "https://www.example.com/faq", "name": "Example", "sameAs": "https://www.example.com/faq", "authenticator": { "@type": "Organization", "name": "TVE" } }, "eligibleRegion": { "@type": "Country", "name": "US" } } }
- Adicione
authenticator
para indicar que um serviço diferente autentica os assinantes. Por exemplo, o HBO GO exige uma assinatura do provedor de TV a cabo.
Pacotes de camada comuns
O conteúdo do nível comum está disponível para todos os assinantes, independente do
pacote de assinatura. O nível comum se aplica a todo o conteúdo com o category
de subscription
. Para mais informações sobre a propriedade category
, consulte a seção
Tipo de paywall.
Por que um pacote de nível comum é necessário?
Vários produtos do Google oferecem recomendações de filmes e programas de TV aos usuários, incluindo a Pesquisa Google, o Android TV e o Google Assistente. Para definir as expectativas dos usuários sobre o custo, o Google precisa entender qual conteúdo está disponível para todos os assinantes usando o nível comum. O Google também precisa entender qual conteúdo está disponível para assinantes com pacotes específicos.
O Google recomenda títulos disponíveis no nível comum, a menos que você ofereça suporte à API Entitlement. A API permite que o Google entenda os títulos de nível não comum que cada usuário pode acessar.
Quando devo criar um pacote de nível comum?
Um pacote de nível comum é necessário quando seu serviço oferece conteúdo disponível para todos os assinantes. Isso inclui serviços que oferecem apenas um pacote e serviços que oferecem vários pacotes ou complementos.
Os provedores que não têm conteúdo disponível para todos os assinantes não precisam criar um pacote de nível comum. Um exemplo são provedores de serviços que fornecem conteúdo mutuamente exclusivo em todos os pacotes.
Exemplos de níveis comuns
Confira a seguir alguns exemplos de camada comum.
Assinatura em camadas
Em um modelo de assinatura em camadas, um provedor de serviços tem vários níveis de assinatura, como Gold, Silver e Bronze. Os usuários com a assinatura de nível superior têm acesso a todo o conteúdo dos níveis mais baixos. Os usuários com a assinatura de nível inferior não têm acesso ao conteúdo do nível superior. A imagem a seguir é um exemplo da estrutura do pacote.

No exemplo de código abaixo, o pacote bronze é o nível comum porque todos os usuários têm acesso a todo o conteúdo nesse nível.
"requiresSubscription": [ { "@type": "MediaSubscription", "@id": "https://www.example.com/package/bronze", "name": "Bronze", "sameAs": "https://www.example.com/package/bronze", "commonTier": true }, { "@type": "MediaSubscription", "@id": "https://www.example.com/package/silver", "name": "Silver", "sameAs": "https://www.example.com/package/silver", "identifier": "example.com:silver", "commonTier": false }, { "@type": "MediaSubscription", "@id": "https://www.example.com/package/gold", "name": "Gold", "sameAs": "https://www.example.com/package/gold", "identifier": "example.com:gold", "commonTier": false } ],
Complementos
Em um modelo de assinatura de complementos, um provedor de serviços permite que os usuários expandam os direitos e adicionem canais a uma assinatura básica. Os usuários podem adicionar quantos canais quiserem. A imagem a seguir é um exemplo da estrutura do pacote.

Se você tiver um canal disponível para todos os usuários e não houver custo para o canal, poderá mesclar o pacote com o pacote de nível comum.
No exemplo de código abaixo, o pacote básico é o nível comum porque todos os usuários têm acesso a todo o conteúdo nesse pacote.
"requiresSubscription": [ { "@type": "MediaSubscription", "@id": "https://www.example.com/package/basic", "name": "Basic", "sameAs": "https://www.example.com/package/basic", "commonTier": true }, { "@type": "MediaSubscription", "@id": "https://www.example.com/packages/basic/pro", "name": "PRO", "sameAs": "https://www.example.com/package/pro", "identifier": "example.com:pro", "commonTier": false }, { "@type": "MediaSubscription", "@id": "https://www.example.com/package/sportz", "name": "Sportz", "sameAs": "https://www.example.com/package/sports", "identifier": "example.com:sportz", "commonTier": false }, { "@type": "MediaSubscription", "@id": "https://www.example.com/package/moviemax", "name": "Moviemax", "sameAs": "https://www.example.com/package/moviemax", "identifier": "example.com:moviemax", "commonTier": false } ],
Pacotes com conteúdo que se sobrepõe
Em um modelo de conteúdo em que os pacotes têm conteúdo que se cruza, um provedor de serviços vende pacotes que incluem algum conteúdo de outros pacotes. A imagem a seguir é um exemplo da estrutura do pacote.

No exemplo de código abaixo, o provedor oferece três pacotes em que parte do conteúdo se cruza em todos os pacotes. Nesse caso, um quarto pacote que represente o nível comum é necessário. Ele precisa incluir todo o conteúdo disponível nos três pacotes.
"requiresSubscription": [ { "@type": "MediaSubscription", "@id": "https://www.example.com/package/1", "name": "Package 1", "sameAs": "https://www.example.com/package/1", "identifier": "example.com:package1", "commonTier": false }, { "@type": "MediaSubscription", "@id": "https://www.example.com/package/2", "name": "Package 2", "sameAs": "https://www.example.com/package/2", "identifier": "example.com:package2", "commonTier": false }, { "@type": "MediaSubscription", "@id": "https://www.example.com/package/3", "name": "Package 3", "sameAs": "https://www.example.com/package/3", "identifier": "example.com:package3", "commonTier": false }, { "@type": "MediaSubscription", "@id": "https://www.example.com/package/common", "name": "Common Tier Package", "sameAs": "https://www.example.com/package/common", "commonTier": true } ],
Pacotes sem conteúdo que se cruza
Em um modelo de conteúdo em que todos os pacotes de conteúdo não se cruzam, um provedor de serviços vende pacotes que não incluem conteúdo de outros pacotes. A imagem a seguir é um exemplo da estrutura do pacote.

No exemplo abaixo, o provedor oferece três pacotes sem conteúdo que se cruzam em todos os pacotes. Não é necessário um pacote de nível comum.
"requiresSubscription": [ { "@type": "MediaSubscription", "@id": "https://www.example.com/package/1", "name": "Package 1", "sameAs": "https://www.example.com/package/1", "identifier": "example.com:package1", "commonTier": false }, { "@type": "MediaSubscription", "@id": "https://www.example.com/package/2", "name": "Package 2", "sameAs": "https://www.example.com/package/2", "identifier": "example.com:package2", "commonTier": false }, { "@type": "MediaSubscription", "@id": "https://www.example.com/package/3", "name": "Package 3", "sameAs": "https://www.example.com/package/3", "identifier": "example.com:package3", "commonTier": false } ],
Endpoint de direitos
Use as informações desta seção para hospedar um endpoint HTTPS que retorne os direitos associados a um usuário.
Pré-requisito
Antes de começar, verifique se o serviço oferece suporte ao fluxo do OAuth 2.0 com o Google.
Solicitação
Para receber os direitos de um usuário, o Google envia uma solicitação que contém o token OAuth do usuário. O endpoint precisa identificar o usuário com base no token do OAuth. Veja o exemplo a seguir:
GET /resource HTTP/1.1
Host: server.example.com
Authorization: Bearer <OAuthToken>
Resposta
O endpoint precisa retornar uma resposta com as seguintes propriedades:
Propriedade | |
---|---|
subscription |
Obrigatório Esse é um campo dentro da resposta raiz. |
subscription.type |
Obrigatório Essa propriedade pode ter os seguintes valores:
|
subscription.expiration_date |
Opcional A data de validade desse direito, no formato ISO 8601, que inclui o fuso horário. Para mais detalhes, consulte Datas de validade. |
entitlements |
Opcional Essa é uma propriedade raiz que contém os valores |
entitlements.entitlement |
Obrigatório se o acesso ao seu catálogo de streaming varia de acordo com o tipo de assinatura. Essa propriedade contém o |
entitlements.expiration_date |
Opcional A data de validade dessa assinatura, no formato ISO 8601, que inclui o fuso horário. Para mais detalhes, consulte Datas de validade. |
Datas de vencimento
Há duas propriedades em uma resposta de endpoint que lidam com datas de
vencimento: subscription.expiration_date
e entitlements.expiration_date
. Você
pode incluir um deles ou nenhum, mas não ambos. A escolha depende do
modelo de assinatura.
Modelo de assinatura | |
---|---|
O acesso ao seu catálogo de streaming é o mesmo para todos os assinantes. | Como não é necessário especificar a propriedade entitlements , especifique subscription.expiration_date . |
O acesso ao seu catálogo de streaming varia de acordo com os detalhes da assinatura do usuário. |
Se o modelo de assinatura tiver vários níveis ou complementos que expiram com o tempo, faça o seguinte:
|
Exemplos de respostas
Confira abaixo exemplos de respostas de diferentes estados de assinatura:
- Inscrição ativa
- Assinatura ativa com data de validade
- Sem assinatura
- Assinaturas ativas em várias camadas ou complementos
Inscrição ativa
Assinatura ativa
Um usuário tem uma assinatura ativa do example.com. Nesse caso, todos os assinantes têm acesso a todo o catálogo de streaming, independente do tipo de assinatura.
{ "subscription" : { "type": "ActiveSubscription", } }
Assinatura ativa com data de validade
Assinatura ativa com data de validade
Um usuário tem uma assinatura ativa do example.com, e a assinatura tem uma data de validade. Nesse caso, todos os assinantes têm acesso a todo o catálogo de streaming, independente do tipo de assinatura.
{ "subscription" : { "type": "ActiveSubscription", "expiration_date": "2019-11-10T10:00:00Z" } }
Sem assinatura
Sem assinatura
Um usuário não tem uma assinatura do example.com.
{ "subscription" : { "type": "InactiveSubscription" } }
Assinaturas ativas em várias camadas ou complementos
Assinaturas ativas em vários níveis ou complementos
Um usuário tem uma assinatura do example.com:premium
até uma determinada data.
{ "subscription" : { "type": "ActiveSubscription", } "entitlements": [ { "entitlement": "example.com:premium", "expiration": "2019-11-10T10:00:00Z" } ] }
Limite de taxa
O Google atualiza as informações de direitos de um usuário a cada seis horas. Para evitar o máximo de consultas por segundo (QPS), o Google distribui as consultas para o endpoint de maneira uniforme ao longo do tempo. Assim, você pode estimar o QPS médio esperado para seu endpoint com a seguinte fórmula:
QPS médio esperado = <número total de usuários> / 21.600 segundos (6 horas x 60 minutos x 60 segundos)
Se você atende a um grande número de usuários, o Google pode ajustar o intervalo de seis horas. Se necessário, entre em contato com o Google para discutir a configuração.
Entrar em contato com o Google
Quando o endpoint estiver pronto, entre em contato com o Google para informar o URL dele.
Propriedades de especificação de acesso a ações
Consulte a seção Propriedades de especificação de acesso à ação para informações de referência.