Class default

Constructors

constructor

Methods

createAd createCampaign createGroup createTrigger deleteAd deleteCampaign deleteGroup deleteTrigger listAds listCampaignAdAccounts listCampaignBusinesses listCampaignFundingInstruments listCampaigns listGroups listRedditCarriers listRedditCommunities listRedditDevices listRedditGeolocations listRedditInterests listRedditThirdPartyAudiences listTriggers searchRedditCommunities updateAd updateCampaign updateGroup updateTrigger viewAd viewCampaign viewGroup viewTrigger

Constructors

constructor

Methods

Static createAd

  • createAd<T>(data?, params?): AxiosPromise<default<T>>

  • Create a new Ad (creative).

    Type Parameters

    • T

    Parameters

    • Optional data: object

      The Ad creation payload

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The newly created Ad resource

Static createCampaign

  • createCampaign<T>(data?, params?): AxiosPromise<default<T>>

  • Create a new Ad Campaign.

    Type Parameters

    • T

    Parameters

    • Optional data: object

      The Ad Campaign payload (JSON) to create

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The newly created AdCampaign resource

Static createGroup

  • createGroup<T>(campaign_id, data?, params?): AxiosPromise<default<T>>

  • Create a new Ad Group (ad set) under a specific campaign.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the parent Ad Campaign

    • Optional data: object

      The AdGroup creation payload

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The newly created AdGroup resource

Static createTrigger

  • createTrigger<T>(campaign_id, group_id, data?, params?): AxiosPromise<default<T>>

  • Create a new Ad Group Trigger.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the parent Ad Campaign

    • group_id: string

      The UUID of the Ad Group

    • Optional data: object

      The trigger creation payload

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The newly created AdGroupTrigger resource

Static deleteAd

  • deleteAd<T>(ad_id, params?): AxiosPromise<default<T>>

  • Delete an Ad by ID.

    Type Parameters

    • T

    Parameters

    • ad_id: string

      The UUID of the Ad to delete

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    A 204 No Content response on success

Static deleteCampaign

  • deleteCampaign<T>(campaign_id, params?): AxiosPromise<default<T>>

  • Delete an Ad Campaign by ID.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the campaign to delete

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    A 204 No Content response on success

Static deleteGroup

  • deleteGroup<T>(campaign_id, group_id, params?): AxiosPromise<default<T>>

  • Delete an Ad Group (ad set) by ID, under a specific campaign.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the parent Ad Campaign

    • group_id: string

      The UUID of the AdGroup to delete

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    A 204 No Content response on success

Static deleteTrigger

  • deleteTrigger<T>(campaign_id, group_id, trigger_id, params?): AxiosPromise<default<T>>

  • Delete an Ad Group Trigger by ID.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the parent Ad Campaign

    • group_id: string

      The UUID of the Ad Group

    • trigger_id: string

      The UUID of the trigger

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    A 204 No Content response on success

Static listAds

  • listAds<T>(params?): AxiosPromise<default<T>>

  • List Ads (creatives).

    Supports filtering by ad_group_id, social_media_post_id, operation_status, etc.

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

      Optional query parameters for filtering/sorting

    Returns AxiosPromise<default<T>>

    A paginated list of Ad resources

Static listCampaignAdAccounts

  • listCampaignAdAccounts<T>(campaign_id, params?): AxiosPromise<default<T>>

  • List Ad Accounts for the given campaign ID, as defined by /ads/campaigns/{id}/ad_accounts on the backend.

    E.g. for Reddit, you can pass ?business_id= to get business-level ad accounts, or for Twitter, it might just return a user’s ad accounts, etc.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the Ad Campaign

    • Optional params: Record<string, any>

      Optional query parameters, e.g. business_id, page.size, etc.

    Returns AxiosPromise<default<T>>

    A response object with data (ad account list)

Static listCampaignBusinesses

  • listCampaignBusinesses<T>(campaign_id, params?): AxiosPromise<default<T>>

  • List platform-level businesses for the given campaign ID, as defined by /ads/campaigns/{id}/businesses on the backend.

    Typically relevant for Reddit (list businesses), or might return a "not supported" message for Meta/TikTok.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the Ad Campaign

    • Optional params: Record<string, any>

      Optional query parameters, e.g. page.size, etc.

    Returns AxiosPromise<default<T>>

    A response object with data (business list or messages)

Static listCampaignFundingInstruments

  • listCampaignFundingInstruments<T>(campaign_id, params?): AxiosPromise<default<T>>

  • List funding instruments for the given campaign ID, as defined by /ads/campaigns/{id}/funding_instruments on the backend.

    For Twitter, pass ?account_id=... For Reddit, pass ?ad_account_id=... or ?business_id=...

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the Ad Campaign

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    A response object with data (funding instruments)

