Skip to main content

Linkedin-Ads

The Linkedin-Ads agent connector is a Python package that equips AI agents to interact with Linkedin-Ads through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

Connector for the LinkedIn Ads Marketing API. Provides access to ad accounts, campaigns, campaign groups, creatives, conversions, and ad analytics data. Supports OAuth 2.0 and direct access token authentication. Use this connector to retrieve advertising performance metrics, manage campaign structures, and monitor creative assets across your LinkedIn advertising accounts.

Example prompts​

The Linkedin-Ads connector is optimized to handle prompts like these.

  • List all my LinkedIn ad accounts
  • Show me all campaigns in my ad account
  • List all campaign groups
  • Show me the creatives for my campaigns
  • List all conversions configured for my ad accounts
  • Show me account users for my LinkedIn ads accounts
  • Show me campaign analytics for my LinkedIn ad campaigns
  • Show me creative analytics for my ad creatives
  • Which campaigns have the highest click-through rate?
  • What is the total ad spend across all campaigns this month?
  • Show me campaigns with status ACTIVE
  • Which creatives have the most impressions?
  • Compare campaign performance by cost type

Unsupported prompts​

The Linkedin-Ads connector isn't currently able to handle prompts like these.

  • Create a new campaign
  • Update campaign budgets
  • Delete an ad creative
  • Pause a campaign

Entities and actions​

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

EntityActions
AccountsList, Create, Get, Update, Delete, Context Store Search, Context Store SQL Query
Account UsersList, Update, Create, Delete, Context Store Search, Context Store SQL Query
CampaignsList, Create, Get, Update, Delete, Context Store Search, Context Store SQL Query
Campaign GroupsList, Create, Get, Update, Delete, Context Store Search, Context Store SQL Query
CreativesList, Create, Get, Update, Delete, Context Store Search, Context Store SQL Query
ConversionsList, Create, Get, Update, Context Store Search, Context Store SQL Query
Conversion EventsCreate
Campaign ConversionsCreate, Delete
Ad Campaign AnalyticsList, Context Store Search, Context Store SQL Query
Ad Creative AnalyticsList, Context Store Search, Context Store SQL Query
Ad Impression Device AnalyticsList, Context Store Search, Context Store SQL Query
Ad Member Company AnalyticsList, Context Store Search, Context Store SQL Query
Ad Member Company Size AnalyticsList, Context Store Search, Context Store SQL Query
Ad Member Country AnalyticsList, Context Store Search, Context Store SQL Query
Ad Member Industry AnalyticsList, Context Store Search, Context Store SQL Query
Ad Member Job Function AnalyticsList, Context Store Search, Context Store SQL Query
Ad Member Job Title AnalyticsList, Context Store Search, Context Store SQL Query
Ad Member Region AnalyticsList, Context Store Search, Context Store SQL Query
Ad Member Seniority AnalyticsList, Context Store Search, Context Store SQL Query
Lead FormsList, Context Store Search, Context Store SQL Query
Lead Form ResponsesList, Context Store Search, Context Store SQL Query

Linkedin-Ads API docs​

See the official Linkedin-Ads API reference.

Interfaces​

Use the Linkedin-Ads connector through the Airbyte Agent CLI, the Python SDK, or the API.

CLI​

Install the CLI:

curl -fsSL https://airbyte.ai/install.sh | bash

Authenticate with Airbyte:

airbyte-agent login

Create the connector. The CLI opens the hosted setup flow:

airbyte-agent connectors create --json '{
  "workspace": "<your_workspace_name>",
  "name": "linkedin-ads"
}'

Describe the connector to see its supported entities and actions:

airbyte-agent connectors describe --json '{
  "workspace": "<your_workspace_name>",
  "name": "linkedin-ads"
}'

Execute an action:

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "linkedin-ads",
  "entity": "accounts",
  "action": "list"
}'

Python SDK​

Installation​

uv pip install airbyte-agent-sdk

Usage​

Connectors can run in hosted or open source mode.

Hosted​

In hosted mode, API credentials are stored securely in Airbyte Agents. You provide your Airbyte credentials instead. If your Airbyte client can access multiple organizations, also set organization_id.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

The connect() factory returns a fully typed LinkedinAdsConnector and reads AIRBYTE_CLIENT_ID / AIRBYTE_CLIENT_SECRET from the environment:

The recommended pattern is build_connector_tools, which gives the agent three tools bound to this connector: inspect_connector, read_skill_docs, and execute. The agent can inspect the connector, read only the skill-doc section it needs, and then execute:

inspect_connector() -> read_skill_docs() -> read_skill_docs(section="...") -> execute(entity, action, params)

Pass section IDs verbatim as the outline lists them, prefix included (actions.<entity>.<action>, not <entity>.<action>); anything else returns an error the agent has to recover from.

The builder names its tools inspect_connector, read_skill_docs, and execute, so the tool sets for more than one connector collide when registered on the same agent. Renaming the callables at registration avoids the collision, but the generated execute guidance still names inspect_connector and read_skill_docs, pointing the model at the wrong tools. Use the agent_tool pattern below instead: it weaves your own names into that guidance.

