Reddit SK Ad Network API

openapi: 3.2.0
info:
  title: Reddit Advertising SK Ad Network API
  version: '3'
  x-logo:
    url: https://www.redditstatic.com/desktop2x/img/favicon/favicon-32x32.png
  description: '## Ads API terms


    By accessing or using the Ads API and/or associated Reddit Data, you are agreeing that you have read, and that you Agree to comply with and to be bound by, the Ads API Terms and all applicable laws and regulations in their entirety without limitation or qualification. The Ads API Terms apply to and govern your access to and use of the Ads API and Reddit Data, constitute a legally binding agreement between you and Reddit, and include certain terms that are defined in the Advertising Platform Terms, Developer Terms, and User Agreement. You may use the Ads API and Reddit Data only in accordance with the Ads API Terms. Use of the Conversions API is subject to the Advertiser Measurement Program Terms in addition to the same agreements as the Ads API. If you do not agree to the Ads API Terms, and Advertiser Measurement Program Terms as applicable, then you must not access or use the Ads API, Conversions API, or Reddit Data. **Note:** The Reddit Ads API is open to all developers and **does not require allowlisting or approval from Reddit to access**. Get started with the API. API partners working on behalf of advertisers can request support by contacting us. See our supported partners. ## Overview


    The Reddit Ads API lets advertisers tap into the Reddit Ads Platform to build and manage advertising campaigns and accounts programmatically. By integrating Reddit Ads API into your tooling, you can streamline workflows, reduce operational overhead, and accelerate the creation, optimization, and reporting of Reddit campaigns without needing to step into the Reddit Ads Manager directly. All API applications must be authenticated with OAuth2 by creating a developer application and obtaining access and refresh tokens. !v3 ERD diagram


    Here are two popular ways to use the Reddit Ads API:


    - **Postman:** A visual client that makes it simpler to set up and start testing requests and responses. This is the fastest way to familiarize yourself with the API if you prefer a point-and-click approach. You can explore our Postman collections. - **Programmatic access:** Use your preferred programming language or command-line tools to create automations and integrations. This approach is ideal if you want to embed API calls into your workflows or build custom tools. ### User agents


    Rate-limiting issues often occur if you haven''t set your user agent to a unique descriptor. Many default user agents (like `“Python/urllib”` or `“Java”`) are drastically limited to encourage unique and descriptive user-agent strings. We recommend following this format for your client''s user agent string:


    ```

    {{Target platform}}:{{Unique app ID}}:{{Version string}} (by /u/{{Your Reddit username}})

    ```


    > **Note:** Including your version number helps us block old buggy or broken versions of your app safely. Just remember to update this string when you update your version number. Example


    ```

    User-Agent: android:com.example.myredditapp:v1.2.3 (by /u/kemitche)

    ```


    > **Important:** Never lie about your user agent! Don''t pretend to be popular browsers or other bots. We''ll ban anyone caught in the act. ### Pagination


    Paginated endpoints respond with a `pagination` object containing up to 2 fields:


    > **Important:** The URLs for these fields should be followed directly. Don''t assume pagination based on the query parameters in the provided URLs. - **`next_url`:** The full URL to access the next page of the response. If not available, the current page is the final page. - **`previous_url`:** The full URL to access the previous page of the response. If not available, the current page is the first page. All endpoints that return a list, such as `List Campaigns` and `Get a Report`, will be paginated. ### Response types


    Response | Description

    --- | ---

    200 | Successfully processed the request. 400 | Request was invalid. See the client error message for specifics. 401 | No bearer token or a bad bearer token was provided. Check your application authentication.'
servers:
- url: https://ads-api.reddit.com/api/v3
  description: Reddit AdsAPI Production
tags:
- name: SKAdNetwork
  description: Information about SKAdNetwork.
