LinkedIn · Schema

Campaign

BusinessCareersMarketingProfessional NetworkingRecruitingSocial MediaFortune 1000

Properties

Name Type Description
id integer Unique identifier
name string Campaign name
account string Parent account URN
campaignGroup string Parent campaign group URN
status string Campaign status
type string Campaign type
objectiveType string Campaign objective
runSchedule object
dailyBudget object
totalBudget object
View JSON Schema on GitHub

JSON Schema

linkedin-campaign-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Campaign",
  "title": "Campaign",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier",
      "example": 444555666
    },
    "name": {
      "type": "string",
      "description": "Campaign name",
      "example": "Spring Promotion Campaign"
    },
    "account": {
      "type": "string",
      "description": "Parent account URN",
      "example": "urn:li:sponsoredAccount:123456"
    },
    "campaignGroup": {
      "type": "string",
      "description": "Parent campaign group URN",
      "example": "urn:li:sponsoredCampaignGroup:111222333"
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "ARCHIVED",
        "CANCELLED",
        "DRAFT",
        "PAUSED",
        "PENDING_DELETION",
        "REMOVED"
      ],
      "description": "Campaign status",
      "example": "ACTIVE"
    },
    "type": {
      "type": "string",
      "enum": [
        "SPONSORED_UPDATES",
        "SPONSORED_INMAILS",
        "TEXT_AD"
      ],
      "description": "Campaign type",
      "example": "SPONSORED_UPDATES"
    },
    "objectiveType": {
      "type": "string",
      "enum": [
        "BRAND_AWARENESS",
        "ENGAGEMENT",
        "JOB_APPLICANTS",
        "LEAD_GENERATION",
        "VIDEO_VIEWS",
        "WEBSITE_CONVERSIONS",
        "WEBSITE_VISITS"
      ],
      "description": "Campaign objective",
      "example": "WEBSITE_VISITS"
    },
    "runSchedule": {
      "$ref": "#/components/schemas/RunSchedule"
    },
    "dailyBudget": {
      "$ref": "#/components/schemas/Budget"
    },
    "totalBudget": {
      "$ref": "#/components/schemas/Budget"
    }
  }
}