Facebook Custom Audiences (Actions) documentation #6913

forstisabella · 2024-08-07T00:56:10Z

Proposed changes

Add documentation for FCAA destination

Merge timing

8/9

Related issues (optional)

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

netlify · 2024-08-07T01:06:11Z

✅ Deploy Preview for segment-docs ready!

Name	Link
🔨 Latest commit	`bc72c51`
🔍 Latest deploy log	https://app.netlify.com/sites/segment-docs/deploys/66b56387a61d0f000833f3e1
😎 Deploy Preview	https://deploy-preview-6913--segment-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

… here

nick-Ag · 2024-08-07T18:25:36Z

Hey @forstisabella - I've added some code to hide certain legacy actions which will soon be removed, I also removed the hidden: true from the entire destination. I don't see those changes showing up in the netlify preview however. Do you know what's going wrong there?

forstisabella · 2024-08-07T18:57:44Z

hi @nick-Ag - it looks like you used the [netlify-build] format correctly and the builds are working on the back end, however the destination info box at the top of the page and the Available Actions section only build after we pull the catalog from the public API as part of the deploy process, so we won't see those changes until we are ready to deploy the docs!

forstisabella · 2024-08-07T18:58:14Z

I do have to add this destination to the Facebook strat nav, which may be some of what you're seeing! brb

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

mgutten · 2024-08-07T18:53:21Z

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