Static listCampaigns

  • listCampaigns<T>(params?): AxiosPromise<default<T>>

  • List Ad Campaigns.

    Example usage: Ads.listCampaigns({ community: 'uuid-of-community', platform: 'tiktok' })

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

      Query parameters (e.g. community, platform, advertiser_id, etc.)

    Returns AxiosPromise<default<T>>

    A paginated list of AdCampaign resources

Static listGroups

  • listGroups<T>(campaign_id, params?): AxiosPromise<default<T>>

  • List Ad Groups (ad sets) for a specific campaign.

    Example usage: Ads.listGroups('some-campaign-uuid', { promotion_type: 'WEBSITE' })

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the parent Ad Campaign

    • Optional params: Record<string, any>

      Optional query parameters (e.g. promotion_type, operation_status, etc.)

    Returns AxiosPromise<default<T>>

    A paginated list of AdGroup resources

Static listRedditCarriers

  • listRedditCarriers<T>(params?): AxiosPromise<default<T>>

  • GET /ads/reddit/targeting/carriers

    Example usage: Ads.listRedditCarriers({ scheduler_id: 'uuid-of-scheduler', 'page.size': 50 })

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static listRedditCommunities

  • listRedditCommunities<T>(params?): AxiosPromise<default<T>>

  • GET /ads/reddit/targeting/communities?names=sub1,sub2

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static listRedditDevices

  • listRedditDevices<T>(params?): AxiosPromise<default<T>>

  • GET /ads/reddit/targeting/devices

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static listRedditGeolocations

  • listRedditGeolocations<T>(params?): AxiosPromise<default<T>>

  • GET /ads/reddit/targeting/geolocations

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static listRedditInterests

  • listRedditInterests<T>(params?): AxiosPromise<default<T>>

  • GET /ads/reddit/targeting/interests

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static listRedditThirdPartyAudiences

  • listRedditThirdPartyAudiences<T>(params?): AxiosPromise<default<T>>

  • GET /ads/reddit/targeting/third_party_audiences

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static listTriggers

  • listTriggers<T>(campaign_id, group_id, params?): AxiosPromise<default<T>>

  • List triggers defined for a given Ad Group.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the parent Ad Campaign

    • group_id: string

      The UUID of the Ad Group

    • Optional params: Record<string, any>

      Optional query parameters (pagination, etc.)

    Returns AxiosPromise<default<T>>

    A paginated list of AdGroupTrigger resources

Static searchRedditCommunities

  • searchRedditCommunities<T>(params?): AxiosPromise<default<T>>

  • GET /ads/reddit/targeting/communities/search?query=xyz

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static updateAd

  • updateAd<T>(ad_id, data?, params?): AxiosPromise<default<T>>

  • Update an existing Ad by ID.

    Type Parameters

    • T

    Parameters

    • ad_id: string

      The UUID of the Ad to update

    • Optional data: object

      The partial or full Ad payload

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The updated Ad resource

Static updateCampaign

  • updateCampaign<T>(campaign_id, data?, params?): AxiosPromise<default<T>>

  • Update an existing Ad Campaign by ID.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the campaign to update

    • Optional data: object

      The partial or full updated AdCampaign payload

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The updated AdCampaign resource

Static updateGroup

  • updateGroup<T>(campaign_id, group_id, data?, params?): AxiosPromise<default<T>>

  • Update an Ad Group (ad set) by ID.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the parent Ad Campaign

    • group_id: string

      The UUID of the AdGroup to update

    • Optional data: object

      Updated fields for the AdGroup

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The updated AdGroup resource

Static updateTrigger

  • updateTrigger<T>(campaign_id, group_id, trigger_id, data?, params?): AxiosPromise<default<T>>

  • Update an existing Ad Group Trigger by ID.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the parent Ad Campaign

    • group_id: string

      The UUID of the Ad Group

    • trigger_id: string

      The UUID of the trigger to update

    • Optional data: object

      Updated trigger fields

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The updated AdGroupTrigger resource

Static viewAd

  • viewAd<T>(ad_id, params?): AxiosPromise<default<T>>

  • Retrieve a single Ad by ID.

    Type Parameters

    • T

    Parameters

    • ad_id: string

      The UUID of the Ad to fetch

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The requested Ad resource

Static viewCampaign

  • viewCampaign<T>(campaign_id, params?): AxiosPromise<default<T>>

  • Retrieve a single Ad Campaign by ID.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the campaign to fetch

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The requested AdCampaign resource

Static viewGroup

  • viewGroup<T>(campaign_id, group_id, params?): AxiosPromise<default<T>>

  • Retrieve a single Ad Group by ID, under a specific campaign.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the parent Ad Campaign

    • group_id: string

      The UUID of the AdGroup to fetch

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The requested AdGroup resource

Static viewTrigger

  • viewTrigger<T>(campaign_id, group_id, trigger_id, params?): AxiosPromise<default<T>>

  • Retrieve a single Ad Group Trigger by ID.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

      The UUID of the parent Ad Campaign

    • group_id: string

      The UUID of the Ad Group

    • trigger_id: string

      The UUID of the trigger

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    The requested AdGroupTrigger resource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc