Meta Ads Component

Interact with ads and adsets in your Meta Ads account.
Component key: facebook-marketing
Description
Meta Ads (Formerly known as Facebook Marketing) is a digital advertising platform that allows businesses to create, manage, and optimize ads across Meta products, including Facebook, Instagram, and WhatsApp.
API Documentation
This component was built using the Meta Ads Marketing API Reference utilizing version V22.0
Connections
Conversions API Access Token
Input | Notes |
---|---|
Access Token string / Required token | A valid access token for Meta Ads API |
Meta Ads Oauth 2.0
This component uses OAuth 2.0 to connect to the Meta Ads Marketing API. To get started with Meta Ads, you first need to create a developer account.
- Select Create app, take note of the App Id and App Secret under the basic tab.
- Navigate to the Facebook Login Section:
- Under the Valid OAuth Redirect URIs section add as a Redirect URI.
https://oauth2.prismatic.io/callback
- Under the Valid OAuth Redirect URIs section add
- Now add a new Meta Ads action to your flow, and you will see a new connection.
- Enter the values that you previously saved from your Facebook Developer App.
- All the scopes you need should already exist in the connection. However if you need to enter additional scopes you can refer to Meta Ads Docs to find the correct ones.
Now you can make a new Meta Ads connection, and provide the values you obtained earlier.
For any additional setup information, refer to the Meta Ads Docs
Input | Default | Notes | Example |
---|---|---|---|
Authorize URL string / Required authorizeUrl | https://www.facebook.com/v22.0/dialog/oauth | Provide a valid authURL for Meta Ads | |
App Id string / Required clientId | Provide the App Id that was generated from your Meta Ads App. | 1233096058094633 | |
App Secret password / Required clientSecret | Provide the App Secret that was generated from your Meta Ads App. | 7699008007296c1689ddd30b0cf7c924 | |
Scopes string / Required scopes | ads_read ads_management pages_show_list groups_access_member_info leads_retrieval page_events pages_read_user_content public_profile | Provide a valid list of scopes. A list per use case is provided on the Meta Ads docs: https://developers.facebook.com/docs/marketing-api/overview/authorization/ | |
Token URL string / Required tokenUrl | https://graph.facebook.com/v22.0/oauth/access_token | Provide a valid Meta Ads version to complete the Token URL |
Sandbox Ad Account Token
This component may also use the Sandbox Ad token to connect a Meta Ad's Sandbox Ad Account To get started with Meta Ads, you first need to create a developer account.
- Select Create app, take note of the App Id and App Secret under the basic tab.
- Navigate and expand the Marketing API Section and select the Tools section.
- In the Sandbox Ad Account Management section, create and name a new Sandbox Ad Account.
- Under Actions select the button with a key icon and in the Generate Access Token window Select Generate
- Add this Access Token to the Sandbox Ad Token Connection Type.
- All the scopes you need should already exist in the connection. However if you need to enter additional scopes you can refer to Meta Ads Docs to find the correct ones.
For any additional setup information, refer to the Meta Ads Docs
Input | Notes |
---|---|
Sandbox Token string / Required token | A valid sandbox token for Meta Ads API |
Data Sources
Business Names
A picklist of business names | key: businessNames | type: picklist
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Actions
Add URL Tags To Ad Creative
Update an existing Ad Creative to include a new set of URL Tags. | key: addUrlTagsToCreative
Input | Default | Notes | Example |
---|---|---|---|
Ad Account string / Required adAccountId | Provide the identifier of an Ad Account. This value should be an Id. | act_342512647855388 | |
After string after | Provide the token for the item after the current one. | xOTQ1MjAwNzI5NDE= | |
Before string before | Provide the token for the item before the current one. | xOTQ1MjAwNzI5NDE= | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | name, object_story_spec, adlabels, body, object_id, url_tags | Provide a comma separated list of fields to be returned. | |
Limit string limit | Provide a limit for the result set. | 30 | |
Object Story Id string / Required objectStoryId | Provide an Id for the object story of the adCreative. | 1051738543535_10636436633230 | |
Optional Values string Key Value List optionalValues | Provide optional values to mutate the given object. | ||
URL Tags string / Required urlTags | Provide an string for the URL tags on the given adCreative. | key1=val1&key2=val2 | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Create Ad
Creates a new ad. | key: createAd
Input | Default | Notes | Example |
---|---|---|---|
Ad Schedule End Time string ad_schedule_end_time | Indicates the end time for the ad. If no end time is defined, the ad will run on the campaign's schedule. | 2022-10-10T00:00:00Z | |
Ad Schedule Start Time string ad_schedule_start_time | Indicates the start time for the ad. If no start time is defined, the ad will run on the campaign's schedule. | 2022-10-10T00:00:00Z | |
Ad Account string / Required adAccountId | Provide the identifier of an Ad Account. This value should be an Id. | act_342512647855388 | |
Ad Labels code adLabels | Ad labels associated with this ad. | ||
Adset Id string / Required adset_id | ID of the ad set that contains the ad. | 23849551358310668 | |
Adset Spec code adset_spec | The ad set spec for this ad. When the spec is provided, Adset Id field is not required. | ||
Audience Id string audience_id | The ID of the audience. | ||
Connection connection / Required connection | |||
Conversion Domain string conversion_domain | The domain where conversions happen. The field is no longer required for creation or update since June 2023. Note that this field should contain only the first and second level domains, and not the full URL. | facebook.com | |
Creative code / Required creative | This field is required for create. The ID or creative spec of the ad creative to be used by this ad. You may supply the ID within an object as shown in the example. | ||
Date Format string date_format | The format of the date. | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Display Sequence string display_sequence | The sequence of the ad within the same campaign. | ||
Engagement Audience boolean engagement_audience | false | Flag to create a new audience based on users who engage with this ad. | |
Include Demolink Hashes boolean include_demolink_hashes | false | Include the demolink hashes. | |
Name string / Required name | Name of the ad. | My Ad Creative | |
Priority string priority | Priority of the ad. | ||
Source Ad Id string source_ad_id | ID of the source Ad, if applicable. | ||
Ad Status string / Required status | Provide a status for the ad. During testing, it is recommended to set ads to a PAUSED status so as to not incur accidental spend. | ||
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Create Campaign
Creates a new campaign. | key: createCampaign
Input | Default | Notes | Example |
---|---|---|---|
Ad Account string / Required adAccountId | Provide the identifier of an Ad Account. This value should be an Id. | act_342512647855388 | |
Ad Labels code adLabels | Ad Labels associated with this campaign. | ||
Bid Strategy string bid_strategy | Choose bid strategy for this campaign to suit your specific business goals. | ||
Buying Type string buying_type | This field will help Meta Ads make optimizations to delivery, pricing, and limits. All ad sets in this campaign must match the buying type. | ||
Campaign Optimization Type string campaign_optimization_type | Campaign Optimization Type. | ||
Campaign Name string / Required campaignName | Name for this campaign. | ||
Connection connection / Required connection | |||
Daily Budget string daily_budget | Daily budget of this campaign. All adsets under this campaign will share this budget. You can either set budget at the campaign level or at the adset level, not both. | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Is Skadnetwork Attribution boolean is_skadnetwork_attribution | false | To create an iOS 14 campaign, enable SKAdNetwork attribution for this campaign. | |
Is Using L3 Schedule boolean is_using_l3_schedule | false | Is Using L3 Schedule. | |
Iterative Split Test Configs code iterative_split_test_configs | Array of Iterative Split Test Configs created under this campaign. | ||
Lifetime Budget string lifetime_budget | Lifetime budget of this campaign. All adsets under this campaign will share this budget. You can either set budget at the campaign level or at the adset level, not both. | ||
Objective string / Required objective | Campaign's objective. If it is specified the API will validate that any ads created under the campaign match that objective. | ||
Promoted Object code promoted_object | The object this campaign is promoting across all its ads. It's required for SKAdNetwork or Aggregated Event Measurement campaign creation. Only product_catalog_id is used at the ad set level. | ||
Source Campaign Id string source_campaign_id | Used if a campaign has been copied. The ID from the original campaign that was copied. | ||
Special Ad Categories string / Required Value List special_ad_categories | Special Ad Categories. | ||
Special Ad Category Country string Value List special_ad_category_country | Special Ad Category Country. | ||
Spend Cap string spend_cap | A spend cap for the campaign, such that it will not spend more than this cap. Defined as integer value of subunit in your currency with a minimum value of $100 USD (or approximate local equivalent). Set the value to 922337203685478 to remove the spend cap. Not available for Reach and Frequency or Premium Self Serve campaigns. | ||
Start Time string start_time | Start Time. | ||
Ad Status string / Required status | Only ACTIVE and PAUSED are valid during creation. Other statuses can be used for update. If it is set to PAUSED, its active child objects will be paused and have an effective status CAMPAIGN_PAUSED. | ||
Stop Time string stop_time | Stop Time. | ||
Topline Id string topline_id | Topline Id. | ||
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Create Conversion
Create a single conversion event for a pixel. Requires the Conversions API Access Token connection. | key: createConversion
Input | Default | Notes | Example |
---|---|---|---|
Action Source string / Required actionSource | This field allows you to specify where your conversions occurred. | website | |
Connection connection / Required connection | |||
Custom Data code customData | A map that includes additional business data about the event. See https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data. | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Event Name string / Required eventName | A standard event or custom event name. | Purchase | |
Event Source Url string eventSourceUrl | The browser URL where the event happened. | http://jaspers-market.com/product/123 | |
Event Time string eventTime | A Unix timestamp in seconds indicating when the actual event occurred. The specified time may be earlier than the time you send the event to Meta Ads. You must send this date in GMT time zone. Default is the current time. | 1633552688 | |
More Data code moreData | Additional data to include with the event. See https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event. | ||
Pixel Id string / Required pixelId | Provide the Id of a pixel. | 587490763 | |
User Data code / Required userData | A map that contains customer information data. See https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters. | ||
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
{
"data": {
"events_received": 1,
"messages": [],
"fbtrace_id": "AsGY30oxXE4Dvv_CDbCOFR6"
}
}
Create Multiple Conversions
Create multiple conversion events for a pixel. Requires the Conversions API Access Token connection. | key: createMultipleConversions
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Events code / Required events | An array of server event objects. See https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event for more information. | ||
Pixel Id string / Required pixelId | Provide the Id of a pixel. | 587490763 | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
{
"data": {
"events_received": 1,
"messages": [],
"fbtrace_id": "AsGY30oxXE4Dvv_CDbCOFR6"
}
}
Delete Ad
Delete the information and metadata of a given ad. | key: deleteAd
Input | Default | Notes | Example |
---|---|---|---|
Ad Id string / Required adId | Ad ID to delete. | 342512647855388 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Get Ad
Get the information and metadata of a given ad. | key: getAd
Input | Default | Notes | Example |
---|---|---|---|
Ad Id string / Required adId | Ad ID to get. | 342512647855388 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | name,adset,account_id,ad_review_feedback,adlabels,adset_id,bid_amount,campaign,campaign_id,configured_status,conversion_domain,created_time,creative,effective_status,issues_info,last_updated_by_app_id,preview_shareable_link,recommendations,status,tracking_specs | Provide a comma separated list of fields to be returned. | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Get Ad Account
Get the information and metadata of the given ad account. | key: getAdAccount
Input | Default | Notes | Example |
---|---|---|---|
Ad Account string / Required adAccountId | Provide the identifier of an Ad Account. This value should be an Id. | act_342512647855388 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | name,age,balance,is_personal,account_status,line_numbers,adcreatives | Provide a comma separated list of fields to be returned. | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Get Ad Creative
Get the information and metadata of the given ad creative. | key: getAdCreative
Input | Default | Notes | Example |
---|---|---|---|
Ad Creative string / Required adCreativeId | Provide a unique identifier of the Ad Creative. This value should be an ID. | 342512647855388 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | name, object_story_spec, adlabels, body, object_id, url_tags | Provide a comma separated list of fields to be returned. | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Get Ad Set
Get the information and metadata of a given Ad Set. | key: getAdSet
Input | Default | Notes | Example |
---|---|---|---|
Ad Set Id string / Required adId | The ID of the Ad Set to retrieve. | 342512647855388 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | name,account_id,adlabels,adset_schedule,asset_feed_id,attribution_spec,bid_adjustments,bid_amount,bid_constraints,bid_info,billing_event,budget_remaining,campaign,configured_status,created_time,creative_sequence,daily_budget,daily_min_spend_target,daily_spend_cap,destination_type,effective_status,end_time,optimization_goal,optimization_sub_event,pacing_type,promoted_object,recommendations,status,targeting,start_time,targeting_optimization_types,updated_time | Provide a comma separated list of fields to be returned. | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Get Business By Name
Fetch an business with the provided name. | key: businessByName
Input | Default | Notes | Example |
---|---|---|---|
Business Name string / Required businessName | |||
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
{
"data": {
"id": "123456789012345",
"name": "Example User's Business"
}
}
Get Current User
Get the information and metadata of the current user. | key: getCurrentUser
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Get User By Id
Get the information and metadata of a given user. | key: getUserById
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
User Id string / Required userId | Provide the Id of a user. | 587490763 | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
List Ad Accounts
Get the ad accounts for the current user. | key: listAddAccounts
Input | Default | Notes | Example |
---|---|---|---|
After string after | Provide the token for the item after the current one. | xOTQ1MjAwNzI5NDE= | |
Before string before | Provide the token for the item before the current one. | xOTQ1MjAwNzI5NDE= | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | false | If true, it will fetch all records and ignore parameters like limit, after, and before. | |
Fields string fields | name,age,balance,is_personal,account_status,line_numbers,adcreatives | Provide a comma separated list of fields to be returned. | |
Limit string limit | Provide a limit for the result set. | 30 | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
{
"data": {
"data": [
{
"name": "Example Account",
"age": 0,
"balance": "0",
"is_personal": 0,
"account_status": 2,
"id": "act_123456789012345"
}
],
"paging": {
"cursors": {
"before": "ABCDEFG1234567890XYZ",
"after": "ABCDEFG1234567890XYZ"
}
}
}
}
List Ad Creatives
List all ad creatives in a given ad account. | key: listAdCreatives
Input | Default | Notes | Example |
---|---|---|---|
Ad Account string / Required adAccountId | Provide the identifier of an Ad Account. This value should be an Id. | act_342512647855388 | |
After string after | Provide the token for the item after the current one. | xOTQ1MjAwNzI5NDE= | |
Before string before | Provide the token for the item before the current one. | xOTQ1MjAwNzI5NDE= | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | false | If true, it will fetch all records and ignore parameters like limit, after, and before. | |
Fields string fields | name, object_story_spec, adlabels, body, object_id, url_tags | Provide a comma separated list of fields to be returned. | |
Limit string limit | Provide a limit for the result set. | 30 | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
List Ad Leads
List all ad leads for the given ad. | key: listAdLeads
Input | Default | Notes | Example |
---|---|---|---|
Ad Id string / Required adId | The ID of the ad to list leads for. | 342512647855388 | |
After string after | Provide the token for the item after the current one. | xOTQ1MjAwNzI5NDE= | |
Before string before | Provide the token for the item before the current one. | xOTQ1MjAwNzI5NDE= | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | name | Provide a comma separated list of fields to be returned. | |
Limit string limit | Provide a limit for the result set. | 30 | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
List Ad Previews
Get a list of all previews of the given ad. | key: getAdPreview
Input | Default | Notes | Example |
---|---|---|---|
Ad Format string / Required adFormat | Provide a type of ad format to preview. | ||
Ad Id string / Required adId | The ID of the ad to list previews for. | 342512647855388 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
List Ad Sets In Account
List all ad sets in an ad account. | key: listAdSetsInAccount
Input | Default | Notes | Example |
---|---|---|---|
Ad Account string / Required adAccountId | Provide the identifier of an Ad Account. This value should be an Id. | act_342512647855388 | |
After string after | Provide the token for the item after the current one. | xOTQ1MjAwNzI5NDE= | |
Before string before | Provide the token for the item before the current one. | xOTQ1MjAwNzI5NDE= | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | false | If true, it will fetch all records and ignore parameters like limit, after, and before. | |
Fields string fields | name,account_id,adlabels,adset_schedule,asset_feed_id,attribution_spec,bid_adjustments,bid_amount,bid_constraints,bid_info,billing_event,budget_remaining,campaign,configured_status,created_time,creative_sequence,daily_budget,daily_min_spend_target,daily_spend_cap,destination_type,effective_status,end_time,optimization_goal,optimization_sub_event,pacing_type,promoted_object,recommendations,status,targeting,start_time,targeting_optimization_types,updated_time | Provide a comma separated list of fields to be returned. | |
Limit string limit | Provide a limit for the result set. | 30 | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
List Ads In Account
List all ads in an ad account. | key: listAdsInAccount
Input | Default | Notes | Example |
---|---|---|---|
Ad Account string / Required adAccountId | Provide the identifier of an Ad Account. This value should be an Id. | act_342512647855388 | |
After string after | Provide the token for the item after the current one. | xOTQ1MjAwNzI5NDE= | |
Before string before | Provide the token for the item before the current one. | xOTQ1MjAwNzI5NDE= | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | false | If true, it will fetch all records and ignore parameters like limit, after, and before. | |
Fields string fields | name,adset,account_id,ad_review_feedback,adlabels,adset_id,bid_amount,campaign,campaign_id,configured_status,conversion_domain,created_time,creative,effective_status,issues_info,last_updated_by_app_id,preview_shareable_link,recommendations,status,tracking_specs | Provide a comma separated list of fields to be returned. | |
Limit string limit | Provide a limit for the result set. | 30 | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
List Ads In Adset
List all ads in a given adset. | key: listAdsInAdset
Input | Default | Notes | Example |
---|---|---|---|
Ad Set Id string / Required adId | The ID of the adset to list ads for. | 342512647855388 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | name,adset,account_id,ad_review_feedback,adlabels,adset_id,bid_amount,campaign,campaign_id,configured_status,conversion_domain,created_time,creative,effective_status,issues_info,last_updated_by_app_id,preview_shareable_link,recommendations,status,tracking_specs | Provide a comma separated list of fields to be returned. | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
List Campaigns In Account
List all campaigns in an ad account. | key: listCampaignsInAccount
Input | Default | Notes | Example |
---|---|---|---|
Ad Account string / Required adAccountId | Provide the identifier of an Ad Account. This value should be an Id. | act_342512647855388 | |
After string after | Provide the token for the item after the current one. | xOTQ1MjAwNzI5NDE= | |
Before string before | Provide the token for the item before the current one. | xOTQ1MjAwNzI5NDE= | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Limit string limit | Provide a limit for the result set. | 30 | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Raw Request
Send raw HTTP request to Meta Ads. | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. Specify 0 for no retries. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | Input the path only (/me/adaccounts), The base URL is already included (https://graph.facebook.com/v<INPUT_VERSION>.0). For example, to connect to https://graph.facebook.com/v<INPUT_VERSION>.0/me/adaccounts, only /me/adaccounts is entered in this field. | /me/adaccounts | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Update Ad
Update the information and metadata of a given ad or adset. | key: updateAd
Input | Default | Notes | Example |
---|---|---|---|
Ad Id string / Required adId | Provide the Id of an Ad or Ad Set. | 342512647855388 | |
Ad Name string adName | Provide a name for the given ad. | My New Ad | |
Connection connection / Required connection | |||
Creative Id string creativeId | Provide the Id of the desired creative. | 58789326952 | |
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | name,adset,account_id,ad_review_feedback,adlabels,adset_id,bid_amount,campaign,campaign_id,configured_status,conversion_domain,created_time,creative,effective_status,issues_info,last_updated_by_app_id,preview_shareable_link,recommendations,status,tracking_specs | Provide a comma separated list of fields to be returned. | |
Optional Values string Key Value List optionalValues | Provide optional values to mutate the given object. | ||
Ad Status string status | Provide a status for the ad. During testing, it is recommended to set ads to a PAUSED status so as to not incur accidental spend. | ||
Tracking code tracking | Provide a JSON array containing valid tracking specs. The shape of this field can change depending on the type of ad: https://developers.facebook.com/docs/marketing-api/tracking-specs#default_by_ad. | ||
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Update Ad Creative
Update the information and metadata of the given ad creative. | key: updateAdCreative
Input | Default | Notes | Example |
---|---|---|---|
Ad Creative Id string / Required adCreativeId | The ID of the ad creative to update. | 342512647855388 | |
After string after | Provide the token for the item after the current one. | xOTQ1MjAwNzI5NDE= | |
Before string before | Provide the token for the item before the current one. | xOTQ1MjAwNzI5NDE= | |
Body string body | Provide a body for the adCreative. | This is an example description body. | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | name, object_story_spec, adlabels, body, object_id, url_tags | Provide a comma separated list of fields to be returned. | |
Limit string limit | Provide a limit for the result set. | 30 | |
Name string name | Provide a name for the adCreative. | My Ad Creative | |
Object Story Id string objectStoryId | Provide an Id for the object story of the adCreative. | 1051738543535_10636436633230 | |
Optional Values string Key Value List optionalValues | Provide optional values to mutate the given object. | ||
URL Tags string urlTags | Provide an string for the URL tags on the given adCreative. | key1=val1&key2=val2 | |
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |
Update Ad Set
Update the information and metadata of a given Ad Set. | key: updateAdSet
Input | Default | Notes | Example |
---|---|---|---|
Ad Set Id string / Required adId | The ID of the Ad Set to update. | 342512647855388 | |
Ad Set Name string adName | Provide a name for the Ad Set. | My New Ad | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | name,account_id,adlabels,adset_schedule,asset_feed_id,attribution_spec,bid_adjustments,bid_amount,bid_constraints,bid_info,billing_event,budget_remaining,campaign,configured_status,created_time,creative_sequence,daily_budget,daily_min_spend_target,daily_spend_cap,destination_type,effective_status,end_time,optimization_goal,optimization_sub_event,pacing_type,promoted_object,recommendations,status,targeting,start_time,targeting_optimization_types,updated_time | Provide a comma separated list of fields to be returned. | |
Optional Values string Key Value List optionalValues | Provide optional values to mutate the given object. | ||
Ad Set Status string status | Provide a status for the Ad Set. During testing, it is recommended to set ad sets to a PAUSED status so as to not incur accidental spend. | ||
Targeting code targeting | The targeting specs for the ad set. | ||
Graph Version string version | 22 | Provide the version of the Graph API to use. Defaults to 22. | 22 |