Skip to main content

​
Response Structure

{
  "requestId": "req_abc123",
  "slots": [
    {
      "slotId": "main-chat",
      "ads": [
        {
          "id": "ad_xyz789",
          "type": "action_card",
          "content": {
            "title": "Product Title",
            "description": "Product description",
            "imageUrl": "https://example.com/image.jpg",
            "ctaText": "Learn More",
            "ctaUrl": "https://example.com/product"
          }
        }
      ]
    }
  ]
}

​
Ad Formats

​
Action Card

Product cards with rich media: 
{
  "type": "action_card",
  "content": {
    "title": "Product Name",
    "description": "Product description",
    "imageUrl": "https://example.com/image.jpg",
    "price": "$99.99",
    "ctaText": "Buy Now",
    "ctaUrl": "https://example.com/buy"
  }
}

​
Suffix Ad

Conversational enhancement text: 
{
  "type": "suffix",
  "content": {
    "text": "Learn more about this topic",
    "url": "https://example.com/learn"
  }
}
Inline content enhancement: 
{
  "type": "entity_link",
  "enhancedFragments": [
    {
      "text": "iPhone 15",
      "url": "https://example.com/iphone15",
      "position": { "start": 10, "end": 19 }
    }
  ]
}