# Reddit Ads

> Manage Reddit ad accounts, campaigns, ad groups, ads and lead forms, and retrieve advertising reports.

App · 23 actions. Web page: https://docs.lodol.com/docs/integrations/reddit-ads

## Actions

### Create Ad

Create an ad. For a Reddit Max campaign, create a dynamic creative ad template, as Reddit's Max campaign setup guide describes. For catalog sales ads, the click URL field explains how links are handled.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Data (`data`, object, required): Ad create payload.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {}
  }
}
```

### Create Ad Group

Create an ad group.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Data (`data`, object, required): Data.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {}
  }
}
```

### Create Campaign

Create a campaign. To create an automated Reddit Max campaign, follow Reddit's Max campaign setup guide.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Data (`data`, object, required): Data.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {
      "ad_account_id": "example",
      "app_id": "example",
      "bid_strategy": "BIDLESS",
      "bid_type": "CPC",
      "bid_value": 1,
      "configured_status": "ACTIVE",
      "conversion_pixel_id": "example",
      "created_at": "example",
      "delivery_status": [],
      "effective_status": "ACTIVE",
      "end_time": "example",
      "funding_instrument_id": "example",
      "goal_type": "LIFETIME_SPEND",
      "goal_value": 1,
      "id": "example",
      "invoice_label": "example",
      "is_campaign_budget_optimization": false,
      "is_max": false,
      "modified_at": "example",
      "name": "example",
      "objective": "APP_INSTALLS",
      "optimization_goal": "ADD_TO_CART",
      "schedule": [],
      "skadnetwork_metadata": {
        "status": "COOLDOWN"
      },
      "special_ad_categories": [],
      "spend_cap": 1,
      "start_time": "example",
      "type": "MANUAL",
      "use_catalog": false,
      "view_through_conversion_type": "SEVEN_DAY_CLICKS"
    }
  }
}
```

### Create Lead Generation Form

Create a lead generation form in an ad account, to collect responses from people who interact with a lead generation ad that uses it.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Data (`data`, object, required): Data.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {
      "ad_account_id": "example",
      "created_at": "example",
      "id": "example",
      "modified_at": "example",
      "name": "example",
      "privacy_link": "example",
      "prompt": "example",
      "questions": []
    }
  }
}
```

### Get A Report

Get a metrics report with the fields you choose, broken down by up to 3 breakdowns, or 4 when they include country and region.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Page token (`page_token`, text): Page token.
- Page size (`page_size`, number): Page size. At most 1000.
- Data (`data`, object, required): Data.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {
      "metrics": [],
      "metrics_updated_at": "example"
    },
    "pagination": {
      "next_url": "example",
      "page_index": 1,
      "previous_url": "example",
      "total_count": 1
    }
  }
}
```

### Get Ad

Get an ad.

**Inputs**

- Ad id (`ad_id`, text, required): Ad id.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {}
  }
}
```

### Get Ad Account

Get an ad account by its ID.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {
      "admin_approval": "ADMIN",
      "app_attribution_type": "ALL_CONVERSION",
      "app_click_attribution_window": "DAY",
      "app_view_attribution_window": "DAY",
      "attribution_type": "ALL_CONVERSION",
      "business_id": "example",
      "click_attribution_window": "DAY",
      "created_at": "example",
      "currency": "AED",
      "excluded_communities": [],
      "excluded_keywords": [],
      "id": "example",
      "modified_at": "example",
      "name": "example",
      "pixel_partner_preferences": [],
      "primary_contact_member_id": "example",
      "spend_cap_type": "LIFETIME",
      "suspension_reason": "ADVERTISING_POLICY",
      "time_zone_id": "Africa/Abidjan",
      "type": "MANAGED",
      "ugc_addon_default_on": false,
      "view_attribution_window": "DAY"
    }
  }
}
```

### Get Ad Group

Get an ad group.

**Inputs**

- Ad group id (`ad_group_id`, text, required): Ad group id.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {}
  }
}
```

### Get Campaign