paths:
  /apps/{app_id}/skan_availability:
    get:
      description: 'Retrieve the SKAdNetwork (SKAD) IDs availability quota for an app. Learn more about SKAD IDs.

        ## iOS App Install active limits


        * 10 campaigns per app ID (shared across all ad accounts)

        * 5 ad groups per campaign

        * 10 ads per ad group'
      summary: Get SKAdNetwork Availability
      operationId: get_skan_availability
      parameters:
      - description: The app's iOS App Store ID. Providing only this value will only return the SKAN `campaign_quota`.
        in: path
        name: app_id
        required: true
        schema:
          type: string
          pattern: ^[0-9]+$
      - description: The ad group ID. Required to retrieve `ad_quota`.
        in: query
        name: ad_group_id
        schema:
          description: The ID of the ad group.
          examples:
          - '142154364526'
          type: string
          pattern: ^[0-9]+$
      - description: The campaign ID. Required to retrieve `ad_group_quota`.
        in: query
        name: campaign_id
        schema:
          description: The campaign's ID.
          examples:
          - '12345'
          type: string
          pattern: ^[0-9]+$
      responses:
        '200':
          description: The SKAdNetwork IDs availability quotas.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                - data
                properties:
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      campaign_quota:
                        anyOf:
                        - $ref: '#/components/schemas/components_schema_skadnetwork_id_quota'
                        - type: 'null'
                      ad_group_quota:
                        anyOf:
                        - $ref: '#/components/schemas/components_schema_skadnetwork_id_quota'
                        - type: 'null'
                      ad_quota:
                        anyOf:
                        - $ref: '#/components/schemas/components_schema_skadnetwork_id_quota'
                        - type: 'null'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
      - RedditAPIKey:
        - adsread
      tags:
      - SKAdNetwork
components:
  schemas:
    components_errors_404:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Member ID not found
            code:
              type: integer
              description: The error code.
              examples:
              - 404
    components_errors_429:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          additionalProperties: false
          properties:
            code:
              type: integer
              description: The error code.
              examples:
              - 429
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Too Many Requests
    components_errors_400:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            code:
              type: integer
              description: The error code.
              examples:
              - 400
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Bad request.
            fields:
              title: FieldsList
              type: array
              items:
                type: object
                required:
                - field
                - message
                additionalProperties: false
                properties:
                  field:
                    title: FieldName
                    type: string
                    description: The field that caused the error.
                    examples:
                    - field_name
                  message:
                    type: string
                    description: A human friendly error message.
                    examples:
                    - Invalid value.
              description: The fields that caused the error.
    components_schema_skadnetwork_id_quota:
      type: object
      additionalProperties: false
      properties:
        available:
          type: integer
          description: The number of SKAdNetwork IDs available for use.
          examples:
          - 10
        used:
          type: integer
          description: The number of SKAdNetwork IDs used.
          examples:
          - 0
        cooldown:
          type: integer
          description: The number SKAdNetwork IDs in a cooldown period.
          examples:
          - 0
        total:
          type: integer
          description: 'The total number of SKAdNetwork IDs: sum of available, used, and cooldown.'
          examples:
          - 10
    components_errors_403:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Access not granted for listing profiles.
            code:
              type: integer
              description: The error code.
              examples:
              - 403
    components_errors_500:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            code:
              type: integer
              description: The error code.
              examples:
              - 500
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Internal Server Error
    components_errors_401:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Bad bearer token provided.
            code:
              type: integer
              description: The error code.
              examples:
              - 401
  responses:
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_400'
    Unauthorized:
      description: No bearer token or a bad bearer token was provided.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_401'
    NotFound:
      description: The specified resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_404'
    TooManyRequests:
      description: Too many requests. See [Rate Limiting](/docs/v3/guides/quick-start/rate-limiting) for header details and best practices.
      headers:
        RateLimit-Policy:
          description: The rate limit policies that apply to this request (IETF "RateLimit header fields for HTTP" draft). Each comma-separated policy is keyed by a public policy name and lists its quota `q` and window in seconds `w`.
          schema:
            type: string
            examples:
            - '"custom-audience-ingestion";q=3000;w=900,"custom-audience-ingestion-burst";q=500;w=60'
        RateLimit:
          description: 'The current rate limit state for each applicable policy (IETF "RateLimit header fields for HTTP" draft): remaining quota `r` and seconds until the window resets `t`. On a 429 the exhausted policy reports `r=0`.'
          schema:
            type: string
            examples:
            - '"custom-audience-ingestion";r=0;t=42,"custom-audience-ingestion-burst";r=0;t=5'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_429'
    ServerError:
      description: Server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_500'
    Forbidden:
      description: Insufficient authentication scopes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_403'
  securitySchemes:
    RedditAPIKey:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://www.reddit.com/api/v1/authorize
          refreshUrl: https://www.reddit.com/api/v1/access_token
          tokenUrl: https://www.reddit.com/api/v1/access_token
          scopes:
            adsconversions: Post conversion events through the API
            adsread: Read advertising data through my account.
            adsedit: Write advertising data through my account.
            adsdatadeletion: Delete advertising data through my account.
      description: Reddit OAuth2 Security Key