diff --git a/en/docs/reference/connectors/facebook-ads-connector/facebook-ads-configuration.md b/en/docs/reference/connectors/facebook-ads-connector/facebook-ads-configuration.md index 97e8b1825..feafc4664 100644 --- a/en/docs/reference/connectors/facebook-ads-connector/facebook-ads-configuration.md +++ b/en/docs/reference/connectors/facebook-ads-connector/facebook-ads-configuration.md @@ -892,34 +892,112 @@ To use the Facebook Ads connector, first create the connection with your configu Properties of the users to be added to the audience. Yes + + inputStructure + Structure of the user data to be added. + No + - **Sample configuration** + **Sample configurations for Facebook API compatible input** ```xml {json-eval($.audience_id)} {json-eval($.properties)} + + + {json-eval($.audience_id)} + {json-eval($.properties)} + FACEBOOK_API_COMPATIBLE + ``` - **Sample request** + **Sample request for Facebook API compatible input** ```json { "audience_id": "456456456", "properties": { "payload": { - "schema": "EMAIL_SHA256", + "schema": [ + "COUNTRY", + "EMAIL", + "FN", + "GEN", + "LN", + "MADID", + "PHONE" + ], "data": [ - "b36a83701f1c3191e19722d6f90274bc1b5501fe69ebf33313e440fe4b0fe210", - "2b3b2b9ce842ab8b6a6c614cb1f9604bb8a0d502d1af49c526b72b10894e95b5" + [ + "79adb2a2fce5c6ba215fe5f27f532d4e7edbac4b6a5e09e1ef3a08084a904621", + "23b9cb38c8e9c75a466a349eec16aff2c3eabc707cf57432a872aab7e532d069", + "b54f08623ae4039f55bcecba4961037fb4513d2ba9cb2b0667c5db970ac94911", + "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111", + "d07227456ed0f3a3ca01456ee769b4662c1c679d754465b44c93b075fea751cd", + "aece52e7-03ee-455a-b3c4-e57283966239", + "c7e1a5948418c64b472abbe6a7b443ec83c4e31573874d600de828f89dd71339" + ] ] } } } ``` + **Sample configurations for JSON array input** + + ```xml + + {json-eval($.audience_id)} + {json-eval($.properties)} + JSON_ARRAY + + ``` + + **Sample request for JSON array input** + + ```json + { + "audience_id": "456456456", + "properties": [ + { + "email": "elizabetho@fb.com", + "phone": "1-(650)-561-5622", + "madid": "aece52e7-03ee-455a-b3c4-e57283966239", + "fn": "Elizabeth", + "ln": "Olsen", + "zip": "94046", + "ct": "Menlo Park", + "st": "CA", + "country": "US", + "dob": "10\/21\/68", + "doby": 1968, + "gen": "F", + "age": 48, + "uid": 1234567890 + }, + { + "email": "andrewj@fb.com", + "phone": "1-(212) 736-3100", + "madid": "BEBE52E7-03EE-455A-B3C4-E57283966239", + "fn": "Andrew", + "ln": "Jamison", + "zip": "10118", + "ct": "New York", + "st": "NY", + "country": "US", + "dob": "10\/17\/78", + "doby": 1978, + "gen": "M", + "age": 38, + "uid": 1443637309 + } + ] + } + ``` + ??? note "removeUsersFromAudience" The `removeUsersFromAudience` operation removes users from a custom audience. @@ -938,34 +1016,160 @@ To use the Facebook Ads connector, first create the connection with your configu + + + + +
Properties of the users to be removed from the audience. Yes
inputStructureStructure of the user data to be removed.No
- **Sample configuration** + **Sample configurations for Facebook API compatible input** ```xml {json-eval($.audience_id)} {json-eval($.properties)} + + + {json-eval($.audience_id)} + {json-eval($.properties)} + FACEBOOK_API_COMPATIBLE + ``` - **Sample request** + **Sample request for Facebook API compatible input** ```json { "audience_id": "456456456", "properties": { "payload": { - "schema": "EMAIL_SHA256", + "schema": [ + "COUNTRY", + "EMAIL", + "FN", + "GEN", + "LN", + "MADID", + "PHONE" + ], "data": [ - "b36a83701f1c3191e19722d6f90274bc1b5501fe69ebf33313e440fe4b0fe210", - "2b3b2b9ce842ab8b6a6c614cb1f9604bb8a0d502d1af49c526b72b10894e95b5" + [ + "79adb2a2fce5c6ba215fe5f27f532d4e7edbac4b6a5e09e1ef3a08084a904621", + "23b9cb38c8e9c75a466a349eec16aff2c3eabc707cf57432a872aab7e532d069", + "b54f08623ae4039f55bcecba4961037fb4513d2ba9cb2b0667c5db970ac94911", + "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111", + "d07227456ed0f3a3ca01456ee769b4662c1c679d754465b44c93b075fea751cd", + "aece52e7-03ee-455a-b3c4-e57283966239", + "c7e1a5948418c64b472abbe6a7b443ec83c4e31573874d600de828f89dd71339" + ] ] } } } ``` + **Sample configurations for JSON array input** + + ```xml + + {json-eval($.audience_id)} + {json-eval($.properties)} + JSON_ARRAY + + ``` + + **Sample request for JSON array input** + + ```json + { + "audience_id": "456456456", + "properties": [ + { + "email": "elizabetho@fb.com", + "phone": "1-(650)-561-5622", + "madid": "aece52e7-03ee-455a-b3c4-e57283966239", + "fn": "Elizabeth", + "ln": "Olsen", + "zip": "94046", + "ct": "Menlo Park", + "st": "CA", + "country": "US", + "dob": "10\/21\/68", + "doby": 1968, + "gen": "F", + "age": 48, + "uid": 1234567890 + }, + { + "email": "andrewj@fb.com", + "phone": "1-(212) 736-3100", + "madid": "BEBE52E7-03EE-455A-B3C4-E57283966239", + "fn": "Andrew", + "ln": "Jamison", + "zip": "10118", + "ct": "New York", + "st": "NY", + "country": "US", + "dob": "10\/17\/78", + "doby": 1978, + "gen": "M", + "age": 38, + "uid": 1443637309 + } + ] + } + ``` + +??? note "getCustomAudiences" + The `getCustomAudiences` operation retrieves all custom audiences. Provide a value for the `filterByName` parameter to retrieve specific audiences by name. + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
adAccountIdID of the ad account.Yes
filterByNameProvide a name to filter and retrieve specific audiences.No
+ + **Sample configuration** + + ```xml + + {json-eval($.ad_account_id)} + {json-eval($.filter_name)} + + ``` + + **Sample request** + + Retrieve all the custom audiences. + + ```json + { + "ad_account_id": "123123123" + } + ``` + + Retrieve specific audiences by name. + + ```json + { + "ad_account_id": "123123123", + "filter_name": "Custom Audience With Users" + } + ``` + ## Error codes related to Facebook Ads Connector The connector may encounter errors during operation execution. When an error occurs, the `ERROR_MESSAGE` property will contain detailed information about the error. You can handle these errors using a `Fault Sequence` in your integration. For more information, see [Using Fault Sequences]({{base_path}}/learn/examples/sequence-examples/using-fault-sequences/). diff --git a/en/docs/reference/connectors/facebook-ads-connector/facebook-ads-overview.md b/en/docs/reference/connectors/facebook-ads-connector/facebook-ads-overview.md index 91086a007..48ae22f83 100644 --- a/en/docs/reference/connectors/facebook-ads-connector/facebook-ads-overview.md +++ b/en/docs/reference/connectors/facebook-ads-connector/facebook-ads-overview.md @@ -12,7 +12,7 @@ Go to the