diff --git a/microsoft-edge/dev-videos/index.md b/microsoft-edge/dev-videos/index.md index f516e37552..ff10558d14 100644 --- a/microsoft-edge/dev-videos/index.md +++ b/microsoft-edge/dev-videos/index.md @@ -79,7 +79,7 @@ August 17, 2023 The JSON viewer automatically formats and highlights JSON responses and files in browser tabs. When your web server responds to HTTP requests with data encoded as JSON, this data isn't always easy to read and is sometimes returned as one line of text. The JSON viewer changes the returned data to make it easier to read. The JSON syntax is highlighted with different colors, object properties are displayed on their own lines and indented, and objects can be collapsed or expanded. See also: -* [View formatted JSON](../devtools-guide-chromium/json-viewer/json-viewer.md) +* [View formatted JSON responses or files](../devtools-guide-chromium/json-viewer/json-viewer.md) @@ -121,7 +121,7 @@ Covers: See also: * [What's New in DevTools (Microsoft Edge 112)](../devtools-guide-chromium/whats-new/2023/04/devtools-112.md) * [Analyze CSS selector performance during Recalculate Style events](../devtools-guide-chromium/evaluate-performance/selector-stats.md) - CSS selector stats. -* [View formatted JSON](../devtools-guide-chromium/json-viewer/json-viewer.md) +* [View formatted JSON responses or files](../devtools-guide-chromium/json-viewer/json-viewer.md) * [Apply a color theme to DevTools](../devtools-guide-chromium/customize/theme.md) diff --git a/microsoft-edge/developer/index.yml b/microsoft-edge/developer/index.yml index 0ec78b30de..f64667f5c2 100644 --- a/microsoft-edge/developer/index.yml +++ b/microsoft-edge/developer/index.yml @@ -174,22 +174,45 @@ landingContent: - text: WebView2 API Reference url: ../webview2/webview2-api-reference.md # ============================================================================= -# Card r2c3 - - title: Development tips for Microsoft Edge +# Card r2c3 # 10 items max + - title: Development tips for Microsoft Edge # = /web-platform/ linkLists: - - linkListType: how-to-guide +# - linkListType: overview +# links: +# - text: Development tips for Microsoft Edge +# url: ../web-platform/web-platform.md + - linkListType: whats-new links: - - text: Development tips for Microsoft Edge - url: ../web-platform/web-platform.md - - text: Site compatibility-impacting changes url: ../web-platform/site-impacting-changes.md + - linkListType: how-to-guide + links: + - text: Move users to Microsoft Edge from Internet Explorer + url: ../web-platform/ie-to-microsoft-edge-redirection.md + + - text: Tracking prevention in Microsoft Edge + url: ../web-platform/tracking-prevention.md - text: Detect Microsoft Edge from your website url: ../web-platform/user-agent-guidance.md + - text: Develop experiences for the sidebar in Microsoft Edge + url: ../web-platform/sidebar.md + - text: Detect Windows 11 using User-Agent Client Hints url: ../web-platform/how-to-detect-win11.md + + - text: Customize the password reveal button + url: ../web-platform/password-reveal.md + + - text: Display regional versions of your site, based on OS settings + url: ../web-platform/os-regional-settings.md + + - text: View formatted JSON responses or files + url: ../devtools-guide-chromium/json-viewer/json-viewer.md + + - text: Sign up for the Ad Selection API + url: ../web-platform/ad-selection-api.md # ============================================================================= # Row 3 with 3 cards # ============================================================================= diff --git a/microsoft-edge/devtools-guide-chromium/json-viewer/json-viewer.md b/microsoft-edge/devtools-guide-chromium/json-viewer/json-viewer.md index 46997ec14e..8ae65bbe56 100644 --- a/microsoft-edge/devtools-guide-chromium/json-viewer/json-viewer.md +++ b/microsoft-edge/devtools-guide-chromium/json-viewer/json-viewer.md @@ -1,5 +1,5 @@ --- -title: View formatted JSON +title: View formatted JSON responses or files description: How to use the JSON viewer to view formatted and highlighted JSON responses in a browser tab. author: MSEdgeTeam ms.author: msedgedevrel @@ -8,7 +8,7 @@ ms.service: microsoft-edge ms.subservice: devtools ms.date: 04/08/2024 --- -# View formatted JSON +# View formatted JSON responses or files Use the **JSON viewer** to automatically format and syntax highlight JSON responses and files in browser tabs. diff --git a/microsoft-edge/devtools-guide-chromium/network-console/network-console-tool.md b/microsoft-edge/devtools-guide-chromium/network-console/network-console-tool.md index 42b0e2aba8..57433ecd53 100644 --- a/microsoft-edge/devtools-guide-chromium/network-console/network-console-tool.md +++ b/microsoft-edge/devtools-guide-chromium/network-console/network-console-tool.md @@ -111,5 +111,5 @@ See also: ## See also -* [View formatted JSON](../json-viewer/json-viewer.md) +* [View formatted JSON responses or files](../json-viewer/json-viewer.md) diff --git a/microsoft-edge/devtools-guide-chromium/network/index.md b/microsoft-edge/devtools-guide-chromium/network/index.md index dede20fa44..a22213039e 100644 --- a/microsoft-edge/devtools-guide-chromium/network/index.md +++ b/microsoft-edge/devtools-guide-chromium/network/index.md @@ -205,7 +205,7 @@ Select a resource to learn more information about it. Tip: When a file is minified, select the **Format** (![Format](./index-images/format-icon.png)) button at the bottom of the **Response** panel to re-format the contents of the file for readability. - For example, if the response contains minified JSON data, click the **Format** button to re-format the JSON syntax so that each object property is on its own line. You can also use the **JSON viewer** to view formatted and highlighted JSON responses in a browser tab. See [View formatted JSON](../json-viewer/json-viewer.md). + For example, if the response contains minified JSON data, click the **Format** button to re-format the JSON syntax so that each object property is on its own line. You can also use the **JSON viewer** to view formatted and highlighted JSON responses in a browser tab. See [View formatted JSON responses or files](../json-viewer/json-viewer.md). 1. Select the **Timing** panel. A breakdown of the network activity for the resource is displayed: diff --git a/microsoft-edge/devtools-guide-chromium/sample-code/sample-code.md b/microsoft-edge/devtools-guide-chromium/sample-code/sample-code.md index 35f67220a4..a575f8f3e3 100644 --- a/microsoft-edge/devtools-guide-chromium/sample-code/sample-code.md +++ b/microsoft-edge/devtools-guide-chromium/sample-code/sample-code.md @@ -56,7 +56,7 @@ last sync'd April 16, 2024 | postMessage Trace Events | Tests `postMessage` trace events in the **Performance** tool. Used for [View messages between windows, iframes, and dedicated workers](../evaluate-performance/reference.md#view-messages-between-windows-iframes-and-dedicated-workers) in _Performance features reference_. | [/devtools-postmessage-perf-timeline/](https://github.com/MicrosoftEdge/Demos/tree/main/devtools-postmessage-perf-timeline) | [postMessage Trace Events demo](https://microsoftedge.github.io/Demos/devtools-postmessage-perf-timeline/) | | CSS :target pseudo-class | Used for [Support forcing the :target CSS state](../whats-new/2021/01/devtools.md#support-forcing-the-target-css-state). | [/devtools-target-pseudo/](https://github.com/MicrosoftEdge/Demos/tree/main/devtools-target-pseudo) | [CSS :target pseudo-class demo](https://microsoftedge.github.io/Demos/devtools-target-pseudo/) | | Heap Snapshot Visualizer | Source code for the [Heap Snapshot Visualizer](https://microsoftedge.microsoft.com/addons/detail/heap-snapshot-visualizer/fceldlhognbemkgfacnffkdanocidgce) extension for DevTools. | [/heap-snapshot-visualizer/](https://github.com/MicrosoftEdge/Demos/tree/main/heap-snapshot-visualizer) | n/a | -| JSON dummy data | Simple JSON files. Used for [View formatted JSON](../json-viewer/json-viewer.md). | [/json-dummy-data/](https://github.com/MicrosoftEdge/Demos/tree/main/json-dummy-data) | [JSON dummy data](https://microsoftedge.github.io/Demos/json-dummy-data/) | +| JSON dummy data | Simple JSON files. Used for [View formatted JSON responses or files](../json-viewer/json-viewer.md). | [/json-dummy-data/](https://github.com/MicrosoftEdge/Demos/tree/main/json-dummy-data) | [JSON dummy data](https://microsoftedge.github.io/Demos/json-dummy-data/) | | Inspect Network Activity | Used for [Inspect network activity](../network/index.md). | [/network-tutorial/](https://github.com/MicrosoftEdge/Demos/tree/main/network-tutorial) | [Inspect Network Activity Demo](https://microsoftedge.github.io/Demos/network-tutorial/) | | Photo gallery | Used for [The truth about CSS selector performance](https://blogs.windows.com/msedgedev/2023/01/17/the-truth-about-css-selector-performance/). | [/photo-gallery/](https://github.com/MicrosoftEdge/Demos/tree/main/photo-gallery) | [Photo Gallery](https://microsoftedge.github.io/Demos/photo-gallery/) | | Slow Calendar | Simple calendar demo app to test various DevTools features such as the **Performance** tool and source map support. | [/slow-calendar/](https://github.com/MicrosoftEdge/Demos/tree/main/slow-calendar) | [Slow Calendar](https://microsoftedge.github.io/Demos/slow-calendar/public) | diff --git a/microsoft-edge/devtools-guide-chromium/whats-new/2023/04/devtools-112.md b/microsoft-edge/devtools-guide-chromium/whats-new/2023/04/devtools-112.md index 8e024d9a05..44cc48527a 100644 --- a/microsoft-edge/devtools-guide-chromium/whats-new/2023/04/devtools-112.md +++ b/microsoft-edge/devtools-guide-chromium/whats-new/2023/04/devtools-112.md @@ -102,7 +102,7 @@ With code folding turned on, you can now expand and collapse objects and arrays Please send us your [feedback](../../../contact.md)! See also: -* [View formatted JSON](../../../json-viewer/json-viewer.md) +* [View formatted JSON responses or files](../../../json-viewer/json-viewer.md) diff --git a/microsoft-edge/index.yml b/microsoft-edge/index.yml index b42f6bfda3..032cb1c5e5 100644 --- a/microsoft-edge/index.yml +++ b/microsoft-edge/index.yml @@ -89,7 +89,7 @@ conceptualContent: - itemType: reference text: Deploy to macOS - url: /intune/apps/apps-edge-macos + url: /mem/intune/apps/apps-edge-macos # Card - title: Configure Microsoft Edge links: @@ -331,21 +331,49 @@ conceptualContent: # Card - title: Development tips for Microsoft Edge links: - - text: Development tips for Microsoft Edge - url: ./web-platform/web-platform.md - itemType: overview +# - text: Development tips for Microsoft Edge +# url: ./web-platform/web-platform.md +# itemType: overview - text: Site compatibility-impacting changes url: ./web-platform/site-impacting-changes.md + itemType: whats-new + + - text: Move users to Microsoft Edge from Internet Explorer + url: ./web-platform/ie-to-microsoft-edge-redirection.md + itemType: how-to-guide + + - text: Tracking prevention in Microsoft Edge + url: ./web-platform/tracking-prevention.md itemType: how-to-guide - text: Detect Microsoft Edge from your website url: ./web-platform/user-agent-guidance.md itemType: how-to-guide + - text: Develop experiences for the sidebar in Microsoft Edge + url: ./web-platform/sidebar.md + itemType: how-to-guide + - text: Detect Windows 11 using User-Agent Client Hints url: ./web-platform/how-to-detect-win11.md itemType: how-to-guide + + - text: Customize the password reveal button + url: ./web-platform/password-reveal.md + itemType: how-to-guide + + - text: Display regional versions of your site, based on OS settings + url: ./web-platform/os-regional-settings.md + itemType: how-to-guide + + - text: View formatted JSON responses or files + url: ./devtools-guide-chromium/json-viewer/json-viewer.md + itemType: how-to-guide + + - text: Sign up for the Ad Selection API + url: ./web-platform/ad-selection-api.md + itemType: how-to-guide # Card - title: Accessibility in Microsoft Edge links: diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 8fbe6f90fe..568c74425c 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1704,7 +1704,7 @@ - name: Detect Microsoft Edge from your website href: web-platform/user-agent-guidance.md - - name: Develop for the sidebar + - name: Develop experiences for the sidebar in Microsoft Edge href: web-platform/sidebar.md displayName: sidebar apps, sidebar extensions, pwa, side panel, sidepanel @@ -1714,14 +1714,17 @@ - name: Customize the password reveal button href: web-platform/password-reveal.md - - name: Operating System Regional Data Display + - name: Display regional versions of your site, based on OS settings href: web-platform/os-regional-settings.md displayName: globalization, language, region, limited, intl, date, time, format - - name: View formatted JSON + - name: View formatted JSON responses or files href: devtools-guide-chromium/json-viewer/json-viewer.md displayName: JSON viewer, view JSON + - name: Sign up for the Ad Selection API + href: ./web-platform/ad-selection-api.md + # ============================================================================= # if top-of-page title is longer, add it to displayName comma-delimited list of lookup keywords - name: Microsoft Edge IDE integration diff --git a/microsoft-edge/web-platform/ad-selection-api-images/flags.png b/microsoft-edge/web-platform/ad-selection-api-images/flags.png new file mode 100644 index 0000000000..655d8cc7dd Binary files /dev/null and b/microsoft-edge/web-platform/ad-selection-api-images/flags.png differ diff --git a/microsoft-edge/web-platform/ad-selection-api-images/origin-trials.png b/microsoft-edge/web-platform/ad-selection-api-images/origin-trials.png new file mode 100644 index 0000000000..f2b045f27e Binary files /dev/null and b/microsoft-edge/web-platform/ad-selection-api-images/origin-trials.png differ diff --git a/microsoft-edge/web-platform/ad-selection-api-images/reg-form.png b/microsoft-edge/web-platform/ad-selection-api-images/reg-form.png new file mode 100644 index 0000000000..6d88c37b5c Binary files /dev/null and b/microsoft-edge/web-platform/ad-selection-api-images/reg-form.png differ diff --git a/microsoft-edge/web-platform/ad-selection-api.md b/microsoft-edge/web-platform/ad-selection-api.md new file mode 100644 index 0000000000..2507465b77 --- /dev/null +++ b/microsoft-edge/web-platform/ad-selection-api.md @@ -0,0 +1,299 @@ +--- +title: Sign up for the Ad Selection API +description: Sign up for the Ad Selection API, which provides user-relevant ads on your site without using third-party cookies. +author: MSEdgeTeam +ms.author: msedgedevrel +ms.topic: conceptual +ms.service: microsoft-edge +ms.date: 10/08/2024 +--- +# Sign up for the Ad Selection API + + +The Ad Selection API provides user-relevant ads on your site without using third-party cookies. See [Ad Selection Overview](https://github.com/WICG/privacy-preserving-ads/blob/main/Ad%20Selection%20Overview.md) in the "WICG / privacy-preserving-ads" repo. + +The Ad Selection API can be used by: +* **Sellers** running a supply-side platform (SSP), who can use the API to provide higher-quality ads for their publishers. +* **Buyers** running a demand-side platform (DSP), who can use the API to improve the effectiveness of advertising campaigns. + +To get started using the Ad Selection API and test out the end-to-end flow, sign up for the limited preview of the Ad Selection API. + +As a seller operating a supply-side platform or a buyer operating a demand-side platform, use this guide to: +* Test the Ad Selection API on your site. +* Sign up for the Ad Selection API limited preview. +* Register for the Origin Trial. +* Complete API attestation. +* See the Ad Selection API and its usage, and deploy your services to Azure. +* Set up an evaluation environment with a supported cloud provider. +* Prepare all needed UDF functions and be able to work with Edge Web API. + + + +## Attestation enrollment and alpha sign-up + + + +#### When and where is the preview available? + +Microsoft Edge versions starting with **130.0.2808.0** have support for the Ad Selection API in a limited, developer opt-in preview outside of the European Economic Area (EEA) and the United Kingdom (UK). + + + +#### Flags for testing + +To change the Ad Selection API platform features on your developer machine, use the **Ad Selection API** testing flags at `edge://flags#edge-ad-selection-api`: + +![The "Ad Selection API" flags](./ad-selection-api-images/flags.png) + +The **Ad Selection API** flag enables the Ad Selection API and associated features such as: +* Attribution Reporting. +* Fenced Frames. +* Shared Storage. +* Private Aggregation. + + + +#### Sign-up and attestation requirements and process + +Developers interested in alpha testing can join the [Origin Trial](https://microsoftedge.github.io/MSEdgeExplainers/origin-trials/). This trial enables end-to-end testing of Ad Selection API features, covering both the API usage and the deployment of secure container images. + +For each top-level domain that you intend to use with the Ad Selection API, fill in the **Origin Trial Registration** form for that domain, and then submit the form. + +To sign up for the **Ad Selection API** origin trial for a domain: + +1. Open [Microsoft Edge Origin Trials](https://microsoftedge.github.io/MSEdgeExplainers/origin-trials/) in a new window or tab: + + ![Origin trials](./ad-selection-api-images/origin-trials.png) + +1. In the **Ad Selection API** section, click the **Register** button. The **Origin Trial Registration** form opens: + + ![Registration form](./ad-selection-api-images/reg-form.png) + +1. Fill in the form. + + * In the **Domain** text box, enter a single top-level domain. For example, a top-level domain is `contoso.example`, and optionally includes subdomains such as `subdomain.contoso.example`. + + * In the **Subdomain Support** section, select the **Yes** or **No** option button. + + * In the **Email Address** text box, provide a valid developer contact for the domain. + + * In the **Origin Trial Name** text box, enter **AdSelectionAPI** (with no spaces). This is the ID of this origin trial. + +1. Click the **Submit** button. + + An Origin Trial token is generated for the top-level domain and is sent to you. + +1. Create a file that's named `ad-selection-attestations.json`, and host the file at the top-level domain, in the `/.well-known/` directory. For example: + + `https://contoso.example/.well-known/ad-selection-attestations.json` + + The `ad-selection-attestations.json` file must be published within **30 days** of receiving the OT token. Hosting this JSON file is required, in order to complete your attestation and allow your code to access the Ad Selection API, to test the Ad Selection API with supported Microsoft Edge clients. + + + +#### Example JSON file + +The attestations JSON file must be named `ad-selection-attestations.json`, and must conform to the following standards below. The following is an example of an `ad-selection-attestations.json` file: + +```json +{ + "ad_selection_api_attestations": [ + { + "attestation_parser_version": "2", + "attestation_version": "2", + "privacy_policy": [ + "https://contoso.example/privacy/" + ], + "ownership_token": "", + "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": {} + } + ] + } + ] +} +``` + + + +###### Important fields and values + +* The `ad-selection-attestations.json` file must include the Origin Trial token that was generated and sent to you for this top-level domain. `"ownership_token":` is the Origin Trial token that was generated when registering this domain for the **Ad Selection API** origin trial. + +* In the `"platform_attestations":` section, `"platform":` must be `"edge"` or `"android"`. + +* The file must include a list of APIs (features that are associated with the Ad Services API). In the `"platform_attestations":` section, valid members of `"attestations":` are the following: + * `"ad_selection_api":` - The main API, for private auction logic. + * `"attribution_reporting_api":` - Attribution reporting. + * `"shared_storage_api":` - Shared storage. + * `"private_aggregation_api":` - Private aggregation. + * Requirements: + * Each `"..._api":` entry must have a single field, `"ServiceNotUsedForIdentifyingUserAcrossSites":`, with either a `true` or `false` value. `true` means that this service is not used for identifying the user across sites. `false` means that this service is used for identifying the user across sites. + + + +## Deploy the Ad Selection API services + +The Ad Selection API uses a trusted execution environment (TEE) to provide a level of assurance for data integrity, data confidentiality, and code integrity; see [Confidential Computing: Hardware-Based Trusted Execution for Applications and Data](https://confidentialcomputing.io/wp-content/uploads/sites/85/2021/03/confidentialcomputing_outreach_whitepaper-8-5x11-1.pdf). Services provided by the Ad Selection API must run in a TEE to secure the data used by these services. + +Ad Selection Services running in a TEE should be deployed on a cloud platform that supports the necessary security features. Initially, services can be deployed in Azure using [Confidential ACI containers](/azure/container-instances/container-instances-confidential-overview). + +The Ad Selection API provides different services that need to be deployed by sellers or buyers. + + + +#### Images for deploying services + +Add your User-Defined Functions within the provided images of services. The User-Defined Functions can run custom business logic. The User-Defined Functions run in private containers within the deployed services. + +Each image defines one service. Some images don't contain UDFs, and consist entirely of predefined code. Some images contain UDFs, as functions with an empty body or starter code, that are the relevant User-Defined Functions for that service. Fill in the bodies of the User-Defined Functions in these images with your own custom code. + +Microsoft provides an image for each service, which can be deployed on a cloud provider. These are the public images that must be used for deployment. Only official images from Microsoft are able to run private auctions. + +Images for seller services: +* [SellerFrontEnd service](https://mcr.microsoft.com/product/ad-selection/azure/seller-frontend-service) +* [Auction service](https://mcr.microsoft.com/product/ad-selection/azure/auction-service) + +Images for buyer services: +* [BuyerFrontEnd service](https://mcr.microsoft.com/product/ad-selection/azure/buyer-frontend-service) +* [Bidding service](https://mcr.microsoft.com/product/ad-selection/azure/bidding-service) +* [K-Anonymity service](https://mcr.microsoft.com/product/ad-selection/azure/k-anonymity-service) + + + +#### Services for sellers + +| Service | Description | +| --- | --- | +| **SellerFrontEnd** | Provides a `/SelectAd` HTTPS endpoint, which receives requests from the seller's untrusted ad service to initiate the Protected Audience auction flow. | +| **Auction** | Provides a `/ScoreAds` endpoint, which receives requests from the **SellerFrontEnd** service, containing bids that are participating in the auction. Responds with a score value that the **SellerFrontEnd** service uses to choose the winner. | +| **Key/Value** | Receives requests from the **SellerFrontEnd** service, which contain lookup keys from buyers' bids (such as `ad_render_urls`). Returns real-time scoring signals that are required for the auction. Runs in Bring Your Own Service (BYOS) mode, so the seller does not need to deploy this service in a trusted execution environment (TEE), and can instead use the image that's provided by Microsoft. | + + + +#### Services for buyers + +| Service | Description | +| --- | --- | +| **BuyerFrontEnd** | Provides a `/GetBids` endpoint, which receives requests from the **SellerFrontEnd** service to initiate the bidding flow. | +| **Bidding** | Provides a `/GenerateBids` endpoint, which receives requests from the **BuyerFrontEnd** service to handle the bidding and generate a bid. Generates a bid, chooses the winner, and selects the banner to be rendered. | +| **Key/Value** | Receives requests from the **BuyerFrontEnd** service and returns real-time buyer data required for bidding, corresponding to lookup keys from Interest Groups. Such a request happens once per workflow. Runs in Bring Your Own Service (BYOS) mode. | +| **Bidding Selection & Key/Value** | Receives requests from the **Bidding** service to select and return additional ad banners (candidates) that can participate in bidding. The **Bidding Selection & Key/Value** service can also return additional signals that are needed for bidding. The **Bidding** service may send multiple requests to the **Bidding Selection & Key/Value** service, or may choose not to send any requests, because the **Bidding Selection & Key/Value** service is optional. The **Bidding Selection & Key/Value** service must be deployed in a trusted execution environment (TEE). | +| **K-Anonymity** | Collects k-anonymity counters and checks that the winning ad creative passes the k-anonymity check. | + + + +#### User-Defined Functions + +Sellers and buyers need to provide their own custom code as User-Defined Functions (UDFs) that run in private containers within the deployed services. These User-Defined Functions can execute custom business logic. + +Each buyer or seller can deploy multiple instances of a given service, such as: +* **SellerFrontEnd** and **Auction**. +* **BuyerFrontend**, **Bidding**, and **K-Anonymity**. + +Some of these services take an input which is a JavaScript worklet that defines User-Defined Functions. + + + +###### User-Defined Functions for sellers + +| UDF | Service in which the UDF runs | Description | +| --- | --- | --- | +| `scoreAd()` | **Auction** | Generates a score for each buyer's bid, or rejects the bid. This score is then used by the **SellerFrontEnd** service, to choose a winner from among all buyers. | +| `reportResult()` | **SellerFrontEnd** | For event-level reporting. Runs in the **SellerFrontEnd** service after the final winner has been chosen. Notifies the seller about the winning bidder, and provides the bid value. | + + + +###### User-Defined Functions for buyers + +| UDF | Service in which the UDF runs | Description | +| --- | --- | --- | +| `generateBids()` | **Bidding** | Generates a bid, and chooses the banner that will be shown. | +| `reportWin()` | **SellerFrontEnd** | For event-level reporting. Runs in the **SellerFrontEnd** service, if the buyer's bid wins the auction. Notifies the buyer that they have won the auction, and generates notification URLs that will be triggered later, such as during banner rendering or other client events. | +| `getValues()` | **Bidding Selection & Key/Value** | Runs in the **Bidding Selection & Key/Value** service, if the buyer uses that service. Allows for custom code execution for data lookup and selection. | + + + +#### Deployment guide + +To deploy the Ad Selection API service to Azure: + +1. Create an Azure account and create a subscription at [Microsoft Azure](https://azure.microsoft.com). + +1. Choose the **Confidential ACO containers** option. + +1. Download the Terraform [deployment scripts and guide](https://go.microsoft.com/fwlink/?linkid=2290115). **Note:** Make sure the hash of the image you downloaded matches the hash in the script you download. + +1. The Terraform scripts already include links to public images that are provided by Microsoft. Choose the required services and deploy them by following the steps in the included `readme.md`. + + 1. Set any specific flags for your environment, including auction worklet locations. + + 1. Configure all prerequisites and prepare all tools for deployment. + + 1. Create Azure Resources and run the Terraform script that finishes deployment. + +1. Develop worklets including `user-defined-function` (UDF) and start Ad Selection API services. + + + +## Use the Ad Selection API on your website + +To start using the Ad Selection API, sellers and buyers need to modify their websites' JavaScript code that's run when the browser is Microsoft Edge. + +* Sellers: To run private auctions, fetch interest groups, and do reporting, update your code on publishers' websites. + +* Buyers: To create interest groups and store them in the browser, update the code on your advertising partners' websites. You can use the delegation mechanism to restrict and allow Interest Group creation on third-party domains. + +To learn more about which API methods are available and to view example code, see [Ad Selection API details](https://github.com/WICG/privacy-preserving-ads/blob/main/API%20Details.md). + + + +## See also + + +Design and technical documents: +* [Ad Selection API Proposal](https://github.com/WICG/privacy-preserving-ads?tab=readme-ov-file#ad-selection-api-proposal) +* [Ad Selection Overview](https://github.com/WICG/privacy-preserving-ads/blob/main/Ad%20Selection%20Overview.md) +* [Ad Selection API details](https://github.com/WICG/privacy-preserving-ads/blob/main/API%20Details.md) + +Images for deployment: +* Sellers + * [SellerFrontEnd service](https://mcr.microsoft.com/product/ad-selection/azure/seller-frontend-service) + * [Auction service](https://mcr.microsoft.com/product/ad-selection/azure/auction-service) +* Buyers + * [BuyerFrontEnd service](https://mcr.microsoft.com/product/ad-selection/azure/buyer-frontend-service) + * [Bidding service](https://mcr.microsoft.com/product/ad-selection/azure/bidding-service) + * [K-Anonymity service](https://mcr.microsoft.com/product/ad-selection/azure/k-anonymity-service) + +Origin trials: +* [Origin Trials](https://microsoftedge.github.io/MSEdgeExplainers/origin-trials/) + +Trusted execution environment (TEE): +* [Confidential Computing: Hardware-Based Trusted Execution for Applications and Data](https://confidentialcomputing.io/wp-content/uploads/sites/85/2021/03/confidentialcomputing_outreach_whitepaper-8-5x11-1.pdf) + +Azure: +* [Microsoft Azure](https://azure.microsoft.com) +* [Confidential ACI containers](/azure/container-instances/container-instances-confidential-overview) + +Terraform: +* [Terraform deployment scripts and guide](https://go.microsoft.com/fwlink/?linkid=2290115) diff --git a/microsoft-edge/web-platform/os-regional-settings.md b/microsoft-edge/web-platform/os-regional-settings.md index be8d2d080b..907d7a0647 100644 --- a/microsoft-edge/web-platform/os-regional-settings.md +++ b/microsoft-edge/web-platform/os-regional-settings.md @@ -1,5 +1,5 @@ --- -title: Operating System regional data display +title: Display regional versions of your site, based on OS settings description: How users and web developers can use the OS regional format in Microsoft Edge for improved site experiences author: MSEdgeTeam ms.author: msedgedevrel @@ -7,7 +7,7 @@ ms.topic: conceptual ms.service: microsoft-edge ms.date: 08/19/2022 --- -# Operating System regional data display +# Display regional versions of your site, based on OS settings Microsoft Edge provides operating system (OS) regional preference information to help website authors create regional experiences on their website, when viewing your site using Microsoft Edge. This feature allows website authors to deliver value to users who specifically change their regional preferences in the OS to reflect their personal preferences. @@ -17,7 +17,7 @@ Users want to see dates, times, numbers, and other formatting printed according ## Regional format -To reflect a user's regional preferences for how data is displayed (such as the date), Microsoft Edge has a new option in the **Language** section of **Settings**: the **Share additional OS regional format** menu. +To reflect a user's regional preferences for how data is displayed (such as the date), Microsoft Edge has an option in the **Language** section of **Settings**: the **Share additional OS regional format** menu. ![The 'Share additional OS regional format' menu with the Limited (default) option selected](./os-regional-settings-images/os-regional-setting.png) diff --git a/microsoft-edge/web-platform/sidebar.md b/microsoft-edge/web-platform/sidebar.md index e5af0dfa5e..25ef9c277f 100644 --- a/microsoft-edge/web-platform/sidebar.md +++ b/microsoft-edge/web-platform/sidebar.md @@ -1,13 +1,13 @@ --- -title: Develop for the sidebar -description: Learn to develop experiences for the sidebar in Microsoft Edge, by either installing a Progressive Web App, or using the extension sidebar API. +title: Develop experiences for the sidebar in Microsoft Edge +description: Develop experiences for the sidebar in Microsoft Edge, by either installing a Progressive Web App, or using the extension sidebar API. author: MSEdgeTeam ms.author: msedgedevrel ms.topic: conceptual ms.service: microsoft-edge ms.date: 08/04/2023 --- -# Develop for the sidebar +# Develop experiences for the sidebar in Microsoft Edge The sidebar in Microsoft Edge is a persistent pane located on the side of the browser, which coexists with the primary content of the browser. The sidebar allows users to easily access popular websites and utilities alongside their browser tabs. The content in the sidebar augments the user's primary task by enabling side-by-side browsing and minimizing the need to switch contexts between browser tabs. By using the sidebar in Microsoft Edge, users can access the productivity tools they need while staying in their workflow. diff --git a/microsoft-edge/web-platform/web-platform.md b/microsoft-edge/web-platform/web-platform.md index b71d9fc8ec..c5079c9b0e 100644 --- a/microsoft-edge/web-platform/web-platform.md +++ b/microsoft-edge/web-platform/web-platform.md @@ -6,7 +6,7 @@ ms.author: msedgedevrel ms.topic: conceptual ms.service: microsoft-edge ms.subservice: devtools -ms.date: 07/24/2023 +ms.date: 10/06/2024 --- # Development tips for Microsoft Edge @@ -78,7 +78,7 @@ As a developer, you can leverage the sidebar for your own experiences in two way * By adapting your existing Progressive Web App (PWA) to run in the sidebar. * By making use of the Sidebar API in your Microsoft Edge extension. -See [Develop for the sidebar](./sidebar.md). +See [Develop experiences for the sidebar in Microsoft Edge](./sidebar.md). @@ -107,6 +107,14 @@ The `password` input control in Microsoft Edge includes a **password reveal** bu See [Customize the password reveal button](./password-reveal.md). + +## Display regional versions of your site, based on OS settings + +Microsoft Edge provides operating system (OS) regional preference information to help website authors create regional experiences on their website, when viewing your site using Microsoft Edge. This feature allows website authors to deliver value to users who specifically change their regional preferences in the OS to reflect their personal preferences. + +See [Display regional versions of your site, based on OS settings](./os-regional-settings.md). + + ## View formatted JSON responses or files @@ -114,4 +122,14 @@ Microsoft Edge includes the **JSON viewer**, a tool that automatically reformats Formatting and highlighting JSON data is useful because sometimes a web server responds to HTTP requests by returning data encoded as JSON. JSON data can be difficult to read when it's formatted as a single long, concatenated line of text. The same can occur when opening a JSON file from disk. The **JSON viewer** reformats JSON server responses and local files, and indicates any lines that have syntax errors. -See [View formatted JSON](../devtools-guide-chromium/json-viewer/json-viewer.md). +See [View formatted JSON responses or files](../devtools-guide-chromium/json-viewer/json-viewer.md). + + + +## Sign up for the Ad Selection API + +The Ad Selection API provides user-relevant ads on your site without using third-party cookies. The Ad Selection API can be used by: +* **Sellers** running a supply-side platform (SSP), who can use the API to provide higher-quality ads for their publishers. +* **Buyers** running a demand-side platform (DSP), who can use the API to improve the effectiveness of advertising campaigns. + +See [Sign up for the Ad Selection API](./ad-selection-api.md).