Platforms

Platforms are the different advertising platforms that n_2 supports. Each platform has its own set of endpoints that can be used to manage campaigns, ad sets, ads and targetings.

The Platforms Model

The Platforms model of n_2 describes an advertising platform. Currently it contains information such as the name and a description of the platform. The platforms capabilities are described in the capabilities property. This property contains a list of capabilities that the platform supports. The channel kinds that the platform supports are described in the channelKinds property. It indicates in what channel kinds the platform can run campaigns.

Properties

Name
name
Type
string
Description
Name of the platform.
Name
description
Type
string
Description
Description of the platform.
Name
capabilities
Type
list<Capability>
Description
A list of capabilities that the platform supports.
Name
channelKinds
Type
list<ChannelKindCapability>
Description
A list of channel kinds that the platform supports.

Example Object

{
  "name": "Pinterest",
  "description": "Pinterest is an image sharing and social media service designed to enable saving and discovery of information (specifically \"ideas\") on the internet using images, and on a smaller scale, animated GIFs and videos, in the form of pinboards.",
  "capabilities": [
    {
      "name": "DailyBudgetCapCapability",
      "description": "The capability to define a maximum daily budget capping. The budget spent on one day can not exceed this limit.",
      "kind": "BudgetCappingCapability",
      "parentKind": "Campaign"
    },
    {
      "name": "LifetimeBudgetCappingCapability",
      "description": "The capability to define a maximum lifetime budget. The budget spent during the lifetime of the parent resource can not exceed this limit.",
      "kind": "BudgetCappingCapability",
      "parentKind": "Campaign"
    },
    {
      "name": "ChannelKindCapability",
      "description": "The capability to advertise on the SOCIAL channel kind",
      "kind": "ChannelKindCapability",
      "parentKind": "Campaign"
    },
    {
      "name": "ZipcodeGeoTargetingCapability",
      "description": "The capability to include or exclude an audience based on their location defined as a list of zipcodes (postal codes).",
      "kind": "TargetingCapability",
      "parentKind": "AdSet"
    }
  ],
  "channelkinds": [
    {
      "name": "ChannelKindCapability",
      "description": "The capability to advertise on the SOCIAL channel kind",
      "kind": "ChannelKindCapability",
      "parentKind": "Campaign"
    }
  ]
}

GET/v1/platforms

List all platforms

This endpoint allows you to list all platforms that are supported by n_2.

Request

GET

/v1/platforms

curl -G https://api.n2api.io/v1/platforms \
  -H "Authorization: Bearer {token}" \

Response

[
  {
    "name": "Pinterest",
    "description": "Pinterest is an image sharing and social media service designed to enable saving and discovery of information (specifically \"ideas\") on the internet using images, and on a smaller scale, animated GIFs and videos, in the form of pinboards.",
    "capabilities": [
      {
        "name": "DailyBudgetCapCapability",
        "description": "The capability to define a maximum daily budget capping. The budget spent on one day can not exceed this limit.",
        "kind": "BudgetCappingCapability",
        "parentKind": "Campaign"
      },
      {
        "name": "LifetimeBudgetCappingCapability",
        "description": "The capability to define a maximum lifetime budget. The budget spent during the lifetime of the parent resource can not exceed this limit.",
        "kind": "BudgetCappingCapability",
        "parentKind": "Campaign"
      },
      {
        "name": "ChannelKindCapability",
        "description": "The capability to advertise on the SOCIAL channel kind",
        "kind": "ChannelKindCapability",
        "parentKind": "Campaign"
      },
      {
        "name": "ZipcodeGeoTargetingCapability",
        "description": "The capability to include or exclude an audience based on their location defined as a list of zipcodes (postal codes).",
        "kind": "TargetingCapability",
        "parentKind": "AdSet"
      }
    ],
    "channelkinds": [
      {
        "name": "ChannelKindCapability",
        "description": "The capability to advertise on the SOCIAL channel kind",
        "kind": "SocialChannelKind",
        "parentKind": "Campaign"
      }
    ]
  },
  {
    "name": "GoogleAds",
    "description": "...",
    "capabilities": [
      ...
    ],
    "channelkinds": [
      {
        "name": "ChannelKindCapability",
        "description": "The capability to advertise on the SEARCH channel kind",
        "kind": "SearchChannelKind",
        "parentKind": "AdSet"
      },
      {
        "name": "ChannelKindCapability",
        "description": "The capability to advertise on the DISPLAY channel kind",
        "kind": "DisplayChannelKind",
        "parentKind": "AdSet"
      },
      {
        "name": "ChannelKindCapability",
        "description": "The capability to advertise on the SHOPPING channel kind",
        "kind": "ShoppingChannelKind",
        "parentKind": "AdSet"
      },
      {
        "name": "ChannelKindCapability",
        "description": "The capability to advertise on the VIDEO channel kind",
        "kind": "VideoChannelKind",
        "parentKind": "AdSet"
      }
    ]
  }
]