Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
A API de seleção de anúncios fornece anúncios relevantes para o usuário em seu site, sem usar cookies de terceiros.
Conteúdo detalhado:
- Introdução
- Registro de atestado e inscrição alfa
- Implantar os serviços da API de Seleção de Anúncio
- Usar a API de Seleção de Anúncio em seu site
- Forneça comentários sobre a avaliação de origem
- Termos de Uso
- Adendo de Proteção de Dados
- Confira também
Introdução
A API de seleção de anúncios fornece anúncios relevantes para o usuário em seu site, sem usar cookies de terceiros.
A API de Seleção de Anúncio pode ser usada por:
Vendedores que executam uma plataforma do lado da oferta (SSP), que podem usar a API para fornecer anúncios de maior qualidade para seus editores.
Compradores que executam uma plataforma de demanda (DSP), que podem usar a API para melhorar a eficácia das campanhas publicitárias.
Para começar a usar a API de Seleção de Anúncio e testar o fluxo de ponta a ponta, inscreva-se na visualização limitada da API de Seleção de Anúncio.
Como vendedor operando uma plataforma do lado da oferta ou comprador operando uma plataforma do lado da demanda, use este guia para:
- Forneça anúncios relevantes para o usuário com a visualização limitada da API de Seleção de Anúncios registrando-se para a avaliação de origem.
- Conclua o atestado de API publicando o arquivo JSON dos atestados.
- Configure um ambiente de avaliação com um provedor de nuvem compatível.
- Exiba a documentação da API de Seleção de Anúncio.
- Prepare suas funções User-Defined (UDFs).
- Implante seus serviços no Azure.
- Teste a API de seleção de anúncio em seu site.
Veja também:
-
Visão geral da seleção de anúncio no
privacy-preserving-adsrepositório.
Registro de atestado e inscrição alfa
Quando e onde a visualização estará disponível?
As versões do Microsoft Edge começando com 130.0.2808.0 têm suporte para a API de Seleção de Anúncio em uma versão prévia limitada de aceitação do desenvolvedor fora do Espaço Econômico Europeu (EEE) e do Reino Unido (Reino Unido).
Sinalizadores para teste
Para alterar os recursos da plataforma da API de Seleção de Anúncios em seu computador de desenvolvedor, use os sinalizadores de teste da API de Seleção de Anúncios em:edge://flags#edge-ad-selection-api
O sinalizador da API de Seleção de Anúncio habilita a API de Seleção de Anúncio e recursos associados, como:
- Relatório de atribuição.
- Quadros cercados.
- Armazenamento Compartilhado.
- Agregação privada.
Requisitos e processo de inscrição e atestado
Os desenvolvedores interessados no teste alfa podem participar da avaliação de origem da API de Seleção de Anúncios. Essa avaliação de origem permite testes de ponta a ponta dos recursos da API de Seleção de Anúncios, abrangendo o uso da API e a implantação de imagens de contêiner seguras.
Para cada domínio de nível superior que você pretende usar com a API Ad Selection, preencha o formulário de registro da avaliação de origem para esse domínio e envie o formulário.
Para se inscrever na avaliação de origem da API de Seleção de Anúncio para um domínio:
Primeiro, execute as etapas em Testar APIs e recursos experimentais usando avaliações de origem.
Em seguida, crie um arquivo chamado
ad-selection-attestations.jsone hospede-o no domínio de nível superior, no/.well-known/diretório. Por exemplo:https://contoso.example/.well-known/ad-selection-attestations.jsonO
ad-selection-attestations.jsonarquivo deve ser publicado dentro de 30 dias após o recebimento do token OT. A hospedagem desse arquivo JSON é necessária para concluir seu atestado e permitir que seu código acesse a API de Seleção de Anúncios, para testar a API de Seleção de Anúncios com clientes Microsoft Edge com suporte.
Arquivo JSON de exemplo
O arquivo JSON de atestados deve ser nomeado ad-selection-attestations.jsone deve estar em conformidade com os seguintes padrões abaixo. Veja a seguir um exemplo de arquivo ad-selection-attestations.json :
{
"ad_selection_api_attestations": [
{
"attestation_parser_version": "2",
"attestation_version": "2",
"privacy_policy": [
"https://contoso.example/privacy/"
],
"ownership_token": "<Your Unique Token Here>",
"enrollment_site": "https://contoso.example/",
"platform_attestations": [
{
"platform": "edge",
"attestations": {
"ad_selection_api": {
"ServiceNotUsedForIdentifyingUserAcrossSites": true/false
},
"attribution_reporting_api": {
"ServiceNotUsedForIdentifyingUserAcrossSites": true/false
},
"shared_storage_api": {
"ServiceNotUsedForIdentifyingUserAcrossSites": true/false
},
"private_aggregation_api": {
"ServiceNotUsedForIdentifyingUserAcrossSites": true/false
}
}
},
{
"platform": "android",
"attestations": {}
}
]
}
]
}
Campos e valores importantes
O
ad-selection-attestations.jsonarquivo deve incluir o token de avaliação de origem gerado e enviado a você para esse domínio de nível superior."ownership_token":é o token de avaliação de origem gerado ao registrar este domínio para a avaliação de origem da API de Seleção de Anúncios .Na
"platform_attestations":seção,"platform":deve ser"edge"ou"android".O arquivo deve incluir uma lista de APIs (recursos associados à API de Serviços de Anúncios).
"platform_attestations":Na seção, os membros válidos de"attestations":são os seguintes:-
"ad_selection_api":- A API principal, para lógica de leilão privado. -
"attribution_reporting_api":- Relatórios de atribuição. -
"shared_storage_api":- Armazenamento compartilhado. -
"private_aggregation_api":- Agregação privada. - Requisitos:
- Cada
"..._api":entrada deve ter um único campo,"ServiceNotUsedForIdentifyingUserAcrossSites":, com umtruevalor oufalse.truesignifica que esse serviço não é usado para identificar o usuário em vários sites.falsesignifica que esse serviço é usado para identificar o usuário em vários sites.
- Cada
-
Implantar os serviços da API de Seleção de Anúncio
A API de Seleção de Anúncio usa um ambiente de execução confiável (TEE) para fornecer um nível de garantia de integridade de dados, confidencialidade de dados e integridade de código; consulte Computação confidencial: Hardware-Based execução confiável para aplicativos e dados. Os serviços fornecidos pela API de Seleção de Anúncios devem ser executados em um TEE para proteger os dados usados por esses serviços.
Seleção de anúncios Os serviços executados em um TEE devem ser implantados em uma plataforma de nuvem que dê suporte aos recursos de segurança necessários. Inicialmente, os serviços podem ser implantados no Azure usando contêineres ACI confidenciais; consulte Contêineres confidenciais em Instâncias de Contêiner do Azure.
A API Ad Selection fornece diferentes serviços que precisam ser implantados por vendedores ou compradores.
Imagens para implantação de serviços
Adicione suas User-Defined Funções (UDFs) dentro das imagens fornecidas de serviços. O User-Defined Functions pode executar lógica de negócios personalizada. As funções do User-Defined são executadas em contêineres privados nos serviços implantados.
Cada imagem define um serviço. Algumas imagens não contêm UDFs e consistem inteiramente em código predefinido. Algumas imagens contêm UDFs, como funções com um corpo vazio ou código inicial, que são as funções de User-Defined relevantes para esse serviço. Preencha os corpos das funções User-Defined nessas imagens com seu próprio código personalizado.
A Microsoft fornece uma imagem para cada serviço, que pode ser implantada em um provedor de nuvem. Essas são as imagens públicas que devem ser usadas para implantação. Somente imagens oficiais da Microsoft podem realizar leilões privados.
Imagens para implantação:
- Vendedores
- Compradores
- Vendedores e compradores
Serviços para vendedores
| Serviço | Descrição |
|---|---|
| SellerFrontEnd | Fornece um /SelectAd ponto de extremidade HTTPS, que recebe solicitações do serviço de anúncios não confiável do vendedor para iniciar o fluxo de leilão de Audiência Protegida. |
| Leilão | Fornece um /ScoreAds ponto de extremidade, que recebe solicitações do serviço SellerFrontEnd , contendo os lances que estão participando do leilão. Responde com um valor de pontuação que o serviço SellerFrontEnd usa para escolher o vencedor. |
| Chave/valor | Recebe solicitações do serviço SellerFrontEnd , que contêm chaves de pesquisa de lances de compradores (como ad_render_urls). Retorna sinais de pontuação em tempo real necessários para o leilão. Executado no modo Traga seu próprio serviço (BYOS), portanto, o vendedor não precisa implantar esse serviço em um ambiente de execução confiável (TEE) e pode usar a imagem fornecida pela Microsoft. |
Serviços para compradores
| Serviço | Descrição |
|---|---|
| BuyerFrontEnd | Fornece um /GetBids ponto de extremidade, que recebe solicitações do serviço SellerFrontEnd para iniciar o fluxo de lances. |
| Lances | Fornece um /GenerateBids ponto de extremidade, que recebe solicitações do serviço BuyerFrontEnd para lidar com a oferta e gerar uma oferta. Gera um lance, escolhe o vencedor e seleciona a faixa a ser renderizada. |
| Chave/valor | Recebe solicitações do serviço BuyerFrontEnd e retorna os dados do comprador em tempo real necessários para a oferta, correspondentes às chaves de pesquisa dos Grupos de interesse. Essa solicitação ocorre uma vez por fluxo de trabalho. Executado no modo Traga seu próprio serviço (BYOS). |
| Seleção de lances & chave/valor | Recebe solicitações do serviço de licitação para selecionar e retornar faixas de anúncio adicionais (candidatos) que podem participar da licitação. O serviço de Seleção de Lance & Chave/Valor também pode retornar sinais adicionais necessários para a oferta. O serviço de lances pode enviar várias solicitações para o serviço de Seleção de Lance & Chave/Valor ou pode optar por não enviar nenhuma solicitação, pois o serviço de Seleção de Lance & Chave/Valor é opcional. O serviço de Seleção de Lance & Chave/Valor deve ser implantado em um ambiente de execução confiável (TEE). |
| K-Anonimato | Coleta contadores de k-anonimato e verifica se o criativo do anúncio vencedor passa na marca de k-anonimato. |
Funções Definidas pelo Usuário
Vendedores e compradores precisam fornecer seu próprio código personalizado como User-Defined Functions (UDFs) que são executados em contêineres privados dentro dos serviços implantados. Essas funções User-Defined podem executar lógica de negócios personalizada.
Cada comprador ou vendedor pode implantar várias instâncias de um determinado serviço, como:
- SellerFrontEnd e Leilão.
- BuyerFrontend, Bidding e K-Anonymity.
Alguns desses serviços recebem uma entrada, que é um worklet JavaScript que define User-Defined funções.
Funções User-Defined para vendedores
| UDF | Serviço no qual a UDF é executada | Descrição |
|---|---|---|
scoreAd() |
Leilão | Gera uma pontuação para cada lance do comprador ou rejeita o lance. Essa pontuação é então usada pelo serviço SellerFrontEnd , para escolher um vencedor entre todos os compradores. |
reportResult() |
SellerFrontEnd | Para relatórios em nível de evento. É executado no serviço SellerFrontEnd depois que o vencedor final é escolhido. Notifica o vendedor sobre o licitante vencedor e fornece o valor do lance. |
Funções User-Defined para compradores
| UDF | Serviço no qual a UDF é executada | Descrição |
|---|---|---|
generateBids() |
Lances | Gera um lance e escolhe a faixa que será mostrada. |
reportWin() |
SellerFrontEnd | Para relatórios em nível de evento. Executado no serviço SellerFrontEnd , se o lance do comprador vencer o leilão. Notifica o comprador de que ele ganhou o leilão e gera URLs de notificação que serão acionadas posteriormente, como durante a renderização da faixa ou outros eventos do cliente. |
getValues() |
Seleção de lances & chave/valor | Executado no serviço de Seleção de Lance & Chave/Valor , se o comprador usar esse serviço. Permite a execução de código personalizado para pesquisa e seleção de dados. |
Guia de implantação
Para implantar o serviço API de Seleção de Anúncios no Azure:
Crie uma conta do Azure e crie uma assinatura no Microsoft Azure.
Escolha a opção Contêineres ACO confidenciais .
Acesse os scripts de implantação do Terraform em uma nova janela ou guia, baixe os scripts de implantação do Terraform e exiba a documentação de implantação. Observação: Verifique se o hash da imagem baixada corresponde ao hash do script que você baixou.
Os scripts do Terraform já incluem links para imagens públicas fornecidas pela Microsoft. Escolha os serviços necessários e implante-os seguindo as etapas no arquivo .
readme.mdDefina sinalizadores específicos para seu ambiente, incluindo locais de worklets de leilão.
Configure todos os pré-requisitos e prepare todas as ferramentas para implantação.
Crie Recursos do Azure e execute o script Terraform que conclui a implantação.
Desenvolva worklets inclusive
user-defined-function(UDF) e inicie serviços de API de Seleção de Anúncios.
Usar a API de Seleção de Anúncio em seu site
Para começar a usar a API de seleção de anúncios, vendedores e compradores precisam modificar o código JavaScript de seus sites que é executado quando o navegador é o Microsoft Edge.
Vendedores: para realizar leilões privados, buscar grupos de interesse e fazer relatórios, atualize seu código nos sites dos editores.
Compradores: para criar grupos de interesse e armazená-los no navegador, atualize o código nos sites de seus parceiros de publicidade. Você pode usar o mecanismo de delegação para restringir e permitir a criação de Grupo de Interesse em domínios de terceiros.
Para saber mais sobre quais métodos de API estão disponíveis e exibir o código de exemplo, consulte Detalhes da API de seleção de anúncio.
Forneça comentários sobre a avaliação de origem
Para fornecer comentários sobre a avaliação de origem da API de Seleção de Anúncio, crie um novo problema no repositório WICG/privacy-preserving-ads do GitHub:
Para exibir os problemas existentes, acesse a guia Problemas do repositório WICG/privacy-preserving-ads.
Para enviar um novo problema, vá para o formulário de novo problema.
Termos de Uso
Consulte os Termos de Uso da API de Seleção de Anúncios.
Adendo de Proteção de Dados
Confira o adendo de proteção de dados para a API de seleção de anúncios.
Confira também
Avaliações de origem:
- API de Seleção de Anúncio Registro da avaliação de origem no Microsoft Edge
- Testar APIs e recursos experimentais usando avaliações de origem
Documentos técnicos e de design:
- Visão geral da seleção de anúncio
- Proposta de API de Seleção de Anúncio
- Detalhes da API de Seleção de Anúncio
Imagens para implantação:
- Vendedores
- Compradores
- Vendedores e compradores
Scripts de implantação:
Ambiente de execução confiável (TEE):
Azure: