Kadam icon

Kadam

Interact with Kadam API (v1.4.x) for managing campaigns, clients, creatives, and more.

Campaign → Get Ad Formats

AI-generated

Overview

This node integrates with the Kadam API to manage advertising campaigns and related entities. Specifically, for the Campaign resource and the Get Ad Formats operation, it retrieves a list of available ad formats that can be used when creating or managing campaigns.

This operation is useful when you want to dynamically fetch the types of ad formats supported by the Kadam platform, ensuring your campaigns use valid and up-to-date formats. For example, before creating a new campaign, you might want to present users with the current ad format options to select from.

Properties

Name Meaning
Retry on Failure Boolean flag to retry the request up to 3 times on temporary failures such as rate limits or network issues.

Output

The output JSON contains an array of ad format objects retrieved from the Kadam API. Each object typically includes fields like:

  • id: The unique identifier of the ad format.
  • title: The name/title of the ad format.

Example output structure (simplified):

[
  {
    "id": 10,
    "title": "Teaser"
  },
  {
    "id": 20,
    "title": "Banner"
  }
]

This data allows downstream nodes or workflows to utilize the ad format IDs and titles for further operations like campaign creation.

The node does not output binary data for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Kadam API.
  • Network access to https://api.kadam.net to perform REST API calls.
  • Uses the Axios HTTP client internally for requests.
  • No additional environment variables are required beyond the configured credentials.

Troubleshooting

  • Common Issues:

    • Authentication errors: If the API token or app ID is invalid or expired, the node will fail to retrieve ad formats.
    • Network issues: Temporary network failures or rate limiting may cause request failures.
    • Unexpected response structure: If the Kadam API changes its response format, the node may throw errors or return empty results.
  • Error Messages:

    • "Unsupported resource": Occurs if the resource parameter is set incorrectly.
    • "Invalid response structure for campaign categories": While not directly related to ad formats, similar errors could appear if the API response is malformed.
    • API error messages returned from Kadam are wrapped and include status codes and error descriptions when available.
  • Resolutions:

    • Verify API credentials are correct and have necessary permissions.
    • Enable "Retry on Failure" property to handle transient errors automatically.
    • Check network connectivity and firewall settings.
    • Review Kadam API documentation for any breaking changes.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion