Nexta Developer Portal

Nexta Developer Portal

  • Guides
  • API

›Introduction

Introduction

  • Overview
  • Getting started
  • Authentication and authorization
  • API health
  • Error handling

Guides

  • Client onboarding
  • Campaign creation
  • Banner upload
  • Goals API
  • Campaign Set Status
  • Facebook Special Ad Categories

Nexta API Overview

Nexta API is a unified API connected to the global advertising ecosystem, including platforms like Meta, Google Ads, TikTok, LinkedIn, Google Ad Manager, Kevel, Adform, SAS360, Xandr Invest, and more to come. Nexta API simplifies integrations with advertising platforms and provides a straightforward, robust, and efficient gateway to manage accounts, campaigns, creatives, reporting, and optimization across multiple advertising platforms.

Nexta API Overview


Industry Solutions

Nexta API serves as the backbone for Nexta's industry-specific solutions:

  • Nexta Ad Manager for Retail Media
  • Nexta Ad Manager for Commerce Media
  • Nexta Ad Manager for Marketplaces
  • Nexta Ad Manager for Publishers
  • Nexta Ad Manager for Media Agencies
  • Nexta Ad Manager for Brands

Main APIs

Nexta API consists of four primary APIs:

  1. Clients API
  2. Campaigns API
  3. Ads API
  4. Reporting API

Supporting APIs

In addition to the main APIs, Nexta API offers several supporting APIs:

  1. Mediaplan API
  2. Products API
  3. Payments API
  4. Notifications API
  5. Dictionaries API
  6. Changelog API

Domain Model

Nexta's domain model is built around the following main entities:

  • Client: The primary parent entity in the domain model. It contains advertiser information such as a global identifier, address, public company identification, and references to advertising accounts in the connected systems.
  • Campaign-set: A container for managing one or more campaigns across connected advertising systems. It supports omni-channel optimization and budget allocation based on multi-objective goals like impressions, clicks, leads, and conversions.
  • Campaign: Represents the campaign entity in connected systems, holding key properties such as name, budget, currency, time zone, and flight dates.
  • Adset: Also known as a "line item" or "flight," the adset controls targeting and delivery. Key properties include targeting, placements, bidding, delivery, objectives, and goals.
  • Ad: Represents the creative advertisement entity, which can take various forms such as an image, a html file, a sponsored product, a search ad, or other types of promotional content.

The entity hierarchy is depicted below:

Nexta Domain Model


Nexta Ad Manager Instances

Nexta is a multi-tenant platform providing Nexta Ad Managers as separate instances. Each "Nexta Ad Manager" is a single, customized instance of the Nexta platform. It includes multiple clients within a separate authentication and authorization boundary, ensuring secure access to clients, campaign-sets, campaigns, adsets, ads, and reports based on user roles.

A "Nexta Ad Manager" is created upon request, with subsequent operations fully self-service.

Nexta Ad Manager Instances


Clients API

The Clients API manages the lifecycle of clients and their accounts in connected advertising platforms. It automates onboarding and offboarding processes for setting up and managing advertising accounts in these systems.

Key Processes Handled by the Clients API

  • Client onboarding and provisioning accounts in connected systems
  • Client deletion and cleanup of accounts in connected systems
  • Updating client (advertiser) information

Campaigns API

The Campaigns API oversees all aspects of managing and provisioning campaign-sets, campaigns, and adsets to target systems.

Key Processes Supported by the Campaigns API

  • Creation and updates of campaign-sets
  • Creation of campaigns and adsets in connected systems
  • Updates to targeting, placements, budgets, flight dates, delivery, bidding, and optimization

Additional Entities Managed by the Campaigns API

  • Booking Details: Data models for CRM and billing integration
  • Properties: Management of specific system properties and features
  • Delivery Rules: Rules for cost, impression, or click delivery schemes
  • Activation Rules: Rules for pausing and activating campaigns
  • Optimization: Omni-channel optimization configurations and budget allocation
  • Goals: Campaign goals like clicks, leads, and conversions for optimization algorithms
  • Templates: Predefined campaign templates to streamline booking flows

Ads API

The Ads API handles all aspects of creative production and management for various ad types supported across connected advertising platforms.

Key Processes Supported by the Ads API

  • Ad Production: Building and composing ads for the supported ad types across connected advertising platforms.
  • Ad Upload and Provisioning: Uploading and provisioning ads to the connected systems.
  • Ad Lifecycle Management: Managing the entire lifecycle of ads, including activation, pausing, updating content, and deletion.

Reporting API

The Reporting API delivers comprehensive campaign statistics across a wide range of relevant dimensions for advertising activities. A fully automated process ensures continuous collection of campaign data in all available dimensions, providing near real-time and consistently updated statistics.

Key Reporting Dimensions Provided by the Reporting API

  • Client
  • Campaign
  • Adset
  • Ad
  • Audience
  • Segment
  • Location
  • Placement
  • Device
  • Keyword
Getting started →
  • Industry Solutions
  • Main APIs
  • Supporting APIs
  • Domain Model
  • Nexta Ad Manager Instances
  • Clients API
    • Key Processes Handled by the Clients API
  • Campaigns API
    • Key Processes Supported by the Campaigns API
    • Additional Entities Managed by the Campaigns API
  • Ads API
    • Key Processes Supported by the Ads API
  • Reporting API
    • Key Reporting Dimensions Provided by the Reporting API
Copyright © 2024 Nexta ApS