WbPromotion icon

WbPromotion

n8n node to interact with WB API

Actions28

Overview

This node operation retrieves advertising media campaigns ("Adv Adverts") from a media service. It allows users to filter and paginate through media campaigns based on their status, type, and sorting preferences. This is useful for marketers or advertisers who want to programmatically access details about their media campaigns, monitor their statuses, and manage them efficiently.

Practical examples include:

  • Fetching all approved media campaigns currently running.
  • Retrieving drafts or campaigns under moderation for review.
  • Paginating through large sets of campaigns sorted by creation date or ID.

Properties

Name Meaning
Status Status of the media campaign:
1 - Draft
2 - Moderation
3 - Rejected (can be returned to moderation)
4 - Approved
5 - Scheduled
6 - Running
7 - Completed
8 - Declined
9 - Suspended by seller
10 - Paused due to daily limit
11 - Paused due to budget spend
Type Type of media campaign:
1 - Placement by days
2 - Placement by views
Limit Number of campaigns to return in the response
Offset Offset relative to the first media campaign (for pagination)
Order Order of the response output:
create - by creation time
id - by media campaign ID
Direction Sorting direction:
desc - descending (from larger to smaller)
asc - ascending (from smaller to larger)

Output

The node outputs JSON data containing the list of media campaigns matching the query parameters. Each item in the output represents a media campaign with its associated details as provided by the external media API.

If the media campaigns include any binary data (e.g., images or videos), it would be represented in the binary output field, but this node primarily returns structured JSON data about campaigns.

Dependencies

  • Requires an API key credential or similar authentication token to access the external media service API.
  • The node uses HTTP requests to communicate with the media API endpoint.
  • Proper configuration of the API base URL and authentication credentials within n8n is necessary.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid status or type values may result in empty responses or errors.
    • Pagination parameters (limit and offset) must be positive integers; otherwise, the API might reject the request.
  • Error messages:
    • Authentication errors typically indicate invalid or expired API keys; reconfigure credentials.
    • Validation errors on query parameters suggest checking the allowed values for status, type, order, and direction.
    • Network errors imply connectivity issues or incorrect API endpoint configuration.

Links and References

  • No direct links are available from the source code, but users should refer to the media service's official API documentation for detailed parameter descriptions and response formats.

Discussion