Pydantic AI
from airbyte_agent_sdk import build_connector_tools
from pydantic_ai import Agent
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.linkedin_ads import LinkedinAdsConnector

connector = connect("linkedin-ads", workspace_name="<your_workspace_name>")

tools = build_connector_tools(connector, framework="pydantic_ai")
agent = Agent("openai:gpt-4o", tools=tools.as_list())
Custom tool bodies​

When you need custom tool bodies — or a framework without native support — use LinkedinAdsConnector.agent_tool. Register execute, inspect, and docs together so the agent can fetch connector guidance progressively. Pass the framework explicitly when it has a supported failure strategy:

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.linkedin_ads import LinkedinAdsConnector

connector = connect("linkedin-ads", workspace_name="<your_workspace_name>")

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@LinkedinAdsConnector.agent_tool(
    framework="pydantic_ai",
    inspect_tool="linkedin_ads_inspect",
    docs_tool="linkedin_ads_read_docs",
)
async def linkedin_ads_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

@agent.tool_plain
@LinkedinAdsConnector.agent_tool(framework="pydantic_ai")
async def linkedin_ads_inspect():
    return await connector.inspect_connector()

@agent.tool_plain
@LinkedinAdsConnector.agent_tool(framework="pydantic_ai")
async def linkedin_ads_read_docs(section: str | None = None):
    return await connector.read_skill_docs(section)

Use the same three-function pattern with framework="langchain", "openai_agents", or "mcp" and that framework's registration decorator. Each value translates connector failures into the framework's own signal:

framework=Tool failures surface as
"pydantic_ai"pydantic_ai.ModelRetry
"langchain"langchain_core.tools.ToolException (set handle_tool_error=True to feed it back to the model)
"openai_agents"the failure message returned to the model as the tool result
"mcp"fastmcp.exceptions.ToolError
"none" (default)airbyte_agent_sdk.AirbyteToolError

On a framework the SDK does not support natively — or in a raw LLM dispatch loop — omit framework= and handle AirbyteToolError yourself:

No framework
from airbyte_agent_sdk import AirbyteToolError
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.linkedin_ads import LinkedinAdsConnector

connector = connect("linkedin-ads", workspace_name="<your_workspace_name>")

@LinkedinAdsConnector.agent_tool(
    inspect_tool="linkedin_ads_inspect",
    docs_tool="linkedin_ads_read_docs",
)
async def linkedin_ads_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

@LinkedinAdsConnector.agent_tool()
async def linkedin_ads_inspect():
    return await connector.inspect_connector()

@LinkedinAdsConnector.agent_tool()
async def linkedin_ads_read_docs(section: str | None = None):
    return await connector.read_skill_docs(section)

# Advertise all three to the model, using each function's docstring as its description.
handlers = {
    fn.__name__: fn
    for fn in (linkedin_ads_inspect, linkedin_ads_read_docs, linkedin_ads_execute)
}

# `tool_name` and `tool_args` come from the model's tool call in your dispatch loop.
try:
    tool_result = await handlers[tool_name](**tool_args)
except AirbyteToolError as err:
    tool_result = str(err)  # hand the message back to the model as an errored tool result

Each function's docstring carries the guidance the model needs, so pass it through as the tool description wherever you register it.

Legacy alternatives​

These examples are kept for existing integrations. The deprecated LinkedinAdsConnector.tool_utils pattern loads the connector's full generated catalog into one broad execute tool description instead of letting the agent read skill docs on demand. For new code, use build_connector_tools or LinkedinAdsConnector.agent_tool above.

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.linkedin_ads import LinkedinAdsConnector

connector = connect("linkedin-ads", workspace_name="<your_workspace_name>")

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@LinkedinAdsConnector.tool_utils
async def linkedin_ads_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Or pass credentials explicitly (equivalent, useful when you're not loading them from the environment):

Pydantic AI
from airbyte_agent_sdk import build_connector_tools
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.linkedin_ads import LinkedinAdsConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig

connector = LinkedinAdsConnector(
    auth_config=AirbyteAuthConfig(
        workspace_name="<your_workspace_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

tools = build_connector_tools(connector, framework="pydantic_ai")
agent = Agent("openai:gpt-4o", tools=tools.as_list())
Open source​

In open source mode, you provide API credentials directly to the connector.

The recommended pattern is build_connector_tools, which gives the agent three tools bound to this connector: inspect_connector, read_skill_docs, and execute. The agent can inspect the connector, read only the skill-doc section it needs, and then execute:

inspect_connector() -> read_skill_docs() -> read_skill_docs(section="...") -> execute(entity, action, params)

Pass section IDs verbatim as the outline lists them, prefix included (actions.<entity>.<action>, not <entity>.<action>); anything else returns an error the agent has to recover from.

The builder names its tools inspect_connector, read_skill_docs, and execute, so the tool sets for more than one connector collide when registered on the same agent. Renaming the callables at registration avoids the collision, but the generated execute guidance still names inspect_connector and read_skill_docs, pointing the model at the wrong tools. Use the agent_tool pattern below instead: it weaves your own names into that guidance.

Pydantic AI
from airbyte_agent_sdk import build_connector_tools
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.linkedin_ads import LinkedinAdsConnector
from airbyte_agent_sdk.connectors.linkedin_ads.models import LinkedinAdsAccessTokenAuthenticationAuthConfig

connector = LinkedinAdsConnector(
    auth_config=LinkedinAdsAccessTokenAuthenticationAuthConfig(
        access_token="<The access token generated for your developer application>"
    )
)

tools = build_connector_tools(connector, framework="pydantic_ai")
agent = Agent("openai:gpt-4o", tools=tools.as_list())
Custom tool bodies​

When you need custom tool bodies — or a framework without native support — use LinkedinAdsConnector.agent_tool. Register execute, inspect, and docs together so the agent can fetch connector guidance progressively. Pass the framework explicitly when it has a supported failure strategy:

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.linkedin_ads import LinkedinAdsConnector
from airbyte_agent_sdk.connectors.linkedin_ads.models import LinkedinAdsAccessTokenAuthenticationAuthConfig

connector = LinkedinAdsConnector(
    auth_config=LinkedinAdsAccessTokenAuthenticationAuthConfig(
        access_token="<The access token generated for your developer application>"
    )
)

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@LinkedinAdsConnector.agent_tool(
    framework="pydantic_ai",
    inspect_tool="linkedin_ads_inspect",
    docs_tool="linkedin_ads_read_docs",
)
async def linkedin_ads_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

@agent.tool_plain
@LinkedinAdsConnector.agent_tool(framework="pydantic_ai")
async def linkedin_ads_inspect():
    return await connector.inspect_connector()

@agent.tool_plain
@LinkedinAdsConnector.agent_tool(framework="pydantic_ai")
async def linkedin_ads_read_docs(section: str | None = None):
    return await connector.read_skill_docs(section)

Use the same three-function pattern with framework="langchain", "openai_agents", or "mcp" and that framework's registration decorator. Each value translates connector failures into the framework's own signal:

framework=Tool failures surface as
"pydantic_ai"pydantic_ai.ModelRetry
"langchain"langchain_core.tools.ToolException (set handle_tool_error=True to feed it back to the model)
"openai_agents"the failure message returned to the model as the tool result
"mcp"fastmcp.exceptions.ToolError
"none" (default)airbyte_agent_sdk.AirbyteToolError

On a framework the SDK does not support natively — or in a raw LLM dispatch loop — omit framework= and handle AirbyteToolError yourself:

No framework
from airbyte_agent_sdk import AirbyteToolError
from airbyte_agent_sdk.connectors.linkedin_ads import LinkedinAdsConnector
from airbyte_agent_sdk.connectors.linkedin_ads.models import LinkedinAdsAccessTokenAuthenticationAuthConfig

connector = LinkedinAdsConnector(
    auth_config=LinkedinAdsAccessTokenAuthenticationAuthConfig(
        access_token="<The access token generated for your developer application>"
    )
)

@LinkedinAdsConnector.agent_tool(
    inspect_tool="linkedin_ads_inspect",
    docs_tool="linkedin_ads_read_docs",
)
async def linkedin_ads_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

@LinkedinAdsConnector.agent_tool()
async def linkedin_ads_inspect():
    return await connector.inspect_connector()

@LinkedinAdsConnector.agent_tool()
async def linkedin_ads_read_docs(section: str | None = None):
    return await connector.read_skill_docs(section)

# Advertise all three to the model, using each function's docstring as its description.
handlers = {
    fn.__name__: fn
    for fn in (linkedin_ads_inspect, linkedin_ads_read_docs, linkedin_ads_execute)
}

# `tool_name` and `tool_args` come from the model's tool call in your dispatch loop.
try:
    tool_result = await handlers[tool_name](**tool_args)
except AirbyteToolError as err:
    tool_result = str(err)  # hand the message back to the model as an errored tool result

Each function's docstring carries the guidance the model needs, so pass it through as the tool description wherever you register it.

Legacy alternatives​

These examples are kept for existing integrations. The deprecated LinkedinAdsConnector.tool_utils pattern loads the connector's full generated catalog into one broad execute tool description instead of letting the agent read skill docs on demand. For new code, use build_connector_tools or LinkedinAdsConnector.agent_tool above.

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.linkedin_ads import LinkedinAdsConnector
from airbyte_agent_sdk.connectors.linkedin_ads.models import LinkedinAdsAccessTokenAuthenticationAuthConfig

connector = LinkedinAdsConnector(
    auth_config=LinkedinAdsAccessTokenAuthenticationAuthConfig(
        access_token="<The access token generated for your developer application>"
    )
)

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@LinkedinAdsConnector.tool_utils
async def linkedin_ads_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Authentication​

For all authentication options, see the connector's authentication documentation.

IP allow list​

If your organization restricts access to specific IPs, add the Airbyte Agents IP addresses to your allow list.

Version information​

Connector version: 1.2.0

Was this page helpful?