Skip to main content

Airbyte Facebook-Marketing Connector for AI platforms

Project description

Facebook-Marketing agent connector

Facebook Marketing API connector for managing ad campaigns, ad sets, ads, creatives, and accessing performance insights. This connector provides read access to Facebook Ads Manager data for analytics and reporting purposes.

Example questions

The Facebook-Marketing connector is optimized to handle prompts like these.

  • List all active campaigns in my ad account
  • What ads are currently running in a recent campaign?
  • List all ad creatives in my account
  • What is the status of my campaigns?
  • List all custom conversion events in my account
  • Show me all ad images in my account
  • What videos are available in my ad account?
  • Show me the ad sets with the highest daily budget
  • Show me the performance insights for the last 7 days
  • Which campaigns have the most spend this month?
  • Show me ads with the highest click-through rate

Unsupported questions

The Facebook-Marketing connector isn't currently able to handle prompts like these.

  • Create a new campaign
  • Update the budget for this ad set
  • Pause all ads in this campaign
  • Delete this ad creative

Installation

uv pip install airbyte-agent-facebook-marketing

Usage

Connectors can run in open source or hosted mode.

Open source

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

from airbyte_agent_facebook_marketing import FacebookMarketingConnector
from airbyte_agent_facebook_marketing.models import FacebookMarketingServiceAccountKeyAuthenticationAuthConfig

connector = FacebookMarketingConnector(
    auth_config=FacebookMarketingServiceAccountKeyAuthenticationAuthConfig(
        account_key="<Facebook long-lived access token for Service Account authentication>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@FacebookMarketingConnector.tool_utils
async def facebook_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.

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.

from airbyte_agent_facebook_marketing import FacebookMarketingConnector, AirbyteAuthConfig

connector = FacebookMarketingConnector(
    auth_config=AirbyteAuthConfig(
        external_user_id="<your_external_user_id>",
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@FacebookMarketingConnector.tool_utils
async def facebook_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Full documentation

Entities and actions

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

Entity Actions
Current User Get
Ad Accounts List, Search
Campaigns List, Get, Search
Ad Sets List, Get, Search
Ads List, Get, Search
Ad Creatives List, Search
Ads Insights List, Search
Ad Account Get, Search
Custom Conversions List, Search
Images List, Search
Videos List, Search

Authentication and configuration

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

Facebook-Marketing API docs

See the official Facebook-Marketing API reference.

Version information

  • Package version: 0.1.30
  • Connector version: 1.0.15
  • Generated with Connector SDK commit SHA: df1e8094b5b2d94e172536ce7f33fb98f2c3fdc1
  • Changelog: View changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_facebook_marketing-0.1.30.tar.gz (156.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file airbyte_agent_facebook_marketing-0.1.30.tar.gz.

File metadata

File hashes

Hashes for airbyte_agent_facebook_marketing-0.1.30.tar.gz
Algorithm Hash digest
SHA256 a2e602c8a5d99754239fcdd2ed193852e3fee26ed5c9a92d4ae42a936a652dfd
MD5 e4ea7c53702010d25f7fee7365b4e72e
BLAKE2b-256 eff1734588567a7b7f770ed3c9cd145a312c3a3847d4bd337a01746a21e88e97

See more details on using hashes here.

File details

Details for the file airbyte_agent_facebook_marketing-0.1.30-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_facebook_marketing-0.1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 dbeba2b28c7060d93e2485fd37d8a9ced6b637aa2dd38a97016aed740979f6ef
MD5 ab5dff8094c0b4812722506b8fbe08d6
BLAKE2b-256 06c06b36a65f9cb6935bf94a8cbc44538c1e94a730d1d800f482628a4444a10c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page