Add Structured Snippets
Add structured snippet extensions to a campaign.
Structured snippets highlight specific aspects of your products/services.
VALID HEADERS:
- AMENITIES, BRANDS, COURSES, DEGREE_PROGRAMS, DESTINATIONS
- FEATURED_HOTELS, INSURANCE_COVERAGE, MODELS, NEIGHBORHOODS
- SERVICE_CATALOG, SHOWS, STYLES, TYPES
RULES:
- Header must be from predefined list
- 3-10 values required per snippet
- Each value max 25 characters
EXAMPLES: For SaaS/Platform: Header: “Types” Values: [“Google Ads”, “Meta Ads”, “LinkedIn Ads”, “TikTok Ads”]
For Services: Header: “Services” (maps to SERVICE_CATALOG) Values: [“Campaign Launch”, “Analytics”, “Optimization”, “Reporting”]
For Brands: Header: “Brands” Values: [“Nike”, “Adidas”, “Puma”, “New Balance”]
Parameters:
- campaign_id: The campaign ID (REQUIRED). Get from list_campaigns.
- snippets: List of
{header, values}objects (REQUIRED). - customer_id: Optional Google Ads customer ID
Execution time: 2-5 seconds
When to use:
- User wants to add structured snippets
- User asks to highlight product types, services, or brands
- After creating a campaign, suggest adding snippets
Example: User: “Add structured snippets showing our ad platform types” Agent:
- Uses list_campaigns to get campaign_id
- Uses add_structured_snippets with header “Types” and relevant values
Authorizations
API key from https://adspirer.ai/keys. Prefix sk_live_. Treat as a secret — never commit.
Headers
Client-generated UUID to make writes idempotent. Strongly recommended for write tools. A repeat call with the same key returns the cached result instead of re-executing. Example: 550e8400-e29b-41d4-a716-446655440000
Body
All tool arguments are wrapped in an arguments object. The fields accepted inside arguments are listed below — required fields are marked with a red asterisk.
Input schema for adding structured snippet extensions to a campaign.
Structured snippets highlight specific aspects of your products/services.
Valid Headers: AMENITIES, BRANDS, COURSES, DEGREE_PROGRAMS, DESTINATIONS, FEATURED_HOTELS, INSURANCE_COVERAGE, MODELS, NEIGHBORHOODS, SERVICE_CATALOG, SHOWS, STYLES, TYPES
EXAMPLE for SaaS: Header: "Types" Values: ["Google Ads", "Meta Ads", "LinkedIn Ads", "TikTok Ads"]
EXAMPLE for Services: Header: "Services" (maps to SERVICE_CATALOG) Values: ["Campaign Launch", "Analytics", "Optimization", "Reporting"]
Response
Tool executed successfully. data.text carries the human-readable result (markdown-friendly). data.quota shows your current usage against the plan limit. data.structured appears when the tool emits machine-parseable structured content. data.content appears for tools that return non-text blocks (images, resources).
Returned on HTTP 200. data.text is the primary human-readable output. data.quota is always present for billable calls. data.structured is set only when the tool emits machine-parseable structured content. data.content is set only when the tool emits non-text content blocks.