Skip to content

Multi piece ad - docs #612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Apr 11, 2025

Conversation

sidneyzanetti
Copy link
Contributor

Prior to creating a pull request, please follow all the steps in the contributing guide.

Description

Multi piece Ad - Documentation

Related Issue

  • Fixes #xxx

Affected services

  • Home
  • News
  • Shop
  • Travel
  • DSP
  • SSP
  • ALL

Other:

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @sidneyzanetti, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request adds documentation for the multi-piece ad demo, which showcases how advertisers can display multiple products within a single ad unit using the Protected Audience API. The documentation includes an overview, design considerations, and a demo scenario with implementation details. The changes also include adding a link to the new documentation page in the intro documentation.

Highlights

  • Documentation for Multi-Piece Ads: The pull request introduces a new documentation page explaining how to implement ads composed of multiple pieces using the Protected Audience API.
  • Demo Scenario: The documentation includes a demo scenario that walks users through the process of seeing a multi-piece ad on a news site after browsing a product on a shop site.
  • Implementation Details: The documentation provides implementation details on how to add products to an interest group and how to serve multi-piece ads using iframes or Fenced Frames.
  • Intro Documentation Update: The pull request updates the intro documentation to include a link to the new multi-piece ad documentation page.

Changelog

  • services/home/docs/demos/multi-piece-ad.md
    • Created a new documentation page for ads composed of multiple pieces.
    • Added an overview of multi-piece ads and their benefits.
    • Described the design considerations for implementing multi-piece ads.
    • Included a demo scenario with prerequisites and a user journey.
    • Provided implementation details on how to add products to an interest group and serve multi-piece ads.
    • Referenced related API documentation.
  • services/home/docs/intro.md
    • Added a link to the new 'Ads Composed of Multiple Pieces' documentation page in the demos table.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


A multi-piece ad,
A canvas of products shown,
Privacy thrives on.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

The pull request introduces documentation for multi-piece ads, which is a valuable addition to the privacy-sandbox-demos project. The documentation covers the overview, design, and a demo of multi-piece ads. The content is well-structured and provides a good understanding of the concept. However, there are a few areas that could be improved for clarity and accuracy.

Summary of Findings

  • Inconsistent Ad Component Definition: The JavaScript code snippet defining the myGroup object in multi-piece-ad.md has a syntax error in the gymShoes entry within the adComponents array. It uses sizeGroup; instead of sizeGroup:, which will cause a syntax error.
  • Clarification of Ad Serving Mechanism: The documentation mentions using iframes or Fenced Frames to serve ads from adComponents. It would be beneficial to elaborate on the advantages and disadvantages of each approach, and provide guidance on when to use one over the other.
  • Missing 'size' or 'sizeGroup' requirement: The documentation states that each value in the adComponents list must match one of adComponent's renderURL and sizes available in the interest group. It should be clarified that either size or sizeGroup must be present in the bid response's adComponents.

Merge Readiness

The pull request introduces valuable documentation for multi-piece ads. However, the identified issues should be addressed before merging to ensure accuracy and clarity. Specifically, the syntax error in the JavaScript code snippet should be fixed, and the documentation should be enhanced with more details on ad serving mechanisms and the requirement of size or sizeGroup in the bid response. I am unable to approve this pull request, and recommend that others review and approve this code before merging.

@siddharth-sahoo siddharth-sahoo merged commit df01c88 into privacysandbox:dev Apr 11, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants