Facebook Ads module reference

Applies to

Bridge by Smartsheet

Triggers

Use it with other Bridge integrations that include triggers, such as Smartsheet.

Get Campaign

Use this module to get a campaign associated with a specific account by providing the campaign ID.

Get Campaign fields

You can use data references in all these fields:

  • Name: In this field, enter the name assigned to the Get module. 
  • Campaign ID: Input the ID of a campaign. You can get this from the output of the List Campaigns module. 

What you’ll see in the Run Log pane

Once Bridge executes the Get Campaign module, the following information will be available in the Run Log pane: 

  • Data
    • budget_remaining: Budget displayed in thousands (for example, $10.00 will appear as 1000)
    • created_time: ISO local date time
    • id: Campaign ID
    • name: User-assigned name
    • source_campaign_id: Provides the origin/source campaign’s unique ID if the campaign is copied from another
    • spend_cap: Amount spent displayed in thousands (for example, $10.00 will appear as 1000)
    • start_time: ISO local date time
    • Status: Shows any of these status labels: 
      • ACTIVE 
      • PAUSED 
      • DELETED 
      • ARCHIVED
    • stop_time: ISO local date time
  • State: Section that indicates whether or not the module worked
    • Code: The success/error code that the module pulls from Smartsheet
    • Message: A system-generated message that the module pulls from Smartsheet 
      • For example, if the module can’t find a value, the message that will appear is “Not found.”
    • Status: The status that the module pulls from Smartsheet
      • These are examples of status labels you might encounter:
        • Succeeded: The module successfully found the information.
        • Failed: The module didn’t find the information.

Get Performance Data

Use this module to get the insights and metrics of a campaign.

Get Performance Data fields

You can use data references in all these fields.

  • Name: In this field, enter the assigned name for the Get module.
  • Campaign ID: Input the ID of a campaign. You can get this from the output of the List Campaigns module. 
  • Time Period: Select from a predefined list of options such as Today, Last week, This week, Last Month, This Month, etc.

What you’ll see in the Run Log pane

Once Bridge executes the Get Performance Data module, the following information will be available in the Run Log pane:

  • Data
    • account_currency: USD
    • buying_type
      • The method by which you pay for and target ads in your campaigns: 
        • Dynamic auction bidding 
        • Fixed-price bidding 
        • Reach and frequency buying 
      • This field is currently only visible at the campaign level.
    • clicks: The number of clicks on your ads
    • cpc: Shows the average cost for each click (all) in decimal values
    • ctr: Shows how many times people saw your ad and performed a click (all) in decimal values
    • date_start: Shows the date when the campaign started or will start in YYYY-MM-DD format
    • date_stop: Shows when the campaign ended or will end in YYYY-MM-DD format
    • frequency: Shows an estimated average number of times each person saw your ad
    • impressions: The number of times your ads were on screen
    • Outbound_clicks: The number of clicks on links that take people off Facebook-owned properties
    • Action_type
      • The kind of actions users took on your ad, page, app, or event after your ad was served to someone, even if they didn't select it: 
        • Page likes 
        • App installs 
        • Conversions 
        • Event responses, and more
    • value: 23
    • reach: Number of users the advertisement reached
    • spend: Shows the total values spent on campaign clicks in decimal values
  • State: Section that indicates whether or not the module worked
    • Code: This is the success/error code that the module pulls from Smartsheet
    • Message: A system-generated message that the module pulls from Smartsheet 
      • For example, if the module can’t find a value, the message that will appear is “Not found.”
    • Status: This is the status that the module pulls from Smartsheet
      • These are examples of status labels you might encounter:
        • Succeeded: The module successfully found the information
        • Failed: The module didn’t find the information 

List Campaigns

Use this module to list all campaigns associated with a specific account.

Before you build workflows

Secure the Facebook Ads Manager Account ID for listing campaigns associated with it. 

Don’t know where to get your ad account ID? Check out Facebook’s article about finding your ad account ID.

List Campaign field

You can use data references in this field:

  • Account ID: In this field, enter the 15-digit unique number assigned to your Facebook Ad Marketing Account.

What you’ll see in the Run Log pane

Once Bridge executes the List Campaign module, the following information will be available in the Run Log pane:

  • Data: Each campaign will be nested inside the object in the array. To find the required data, expand each array.
    • Id: Unique ID assigned to each campaign
    • Name: Campaign name assigned by a user
  • State: Section that indicates whether or not the module worked
    • Code: The success/error code that the module pulls from Smartsheet
    • Message: A system-generated message that the module pulls from Smartsheet 
      • For example, if the module can’t find a value, the message that will appear is “Not found.”
    • Status: The status that the module pulls from Smartsheet
      • These are examples of status labels you might encounter:
        • Succeeded: The module successfully found the information.
        • Failed: The module didn’t find the information.

Update Campaign

Use this module to update the status of a campaign.

Update Campaign fields

You can use data references in all these fields:

  • Campaign ID: In this field, enter the unique ID assigned to each campaign.
  • Status: Select from the list of options to update the campaign status. The information you need to add here can be extracted from the output of the List Campaigns module. You can also use the data reference for the required campaign.

What you’ll see in the Run Log pane

Once Bridge executes the Update Campaign module, the following information will be available in the Run Log pane:

  • Data
    • Success: Shows either True or False
  • State: Section that indicates whether or not the module worked
    • Code: The success/error code that the module pulls from Smartsheet
    • Message: A system-generated message that the module pulls from Smartsheet 
      • For example, if the module can’t find a value, the message that will appear is “Not found.”
    • Status: The status that the module pulls from Smartsheet
      • These are examples of status labels you might encounter:
        • Succeeded: The module successfully found the information.
        • Failed: The module didn’t find the information.