Get a campaign.

**Inputs**

- Campaign id (`campaign_id`, text, required): Campaign id.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {
      "ad_account_id": "example",
      "app_id": "example",
      "bid_strategy": "BIDLESS",
      "bid_type": "CPC",
      "bid_value": 1,
      "configured_status": "ACTIVE",
      "conversion_pixel_id": "example",
      "created_at": "example",
      "delivery_status": [],
      "effective_status": "ACTIVE",
      "end_time": "example",
      "funding_instrument_id": "example",
      "goal_type": "LIFETIME_SPEND",
      "goal_value": 1,
      "id": "example",
      "invoice_label": "example",
      "is_campaign_budget_optimization": false,
      "is_max": false,
      "modified_at": "example",
      "name": "example",
      "objective": "APP_INSTALLS",
      "optimization_goal": "ADD_TO_CART",
      "schedule": [],
      "skadnetwork_metadata": {
        "status": "COOLDOWN"
      },
      "special_ad_categories": [],
      "spend_cap": 1,
      "start_time": "example",
      "type": "MANUAL",
      "use_catalog": false,
      "view_through_conversion_type": "SEVEN_DAY_CLICKS"
    }
  }
}
```

### Get Lead Generation Form

Get a lead generation form.

**Inputs**

- Lead gen form id (`lead_gen_form_id`, text, required): Lead gen form id.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {
      "ad_account_id": "example",
      "created_at": "example",
      "id": "example",
      "modified_at": "example",
      "name": "example",
      "privacy_link": "example",
      "prompt": "example",
      "questions": []
    }
  }
}
```

### List Ad Accounts By Business

List the ad accounts in a business.

**Inputs**

- Business (`business_id`, text, required): Business id.
- Ids (`ids`, text): Ids.
- Page size (`page_size`, number): Page size. At most 1000.
- Page token (`page_token`, text): Page token.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}
```

### List Ad Groups

List the ad groups in an ad account.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Campaign id (`campaign_id`, text): Campaign id.
- Id (`id`, list): Id.
- Page token (`page_token`, text): Page token.
- Page size (`page_size`, number): Page size. At most 1000.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}
```

### List Ads

List the ads in an ad account.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Id (`id`, list): Id.
- Ad group id (`ad_group_id`, list): Ad group id.
- Campaign id (`campaign_id`, list): Campaign id.
- Configured status (`configured_status`, list): Configured status. One or more of: `ACTIVE`, `ARCHIVED`, `DELETED`, `PAUSED`.
- Effective status (`effective_status`, list): Effective status. One or more of: `ACTIVE`, `AD_GROUP_PAUSED` (Ad group paused), `ARCHIVED`, `CAMPAIGN_PAUSED` (Campaign paused), `COMPLETED`, `DELETED`, `MISSING_PERMISSIONS` (Missing permissions), `PAUSED`, `PENDING_APPROVAL` (Pending approval), `PENDING_BILLING_INFO` (Pending billing info), and 3 more.
- Page token (`page_token`, text): Page token.
- Page size (`page_size`, number): Page size. At most 1000.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}
```

### List Campaigns

List the campaigns in an ad account.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Id (`id`, list): Id.
- Page token (`page_token`, text): Page token.
- Page size (`page_size`, number): Page size. At most 1000.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}
```

### List Funding Instruments

List the funding instruments an ad account uses.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Funding instrument ids (`funding_instrument_ids`, list): Funding instrument ids.
- Types (`types`, list): Types.
- Start time (`start_time`, date and time): Start time.
- End time (`end_time`, date and time): End time.
- Search (`search`, text): Search.
- Mode (`mode`, text): Mode. One of: `ACTIVE`, `INACTIVE`, `UPCOMING`, `SELECTABLE`, `ALL`.
- Is selectable (`is_selectable`, true/false): Is selectable.
- Page token (`page_token`, text): Page token.
- Page size (`page_size`, number): Page size. At most 1000.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}
```

### List Lead Generation Forms

List the lead generation forms in an ad account.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Page token (`page_token`, text): Page token.
- Page size (`page_size`, number): Page size. At most 1000.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}
```

