Ads and Commerce

Overview

Marketing API

Marketing API Overview

About Marketing API

How it works

Versioning

Rate Limiting

Data Processing Options

Get Started with Marketing API

Create an Ad Campaign

Create an Ad Set

Create an Ad Creative

Create an Ad

Manage Campaigns

Ad Performance & Optimization

Optimization Basics

Monitoring and Analytics

Optimization Tips

Ad Creative

Introduction to Ad Creatives

Testing and Troubleshooting

Advantage+ Catalog Ads for Leadgen

Advantage+ Catalog Ads

Website Ads Click to Message

Advantage+ Shopping Campaign Guides

Advantage+ Shopping Campaign API

Cross-Channel Conversion Optimization

Audience Type URL Parameters

Shops Ads

Asset Feed Spec Guides

Asset Customization Rules

Placement Asset Customization

Multi-Language Ads

Insights

Advantage+ Catalog Ads Guides

Advantage+ Catalog Ads

Get Started

Advantage+ Catalog Ads Mobile

Advantage+ App Campaigns

Dynamic Media Guides

Dynamic Media

FAQ

Multi-Aspect Ratio Images

Advantage+ Creative for Catalog

Real Estate Ads Guides

Real Estate Ads

Get Started

Audiences & Management

Travel Ads - Audience Management

Hotel Ads Guides

Hotel Ads

Hotel Ads - Catalog & Feed

Hotel Ads - Events

Hotel Ads - Template Tags

Hotel Ads - Date-Specific Prices

Flight Ads Guides

Flight Ads

Flight Ads Catalog & Feed

Flight Events

Flight Ads - Template Tags

Destination Ads Guides

Destination Ads

Destination Catalog

Destination Events

Destination Ads - Template Tags

Automotive Ads Guides

Automotive Ads

Overview

Get Started

Automotive Ads Management

Common Set Ups

Automotive Inventory Ads

Advantage+ Catalog Ads with an On-Facebook Destination

FAQ

Advantage+ Creative Guides

Advantage+ Creative

Get Started

Add Site Links

Product Extensions for Advantage+ Creative

Standard Enhancements for Advantage+ Creative

Advantage+ Creative Preview API

Omnichannel Ads

Generative AI Features

Collaborative Ads Guides

Pacing and Scheduling

Bidding & Optimization

Guides

Advantage Campaign Budget

Ad Set Budget Sharing

Optimized Cost Per Mille Ads

Cost Per Action Ads

Reservation

Bid Multipliers

Cross-Channel Conversion Optimization

Value Rules

Ad Rules Engine Guides

Evaluation Spec Filters

Limits & Best Practices

Tracking and Conversion Specs

Marketing Mix Modeling

Conversion Lift Measurement

Brand Safety and Suitability Guides

Brand Safety and Suitability

Integration Setup

Publisher Block Lists API

Content Allow Lists API

Content Block Lists API

Content Delivery Reports API

Feed Verification API

Publisher Delivery Reports API

Passback API

Partner-publisher Lists API

Best Practices & Recommendations

Best Practices

Ads Performance Recommendations

Omni Optimal Setup Guide

Manage Your Ad Object's Status

Async and Batch Requests

Post-Processing for Ad Creation

Out-of-Cycle Change Index

Conversions API Overview

Server Event Parameters

Customer Information Parameters

External ID

fbp and fbc Parameters

Standard Parameters

App Data Parameters

Original Event Data

Parameter Builder Library

Get Started

Workflow and Examples

Conversions API for App Events

Conversions API for Offline Events

Conversions API for Business Messaging

Conversion Leads Integration

1: Connecting Your CRM to Download Leads

2: Getting Started with Integration

3: Developer Implementation

3: Zapier Implementation

Prerequisites

Step 1: Implement Integration

Step 2: Verify Integration

4: Verify Your Data

5: Configure Your Sales Funnel

6: Follow-up Steps

Payload Specification

Find the Lead ID

FAQs

Dataset Quality API

Dataset Quality API for Offline Events

Handling Duplicate Events

Guides

End-to-end Implementation

Conversions API as a Platform

Zapier Integration

Conversions API for Google Tag Manager

Conversions API for CRM for Platforms

Set Up Conversions API with Salesforce Webhooks