+## Getting started
+
+### Prerequisites
+- A Reverse ETL source already set up. If you don't yet have a Reverse ETL source, follow the instructions in Segment's [Reverse ETL documentation](/docs/connections/reverse-etl/#getting-started). Segment recommends setting your External ID as your primary key for your Reverse ETL model, as you'll need an External ID to remove users from your custom audiences. 


Can we link: "...Segment recommends setting your External ID"

^ the External ID reference to the Available Actions section below? I don't expect customers to know what we mean intuitively

mgutten · 2024-08-07T18:56:05Z

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

+2. On the Models page, select the model you'd like to use and click **Add Mapping**. 
+3. Select the Facebook Custom Audience (Actions) destination and the Sync Audience action, then click **Create Mapping**. 
+4. Enter a descriptive name for your mapping. Segment recommends a name that includes both the audience name and sync mode, for example, `Loyalty Users (Add)`. 
+5. Under **Select record to map and send**, select **Added or updated records**. The Added or updated records sync mode both adds new records and attempts to re-add any updated records to the custom audience. Adding updated records to your destination enables better match rates, as more user identifiers are added to the source model over time.


"...better match rates, as more user identifiers..."
remove the comma here

mgutten · 2024-08-07T18:58:00Z

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

+  Select or create an audience in Facebook to sync your data with. Click the **Select or create audience in Facebook** button to save the audience ID to your mapping. 
+  </li>
+  <li value="8" markdown=1>
+  Map your model columns to the appropriate Facebook Custom Audience parameters. For more context about data formatting, see the [Sync audience](#sync-audience) and [Data processing](#data-processing) documentation. 


"...Sync audience..."

^ uppercase Audience for consistency

mgutten · 2024-08-07T19:00:03Z

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

+  <li value="8" markdown=1>
+  Map your model columns to the appropriate Facebook Custom Audience parameters. For more context about data formatting, see the [Sync audience](#sync-audience) and [Data processing](#data-processing) documentation. 
+  <ul> 
+    <li> Map External ID to a unique user identifier from your system (like User ID, CRM ID, or anonymous ID.) Segment recommends using the External ID column as your primary key when setting up your Reverse ETL model so you can more easily remove users from your custom audience. External ID is the only field Segment requires you to map. </li> 


"...only field Segment requires you to map..." -> "...only field Facebook requires."

mgutten · 2024-08-07T19:08:11Z

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

+5. Under **Select record to map and send**, select **Deleted records**. The Deleted records sync mode removes any records from your custom audience that you deleted from your source model.
+6. Set how often your model syncs by setting the [Sync schedule](/docs/connections/reverse-etl/#step-4-create-mappings). 
+7. Select or create an audience in Facebook to sync your data with. Click the **Select or create audience in Facebook** button to save the audience ID to your mapping.
+8. Map your model columns to the appropriate Facebook Custom Audience parameters. For more context about data formatting, see the [Sync audience](#sync-audience) and [Data processing](#data-processing) documentation. Map your External ID to a unique user identifier from your system (like User ID, CRM ID, or anonymous ID.) Segment recommends using the External ID column as your primary key when setting up your Reverse ETL model so you can more easily remove users from your custom audience. External ID is the only field Segment requires you to map.


"For more context about data formatting, see the Sync audience and Data processing documentation. Map your External ID to a unique user identifier from your system (like User ID, CRM ID, or anonymous ID.) Segment recommends using the External ID column as your primary key when setting up your Reverse ETL model so you can more easily remove users from your custom audience. External ID is the only field Segment requires you to map."

should be:

"Only the External ID is required. When a record is deleted from your source model, only the model primary key is sent to the mapping; other columns from your source model are not sent. We highly recommend using the External ID as your primary key in your source model."

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

…udiences/index.md

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

forstisabella · 2024-08-09T00:31:14Z

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

+- A Facebook Custom Audiences account with the following permissions: 
+  - 


Suggested change

- A Facebook Custom Audiences account with the following permissions:

-

- A Facebook account with [ads_management](https://developers.facebook.com/docs/permissions#ads_management){:target="_blank”} permissions for the target Facebook Ads Account(s).

Co-authored-by: pwseg <[email protected]>

src/_data/sidenav/strat.yml

forstisabella · 2024-08-09T00:42:25Z

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

+## Getting started
+
+### Prerequisites
+- A Reverse ETL source already set up. If you don't yet have a Reverse ETL source, follow the instructions in Segment's [Reverse ETL documentation](/docs/connections/reverse-etl/#getting-started). Segment recommends setting your External ID as your primary key for your Reverse ETL model, as you'll need an External ID to remove users from your custom audiences. 


Suggested change

- A Reverse ETL source already set up. If you don't yet have a Reverse ETL source, follow the instructions in Segment's [Reverse ETL documentation](/docs/connections/reverse-etl/#getting-started). Segment recommends setting your External ID as your primary key for your Reverse ETL model, as you'll need an External ID to remove users from your custom audiences.

- A Reverse ETL source already set up. If you don't yet have a Reverse ETL source, follow the instructions in Segment's [Reverse ETL documentation](/docs/connections/reverse-etl/#getting-started). Segment recommends setting your [External ID](#available-actions) as your primary key for your Reverse ETL model, as you'll need an External ID to remove users from your custom audiences.

pwseg · 2024-08-09T16:34:20Z

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md

+  </ul>
+  </li>
+  <li value ="9" markdown=1>
+  Send a test record. If successful, you should see a 200 response in Segment and one added record to your custom audience. To verify that the record was successfully added to your custom audience, open Facebook Ads Manager and navigate to **Audiences > {Audience Name} > History**.


Suggested change

Send a test record. If successful, you should see a 200 response in Segment and one added record to your custom audience. To verify that the record was successfully added to your custom audience, open Facebook Ads Manager and navigate to **Audiences > {Audience Name} > History**.

Send a test record. If successful, you should see a `200` response in Segment and one added record to your custom audience. To verify that the record was successfully added to your custom audience, open Facebook Ads Manager and navigate to **Audiences > {Audience Name} > History**.

add fcaa doc

6fa6def

forstisabella added the new-integration Added a new source or destination label Aug 7, 2024

forstisabella requested review from marinhero and mgutten August 7, 2024 00:56

forstisabella requested a review from a team as a code owner August 7, 2024 00:56

forstisabella requested a review from pwseg August 7, 2024 00:56

forstisabella commented Aug 7, 2024

View reviewed changes

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md Outdated Show resolved Hide resolved

[netlify-build]

83a0763

fix html table [netlify-build]

c5f2e36

forstisabella requested review from nick-Ag and removed request for marinhero August 7, 2024 15:06

forstisabella commented Aug 7, 2024

View reviewed changes

src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md Outdated Show resolved Hide resolved

nick-Ag added 5 commits August 7, 2024 09:56

Hides legacy unused actions and removes hiding of entire destination

fc77213

[netlify-build]

a5f19ee

WIP - unhiding destination failed in netlify preview, working on that…

4d85a24

… here

[netlify-build]

f5cee61

[netlify-build] Hides legacy syncRetl action

d40f27f

[netlify-build]

5b9971f

mgutten reviewed Aug 7, 2024

View reviewed changes