### List My Businesses

List the businesses you have access to. You can filter them by your level of access.

**Inputs**

- Ad account (`ad_account_id`, text): Ad account id.
- Role (`role`, text): The user's role in a business. Used to filter businesses by the user's role. One of: `BUSINESS_ADMIN` (Business admin), `CATALOG_ADMIN` (Catalog admin).
- Page token (`page_token`, text): Page token.
- Page size (`page_size`, number): Page size. At most 700.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}
```

### List Pixels By Ad Account

List the pixels linked to an ad account.

**Inputs**

- Ad account (`ad_account_id`, text, required): The ad account ID.
- Page token (`page_token`, text): Page token.
- Page size (`page_size`, number): Page size. At most 1000.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}
```

### List Profiles By Ad Account

List the profiles linked to an ad account.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Page token (`page_token`, text): Page token.
- Page size (`page_size`, number): Page size. At most 100.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}
```

### Update Ad

Update an ad. For catalog sales ads, the click URL field explains how links are handled.

**Inputs**

- Ad id (`ad_id`, text, required): Ad id.
- Data (`data`, object, required): Partial ad update. The ad type is immutable. Existing clients may continue sending a matching `type`, but new integrations should omit it.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {}
  }
}
```

### Update Ad Account

Update an ad account.

**Inputs**

- Ad account (`ad_account_id`, text, required): Ad account id.
- Data (`data`, object, required): Data.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {
      "admin_approval": "ADMIN",
      "app_attribution_type": "ALL_CONVERSION",
      "app_click_attribution_window": "DAY",
      "app_view_attribution_window": "DAY",
      "attribution_type": "ALL_CONVERSION",
      "business_id": "example",
      "click_attribution_window": "DAY",
      "created_at": "example",
      "currency": "AED",
      "excluded_communities": [],
      "excluded_keywords": [],
      "id": "example",
      "modified_at": "example",
      "name": "example",
      "pixel_partner_preferences": [],
      "primary_contact_member_id": "example",
      "spend_cap_type": "LIFETIME",
      "suspension_reason": "ADVERTISING_POLICY",
      "time_zone_id": "Africa/Abidjan",
      "type": "MANAGED",
      "ugc_addon_default_on": false,
      "view_attribution_window": "DAY"
    }
  }
}
```

### Update Ad Group

Update an ad group.

**Inputs**

- Ad group id (`ad_group_id`, text, required): Ad group id.
- Data (`data`, object, required): Data.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {}
  }
}
```

### Update Campaign

Update a campaign.

**Inputs**

- Campaign id (`campaign_id`, text, required): Campaign id.
- Request body (`request_body`, object, required): Request body.

**Outputs**

- `data` (object): Reddit Ads response data.

**Example output**

```json
{
  "data": {
    "data": {
      "ad_account_id": "example",
      "app_id": "example",
      "bid_strategy": "BIDLESS",
      "bid_type": "CPC",
      "bid_value": 1,
      "configured_status": "ACTIVE",
      "conversion_pixel_id": "example",
      "created_at": "example",
      "delivery_status": [],
      "effective_status": "ACTIVE",
      "end_time": "example",
      "funding_instrument_id": "example",
      "goal_type": "LIFETIME_SPEND",
      "goal_value": 1,
      "id": "example",
      "invoice_label": "example",
      "is_campaign_budget_optimization": false,
      "is_max": false,
      "modified_at": "example",
      "name": "example",
      "objective": "APP_INSTALLS",
      "optimization_goal": "ADD_TO_CART",
      "schedule": [],
      "skadnetwork_metadata": {
        "status": "COOLDOWN"
      },
      "special_ad_categories": [],
      "spend_cap": 1,
      "start_time": "example",
      "type": "MANUAL",
      "use_catalog": false,
      "view_through_conversion_type": "SEVEN_DAY_CLICKS"
    }
  }
}
```