Business SDK Features for Conversions API

Integration Guidance: Value Optimization

Conversions API Gateway

Getting Started

Setup Guide

DNS Setup Guide

Post-Setup Management

Non-Web Server Events API Support

Upload Events

System Health Information

Enhance Events with Advanced Matching Data

Include Facebook Login Data in the Conversions API

Troubleshooting Tools

Troubleshooting Guide

Uninstall Guide

Changelog

Conversions API Gateway: AWS App Runner

Automatic and Manual Updates

Uninstall Guide

Conversions API Gateway for Multiple Accounts

Host Onboarding: AWS EKS

1. Create Instance

2. Configure a Host Account

3. Set Up Custom Domain

Host Onboarding: AWS App Runner

1. Create Instance

2. Configure a Host Account

3. Set Up Custom Domain

Host Onboarding: GCP

1. Create Instance

2. Create a Custom Domain

3. Set Auto-Scaling Limits

Host Management

Host User Management

Managing Hosted Accounts

Host Settings

Set Up SMTP Configuration

Account Onboarding and Management

Onboarding and Offboarding Unmanaged Accounts

User Management for Hosted Accounts

Data Source Management

Manage Domain Allow and Block Lists

Configure Data Routing for Hosted Accounts

Architecture

AWS EKS Architecture

AWS App Runner Architecture

GCP Architecture

Monitoring Your Setup

Prospective Agencies: FAQs

Troubleshooting Tools

Troubleshooting Guide

Uninstall Guide

Glossary

Conversions API Gateway for Multiple Accounts Control Plane API

Account Data Routing Configuration

Account Event Metrics

Conversions API Gateway and Signals Gateway

Gateway Products Overview

Conversions API Gateway

Setup Guide

Instance Activation

Enhance Events With Additional User Data

Include Facebook Login Data in the Conversions API

Monitor Your Setup

Data Source Management

Post-Setup Management

Account Management

Onboarding and Offboarding Unmanaged Hosted Accounts

Data Routing

Manage Domain Allow-Lists and Block-Lists

Host Settings

Host User Management

Set Up SMTP Configuration

Set Auto-Scaling Limits

System Health Information

DNS Setup Guide

Conversions API Gateway Pipeline

Advanced Matching

Include Facebook Login Data

Account Event Metrics

Objects

Set Up Data Pipelines

Create an Instance: Agencies and Partners

Create Instance From Events Manager

GCP Architecture

Create Custom Domain for GCP

AWS EKS Onboarding

AWS ECS Express Onboarding

AWS ECS Express Architecture

Custom Domain Setup

Cost Monitoring

Updates

Troubleshooting Guide

Sending Events From a Server

Supported Products and Services

Catalog Integration Using Meta Business SDK

Payment and Data Flows

Accounts and Assets

Get Started

API Integration Setup

Partner Integration Basics

Onboarding Integration

Catalog Integration

Build Offers Integration

Onboarding Integration for FBE

Commerce Manager Redirect Onboarding

On Behalf Of

Page Eligibility for Commerce

Troubleshooting

Merchant Distribution for MP/IG

Marketplace Approval API

Merchant Support

Validate the Integration

Product Review Feed Schema

Feed Schema CSV

Automate Ratings and Reviews Seller Analysis

Migrate to Simplified Shops Ads API

Set Up Checkout URL

Enable Subscriptions

Shops Ads Lightweight BOPIS Experience

Shops Ads Heavyweight BOPIS Experience

Catalog and Inventory

Cancellation and Refund API

Returns API

Legacy API Reference

Shipping Profiles API Reference

Associate Shipping Profiles with Products

Shipping Carrier Codes

Plan Your Integration

Commerce Integration - Platform Partners

Inventory

Orders

Shipping and Fulfillment

Post Purchase

Test Plan

Customer Communication

Datasets and catalogs

Tutorials and recipes

Resources

Targetingsentencelines

Ad Account

Overview

Aaa Compatible Ad Objects

Ad Custom Derived Metrics

Ad Place Page Sets

Ad Place Page Sets Async

Adrules Count By Type

Adrules Library

Ads

Ads Reporting Mmm Reports

Ads Reporting Mmm Schedulers

Applied Publisher Block Lists

Broadtargetingcategories

Campaign Attribution Options

Campaigns

Collaborative Ads Partner Businesses

Connected Instagram Accounts

Deprecatedtargetingadsets

Message Delivery Estimate

Minimum Budgets

Naming Templates

Offline Conversion Data Sets

Optimization Goals Aemv2 Eligibility

Publisher Block Lists

Reachestimate

Reachfrequencypredictions

Start Your Day Widgets

Urls For Asset Extraction

Users

Website Creative Assets

Website Creative Info

Message Delivery Estimate

Publisher Delivery Report

Targeting Insights

Targetingsentencelines

Ad Study

Overview

Cells

Continuous Lift Config

Adnetworkanalytics Export

Adnetworkanalytics Results

Ads Custom Pivots Preview

Ads Reporting Exports

Ads Reporting Mmm Reports

Ads Reporting Mmm Schedulers

Adspixels

Agencies

An Placements

An Publisher Blocklist Apps

An Publisher Blocklist Categories

An Publisher Blocklist Domains

An Publisher Blocklist Pages

Applied Publisher Block Lists

Business Asset Groups

Business Invoices

Business Users

China Business Onboarding Attributions

Claim Custom Conversions

Client Ad Accounts

Client Apps

Client Business Asset Groups

Client Instagram Accounts

Client Instagram Assets

Client Objects

Client Offsite Signal Container Business Objects

Client Pages

Client Pixels

Client Product Catalogs

Client Publisher Block Lists

Client Whatsapp Business Accounts

Clients

Collaborative Ads Collaboration Requests

Collaborative Ads Suggested Partners

Commerce Merchant Settings

Initiated Audience Sharing Requests

Initiated Sharing Agreements

Instagram Accounts

Instagram Business Accounts

Managed Businesses

Managed Partner Ads Funding Source Details

Managed Partner Businesses

Measurement Reports

Offline Conversion Data Sets

Openbridge Configurations

Owned Ad Accounts

Owned Apps

Owned Businesses

Owned Custom Conversions

Owned Domains

Owned Instagram Accounts

Owned Instagram Assets

Owned Offsite Signal Container Business Objects

Owned Pages

Owned Pixels

Owned Product Catalogs

Owned Publisher Block Lists

Owned Whatsapp Business Accounts

Pages

Parent Advertiser Infos

Partner Account Linking

Partner Center Export Files

Partner Relationships

Partners

Pending Client Ad Accounts

Pending Client Apps

Pending Client Pages

Pending Offline Conversion Data Sets

Pending Owned Ad Accounts

Pending Owned Pages

Pending Shared Offsite Signal Container Business Objects

Pending Shared Pixels

Pending Users

Preverified Numbers

Publisher Block Lists

Received Audience Permissions

Received Audience Sharing Requests

Received Inprogress Onbehalf Requests

Received Inprogress Transfer Ownership Agreements

Received Sharing Agreements

Reseller Events

Reseller Guidances

Resellervettingrequests

Salesrights Inventory Management

Self Certified Whatsapp Business Submissions

Self Certify Whatsapp Business

Sent Inprogress Onbehalf Requests

Share Preverified Numbers

Shared Audience Permissions

Sso Migrated Business Users

Sso Unmigrated Business Users

System User Access Tokens

System Users

Third Party Partner Lift Requests

Third Party Partner Panel Recurring Requests

Third Party Partner Panel Requests

Third Party Partner Viewability Requests

Videos

Whatsapp Business Accounts

Business Role Request

Overview

Assigned Client Assets

Assigned Owned Assets

Assigned Business Asset Groups

Assigned Creative Folders

Assigned Instagram Accounts

Assigned Monetization Properties

Assigned Offline Conversion Data Sets

Assigned Pages

Assigned Product Catalogs

Assigned Whatsapp Business Accounts

Currencies

Custom Audience Targeting

Shared Account Campaign Info

Assigned Business Asset Groups

Assigned Creative Folders

Assigned Instagram Accounts

Assigned Monetization Properties

Assigned Offline Conversion Data Sets

Assigned Pages

Assigned Product Catalogs

Assigned Whatsapp Business Accounts

Changelog

Error codes

Version

Ad Account Tax Info

Updated: May 19, 2019

Reading

You can’t perform this operation on this endpoint.

Creating

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.

Did you find this page helpful?