Actions13
Overview
This node integrates with the Foreplay API to retrieve advertising data, specifically supporting an operation to get ads by a Spyder Brand ID. It allows users to query ads based on various filters such as date range, live status, display format, publisher platform, niches, market target, languages, pagination cursor, result limit, and ordering.
Typical use cases include:
- Marketing analysts fetching ad campaigns related to a specific brand for competitive analysis.
- Social media managers monitoring active or historical ads from certain brands.
- Data scientists collecting ad metadata for trend analysis or machine learning models.
For example, a user can fetch all live ads from a particular Spyder Brand ID within a specified date range, filtered to only show video ads published on Facebook and Instagram.
Properties
| Name | Meaning |
|---|---|
| Start Date | The start date (inclusive) to filter ads. Accepts formats like YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DD HH:MM:SS. |
| End Date | The end date (inclusive) to filter ads. Same accepted formats as Start Date. |
| Live Status | Filter ads by their live status. Options: All, Live (Active), Not Live. |
| Display Format | Filter ads by one or more display formats. Options include Carousel, DCO, DPA, Event, Image, Multi Images, Multi Medias, Multi Videos, Page Like, Text, Video. |
| Publisher Platform | Filter ads by one or more publisher platforms. Options include Audience Network, Facebook, Instagram, LinkedIn, Messenger, Threads, TikTok, YouTube. |
| Niches | Filter ads by one or more niches/categories. Options include Accessories, App/Software, Beauty, Business/Professional, Education, Entertainment, Fashion, Food/Drink, Health/Wellness, Home/Garden, Jewelry/Watches, Other, Parenting, Pets, Real Estate, Service Business. |
| Market Target | Filter ads by market target. Options: B2B, B2C. |
| Languages | Filter ads by languages. Options include Dutch/Flemish, English, French, German, Italian, Japanese, Latvian, Lithuanian, Polish, Portuguese, Romanian/Moldavian/Moldovan, Serbian, Slovene, Spanish/Castilian, Swedish. |
| Cursor | A string cursor used for pagination to fetch subsequent pages of results. |
| Limit | Maximum number of results to return. Minimum value is 1. Default is 5. |
| Order | Order in which results are returned. Options: Newest, Oldest, Longest Running, Most Relevant. |
Output
The node outputs an array of JSON objects under the json field. Each object corresponds to a response from the Foreplay API containing ad data matching the query parameters. The structure of each response depends on the Foreplay API's schema for ads but generally includes details about the ads retrieved.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the Foreplay API.
- The base URL for the API must be configured in the node credentials.
- Uses HTTP requests with authentication handled internally by n8n helpers.
Troubleshooting
- Invalid operation error: Occurs if the specified operation does not match any known endpoint. Ensure the operation name is correct and supported.
- API request failures: Could be due to invalid credentials, network issues, or incorrect parameter values. Verify API key validity, network connectivity, and parameter formats.
- Empty results: May happen if filters are too restrictive or no ads match the criteria. Try broadening filters or checking date ranges.
- Pagination issues: If using the cursor for pagination, ensure the cursor value is correctly passed from previous responses.
Links and References
- Foreplay API Documentation (hypothetical link)
- n8n HTTP Request Node documentation: https://docs.n8n.io/nodes/n8n-nodes-base.httpRequest/
- n8n Credentials setup guide: https://docs.n8n.io/credentials/overview/