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

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 FacebookMarketingAuthConfig

connector = FacebookMarketingConnector(
    auth_config=FacebookMarketingAuthConfig(
        access_token="<Facebook OAuth2 Access Token>",
        client_id="<Facebook App Client ID>",
        client_secret="<Facebook App 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 {})

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

connector = FacebookMarketingConnector(
    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 List
Campaigns List, Get
Ad Sets List, Get
Ads List, Get
Ad Creatives List
Ads Insights List
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.7
  • Connector version: 1.0.8
  • Generated with Connector SDK commit SHA: 940246757c7476ed4edd7d16b873ebe54ea2b456
  • 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.7.tar.gz (145.3 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.7.tar.gz.

File metadata

File hashes

Hashes for airbyte_agent_facebook_marketing-0.1.7.tar.gz
Algorithm Hash digest
SHA256 edd9006cf09512a5d3b728f61f21c817387462af6c5c7681a3abbf99ac38bb37
MD5 d3d011df1eb6f8c512928929d8745bcc
BLAKE2b-256 1db781d2a1341550e27d0efeeaa876eff4d6b61ec49754cc8b1b891cb37fe3a2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_facebook_marketing-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e882903780816322a70f4fa43d5f41fecd15728b7a21278f1d0c6639124b129c
MD5 41f70a55ac64b10c8fea2fb5b78d037b
BLAKE2b-256 01cfa825e52ba56dfb08729ed4422dd81886eb61f481028a25857dbfb3a30552

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