Add Sitelinks

Add sitelink extensions to a campaign.

Sitelinks are clickable links to specific pages on your website. Recommended 4-6 sitelinks per campaign.

CONSTRAINTS:

link_text max 25 characters
description1 max 35 characters (optional)
description2 max 35 characters (required if description1 is set)

EXAMPLE SITELINKS: { “link_text”: “How It Works”, “final_url”: “https://example.com/how-it-works”, “description1”: “See the platform in action”, “description2”: “Step-by-step walkthrough” }

{ “link_text”: “Pricing”, “final_url”: “https://example.com/pricing”, “description1”: “Affordable plans for all”, “description2”: “Start free today” }

Parameters:

campaign_id: The campaign ID (REQUIRED). Get from list_campaigns.
sitelinks: List of sitelink objects with link_text, final_url, and optional descriptions.
customer_id: Optional Google Ads customer ID

Execution time: 2-5 seconds

When to use:

User wants to add sitelinks to their campaign
User asks about adding more links to ads
After creating a campaign, suggest adding sitelinks

Example: User: “Add sitelinks to my campaign” Agent:

Uses list_campaigns to get campaign_id
Uses add_sitelinks with relevant page links

POST

api

tools

add_sitelinks

execute

Add Sitelinks

curl --request POST \
  --url https://api.adspirer.ai/api/v1/tools/add_sitelinks/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "arguments": {
    "campaign_id": "<campaign_id>",
    "customer_id": "string",
    "sitelinks": [
      {
        "final_url": "https://example.com/running",
        "link_text": "Shop Running"
      },
      {
        "final_url": "https://example.com/new",
        "link_text": "New Arrivals"
      }
    ]
  }
}
'

{
  "data": {
    "quota": {
      "limit": 150,
      "period_end": "2026-05-01",
      "tier": "plus",
      "used": 42
    },
    "text": "(tool-specific textual output for add_sitelinks)"
  },
  "success": true,
  "tool": "add_sitelinks"
}

Authorizations

Authorization

string

header

required

API key from https://adspirer.ai/keys. Prefix sk_live_. Treat as a secret — never commit.

Headers

Idempotency-Key

string<uuid>

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

application/json

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.

arguments

object

required

Input schema for adding sitelink extensions to a campaign.

Sitelinks are clickable links to specific pages on your website. Recommended 4-6 sitelinks per campaign.

EXAMPLE: { "link_text": "How It Works", "final_url": "https://example.com/how-it-works", "description1": "See the platform in action", "description2": "Step-by-step walkthrough" }

Constraints:

link_text max 25 characters
description1 max 35 characters (optional)
description2 max 35 characters (required if description1 set)

Show child attributes

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.

data

object

required

Show child attributes

success

boolean

required

tool

string

required

Echoed tool_name from the request URL.

Last modified on April 23, 2026

Add Structured SnippetsAdd 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: 1. Uses list_campaigns to get campaign_id 2. Uses add_structured_snippets with header "Types" and relevant values

Add Sitelinks

curl --request POST \
  --url https://api.adspirer.ai/api/v1/tools/add_sitelinks/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "arguments": {
    "campaign_id": "<campaign_id>",
    "customer_id": "string",
    "sitelinks": [
      {
        "final_url": "https://example.com/running",
        "link_text": "Shop Running"
      },
      {
        "final_url": "https://example.com/new",
        "link_text": "New Arrivals"
      }
    ]
  }
}
'

{
  "data": {
    "quota": {
      "limit": 150,
      "period_end": "2026-05-01",
      "tier": "plus",
      "used": 42
    },
    "text": "(tool-specific textual output for add_sitelinks)"
  },
  "success": true,
  "tool": "add_sitelinks"
}