Suporte de atividades para anúncios em tela cheia

O SDK Runtime impõe restrições sobre como os SDKs podem iniciar novas atividades. Isso representa um desafio para formatos de anúncio em tela cheia, que normalmente dependem do início de uma atividade separada para melhorar o controle e a experiência do usuário. Para resolver isso, o SDK Runtime apresenta um novo mecanismo para atividades em sandbox.

Os SDKs carregados no ambiente do SDK Runtime não podem definir diretamente tags <activity> no manifesto nem iniciar as próprias atividades. Em vez disso, uma nova ação de intent, START_SANDBOXED_ACTIVITY, foi introduzida.

Embora os SDKs também estejam restritos a iniciar intents com essa ação, eles podem solicitar que o app cliente inicie essa intent. Em seguida, o sistema cria uma atividade definida pela plataforma e a transmite ao SDK. Essa atividade será executada no mesmo processo do SDK.

Em seguida, o SDK pode usar essa atividade para implementar e gerenciar a experiência de anúncio em tela cheia.

A atividade fornecida pela plataforma é um android.app.Activity padrão, iniciado como parte da tarefa do app cliente.

Criação de atividades no SDK Runtime

Você tem dois métodos principais para criar atividades: usar as bibliotecas de atividades do Jetpack ou interagir diretamente com as APIs da plataforma.

Recomendamos o uso de bibliotecas de atividades, porque elas simplificam a criação de atividades ao abstrair a complexidade subjacente.

Bibliotecas de atividades

As bibliotecas de atividades oferecem várias vantagens:

Abstrai os detalhes internos do registro de manipuladores de atividades e do compartilhamento dos identificadores deles com apps cliente.
Oferece aos desenvolvedores de apps mais controle sobre como os SDKs criam atividades nos apps, permitindo que eles definam condições (predicados) a serem atendidas.
Criar uma maneira unificada para os SDKs definirem APIs que iniciam atividades.

Há três bibliotecas de atividades: principal, de cliente e de provedor.

A biblioteca core fornece as interfaces usadas por apps clientes e bibliotecas de provedor.
A biblioteca provider fornece APIs para os SDKs iniciarem atividades.
A biblioteca cliente fornece APIs para que apps cliente criem um iniciador de atividades, que os SDKs podem usar para solicitar que os apps iniciem atividades.

Essas bibliotecas introduzem as seguintes APIs:

SdkActivityLauncher: o iniciador de atividades permite que os SDKs processem o início de atividades no app cliente. Os apps clientes precisam criar um iniciador e transmiti-lo como um parâmetro para as APIs do SDK que iniciam atividades.
<T : Activity & LifecycleOwner> T.createSdkActivityLauncher(() -> Boolean ): uma função de extensão que o app cliente pode chamar das atividades dele para criar inicializadores.
SdkActivityLauncher.launchSdkActivity(IBinder): um método usado pelo SDK para solicitar que o app inicie atividades.

O fluxo de atividades de inicialização com bibliotecas de atividades é o seguinte:

O SDK adiciona um parâmetro do tipo SdkActivityLauncher a qualquer API que inicie atividades.
O app cliente chama createSdkActivityLauncher em uma das atividades para criar um iniciador que pode ser transmitido ao SDK em chamadas de API.
O SDK chama SdkSandboxControllerCompat.registerSdkSandboxActivityHandler(SdkSandboxActivityHandlerCompat) e recupera o token de identificador.
O SDK chama launchSdkActivity para iniciar a atividade.

O diagrama a seguir mostra o fluxo ao usar bibliotecas de atividades.

Diagrama de sequência da biblioteca de atividades — Diagrama de sequência mostrando o fluxo de início de uma atividade usando bibliotecas de atividades.

APIs da plataforma

A plataforma apresenta as seguintes APIs para facilitar a criação e o gerenciamento de atividades em sandbox no SDK Runtime:

SdkSandboxActivityHandler: O gerenciador de atividades é usado para notificar o SDK quando uma atividade é criada e registrada por ele.
Para ajudar no registro de manipuladores de atividades, o SDK pode usar os seguintes métodos em SdkSandboxController:
- .registerSdkSandboxActivityHandler(SdkSandboxActivityHandler): registra uma instância de SdkSandboxActivityHandler, que retorna um identificador IBinder.
- .unregisterSdkSandboxActivityHandler(SdkSandboxActivityHandler): cancela o registro de uma instância registrada de SdkSandboxActivityHandler usando o identificador dela.
SdkSandboxManager.startSdkSandboxActivity(Activity, IBinder): invocado pelo app cliente, esse método aciona a criação de atividades para o SDK. O app cliente precisa transmitir como parâmetros a atividade inicial escolhida e o identificador do gerenciador de atividades do SDK.

Para iniciar uma atividade usando as APIs da plataforma, os SDKs precisam seguir este fluxo:

O SDK registra um manipulador de atividades usando as APIs fornecidas e recebe um identificador.
O SDK compartilha esse identificador com o app cliente.
O app cliente chama o método para iniciar uma atividade no SDK Runtime com a API da plataforma startSdkSandboxActivity(Activity, IBinder), transmitindo como parâmetros a atividade inicial escolhida para essa nova atividade e o identificador do manipulador de atividades.
A plataforma inicia uma atividade e notifica o SDK por um callback no manipulador de atividades (SdkSandboxActivityHandler.onActivityCreated(Activity)).
O SDK usa a atividade para preenchê-la com um anúncio.

Ao usar as APIs da plataforma, o SDK é responsável por compartilhar o identificador do SdkSandboxActivityHandler com o app cliente pelas APIs no momento adequado e orientar os apps clientes sobre como usá-lo.

No diagrama de fluxo a seguir, o SDK de exemplo tem um método launchActivity(AppCallback) que espera um callback (definido como parte da API do SDK). Esse callback é usado pelo SDK para compartilhar o identificador do Activity Handler (SdkSandboxActivityHandler) com o app cliente.

Diagrama de sequência das APIs da plataforma — Diagrama de sequência mostrando o fluxo de início de uma atividade usando APIs da plataforma.

Visibilidade

No SDK Runtime, os anúncios integrados à hierarquia de visualização do app cliente usam canais laterais para renderizar visualizações do SDK do processo do SDK para o processo do app cliente.

O SDK não pode usar as mesmas APIs View usadas fora do SDK Runtime para determinar se o anúncio está visível para o usuário, já que a visualização do anúncio não está anexada à janela do aplicativo (visibilidade).

Em contraste, a atividade fornecida pela plataforma é executada nativamente no processo do SDK Runtime, eliminando a necessidade de canais laterais e permitindo que os SDKs usem as APIs padrão Activity e View do Android.

Devido a essas diferentes implementações, os esforços contínuos visam unificar as interfaces para recuperar os indicadores de visibilidade, seja qual for o contexto de carregamento do anúncio.

Ciclo de vida

O ActivityHolder transmitido ao SDK por SdkSandboxActivityHandlerCompat.onActivityCreated(ActivityHolder) implementa LifecycleOwner e pode ser usado para saber sobre o Lifecycle.Event.

Navegação de retorno

O método ActivityHolder.getOnBackPressedDispatcher() retorna OnBackPressedDispatcher que pode ser usado para registrar instâncias OnBackPressedCallback para processar a navegação de volta.