Add showSponsored as api configuration on faststore.config.js to IntelligentSearch integration

[fltiago]

What's the purpose of this pull request?

This PR adds support for showing sponsored products when using Intelligent Search. FastShop and probably more retailers are interested in our ad solution (VTEX Ad Network). This PR intends to create a frictionless integration between FastStore and VTEX Ad Network.

How it works?

The store will change the showSponsored configuration on the faststore.config.js file to allow intelligent search to return sponsored products. This will only happen if the store is a active publisher on VTEX Ad Network.

On faststore.config.js

 // Platform specific configs for API
  api: {
    ...
    showSponsored: true,
  }

How to test it?

• Change the showSponsored attribute to true on faststore.config.js
• Verify if the store is an active publisher on VTEX Ad Network
• Create a campaign to be delivered to the store with a valid product

Check the starter page with the showSponsored flag to true and no label: Starter With Ads - related PR:

Example with no label:

Perfomance for category page:

Performance for full text search page:

Starters Deploy Preview

References

• VTEX Ad Network
• Intelligent Search API

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
faststore-site	⬜️ Ignored (Inspect)	Visit Preview		Sep 19, 2024 7:36pm

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

[pedromtec]

Hey @fltiago, did you test in our starter?

[pedromtec]

question: Was this line updated manually?

[fltiago]

Nope. This line is based on this fragment here.

[pedromtec]

@fltiago What is the performance of the full text search page in the Starter?

[fltiago]

@fltiago What is the performance of the full text search page in the Starter?

I added in the PR description or did you mean on the original starter page?

[eduardoformiga]

LGTM!
Question: is it normal to repeat the sponsored product?

[eduardoformiga]

In FastStore, we follow schema.org to define new props, and schema.org does not have an advertisement prop for Product that fits better for advertisement (maybe additionalProperty ?). In this case, I think we can proceed with the advertisement prop and propose this new field to schema.org somehow. What do you think?

[fltiago]

I didn't know we used a well-defined partner for our schemas, seems awesome.

I agree and I will study schema.org to see how advertisement will fit, but first I think we should test and see how it goes.

[fltiago]

LGTM! Question: is it normal to repeat the sponsored product?

Yes, it is! The advertisers pay for that, to have more space and be in a better position.