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
from airbyte_agent_facebook_marketing._vendored.connector_sdk.types import AirbyteHostedAuthConfig

connector = FacebookMarketingConnector(
    auth_config=AirbyteHostedAuthConfig(
        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
Campaigns List, Get
Ad Sets List, Get
Ads List, Get
Ad Creatives List
Ads Insights List
Ad Account Get
Custom Conversions List
Images List
Videos List

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.17
  • Connector version: 1.0.14
  • Generated with Connector SDK commit SHA: 5c699b63de47ab09d9e52e38d1c61f7f994da24d
  • 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.17.tar.gz (152.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.17.tar.gz.

File metadata

File hashes

Hashes for airbyte_agent_facebook_marketing-0.1.17.tar.gz
Algorithm Hash digest
SHA256 d6a997ab1204aa696b26fb2ea263c3ccfc58eddfa9d67e2f1010601a4e856ae6
MD5 6127b9382c3e5579d87963402bdbd515
BLAKE2b-256 bfda67e14cab0ff4580bea91df4a212e8e83bf959460d900490c0f2c86902463

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_facebook_marketing-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 c0877602d9a28fbfd271b199db034c5206db4838ee98d8fd633cd96c37890b4c
MD5 815684c904f695a1f8c175be79f84e47
BLAKE2b-256 d3004297081e782b3a5ca249e57deb3070ce69670651e17cc164cc321a3cec20

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