キャンペーンREST API

{
  "$schema" : "https://json-schema.org/draft-04/schema#",
  "id" : "#campaign",
  "type" : "object",
  "title" : "Campaign schema",
  "description" : "This schema describes inner structure of a campaign resource",
  "additionalProperties" : false,
  "properties" : {
    "id" : {
      "type" : "integer",
      "description" : "Reference ID within a resource collection",
      "minimum" : 1,
      "o:sortable" : true,
      "o:queryable" : true
    },
    "name" : {
      "type" : "string",
      "description" : "Name of the Resource",
      "minLength" : 1,
      "maxLength" : 120,
      "o:sortable" : true,
      "o:queryable" : true
    },
    "partner" : {
      "type" : "object",
      "description" : "This schema describes inner structure of a stub resource with id and name",
      "additionalProperties" : false,
      "properties" : {
        "id" : {
          "type" : "integer",
          "description" : "Reference ID within a resource collection",
          "minimum" : 1
        },
        "name" : {
          "type" : "string",
          "description" : "Name of the Resource",
          "minLength" : 1
        }
      }
    },
    "audience" : {
      "type" : "object",
      "description" : "This schema describes inner structure of a stub resource with id and name",
      "additionalProperties" : false,
      "properties" : {
        "id" : {
          "type" : "integer",
          "description" : "Reference ID within a resource collection",
          "minimum" : 1
        },
        "name" : {
          "type" : "string",
          "description" : "Name of the Resource",
          "minLength" : 1
        }
      },
      "required" : [ "id" ]
    },
    "bid" : {
      "type" : "number",
      "description" : "Bid value"
    },
    "pacingGoal" : {
      "type" : "number",
      "description" : "Pacing value"
    },
    "startDate" : {
      "type" : "string",
      "format" : "date-time",
      "description" : "Campaign start date and time",
      "minLength" : 20,
      "maxLength" : 29,
      "o:queryable" : true,
      "o:sortable" : true
    },
    "endDate" : {
      "type" : "string",
      "format" : "date-time",
      "description" : "Campaign end date and time",
      "minLength" : 20,
      "maxLength" : 29,
      "o:queryable" : true,
      "o:sortable" : true
    },
    "activated" : {
      "type" : "boolean",
      "default" : false,
      "description" : "Flag showing if campaign is activated or not"
    },
    "includeTopNodes" : {
      "type" : "boolean",
      "default" : true,
      "description" : "Flag showing top nodes should be included or not"
    },
    "pacingType" : {
      "enum" : [ "noRestriction", "budgetPerDay", "budgetPerCampaignLifetime", "stampsPerDay", "stampsPerCampaignLifetime", "cpm", "alwaysOn" ],
      "description" : "Pacing type of the campaign"
    },
    "categoryTransferMethod" : {
      "type" : "integer",
      "default" : 0,
      "description" : "Pacing value"
    },
    "httpsPull" : {
      "default" : false,
      "type" : "boolean",
      "description" : "Flag for httpsPull"
    },
    "negativeRevenue" : {
      "default" : false,
      "type" : "boolean",
      "description" : "Flag for negative revenue"
    },
    "targetingSource" : {
      "default" : "user",
      "type" : "string",
      "description" : "Targeting source"
    },
    "winFrequency" : {
      "type" : "integer",
      "default" : 30,
      "description" : "Win Frequency"
    },
    "campaignType" : {
      "enum" : [ "normal", "blanket" ],
      "description" : "Campaign Type"
    },
    "revenueRecognition" : {
      "type" : "boolean",
      "default" : false,
      "description" : "Flag for revenue recognition",
      "o:queryable" : true
    },
    "testCampaign" : {
      "type" : "boolean",
      "default" : false,
      "description" : "Flag for test campaign",
      "o:queryable" : true
    },
    "idSwap" : {
      "type" : "boolean",
      "default" : false,
      "description" : "Flag for ID swap",
      "o:queryable" : true
    },
    "jsonPullMacro" : {
      "type" : "boolean",
      "default" : false,
      "description" : "Flag for JSON Pull Macro"
    },
    "pricingModel" : {
      "type" : "object",
      "description" : "This schema describes inner structure of a stub resource with id and name",
      "additionalProperties" : false,
      "properties" : {
        "id" : {
          "type" : "integer",
          "description" : "Reference ID within a resource collection",
          "minimum" : 1
        },
        "name" : {
          "type" : "string",
          "description" : "Name of the Resource",
          "minLength" : 1
        }
      }
    },
    "solutionType" : {
      "type" : "object",
      "description" : "This schema describes inner structure of a stub resource with id and name",
      "additionalProperties" : false,
      "properties" : {
        "id" : {
          "type" : "integer",
          "description" : "Reference ID within a resource collection",
          "minimum" : 1
        },
        "name" : {
          "type" : "string",
          "description" : "Name of the Resource",
          "minLength" : 1
        }
      }
    },
    "notes" : {
      "type" : "string",
      "description" : "Notes"
    },
    "recency" : {
      "type" : "integer",
      "description" : "Recency",
      "default" : -1
    },
    "retargetingSites" : {
      "type" : "array",
      "items" : {
        "$ref" : "#stub"
      }
    },
    "privateSellers" : {
      "type" : "array",
      "items" : {
        "$ref" : "#stub"
      }
    },
    "status" : {
      "enum" : [ "idle", "active", "hidden", "archived", "creating", "mapping", "simulating", "simulated" ],
      "default" : "idle",
      "description" : "Campaign status",
      "o:queryable" : true,
      "o:sortable" : true
    },
    "createdAt" : {
      "type" : "string",
      "format" : "date-time",
      "description" : "Campaign created date and time",
      "minLength" : 20,
      "maxLength" : 25,
      "o:queryable" : true,
      "o:sortable" : true
    },
    "updatedAt" : {
      "type" : "string",
      "format" : "date-time",
      "description" : "Campaign updated date and time",
      "minLength" : 20,
      "maxLength" : 25,
      "o:queryable" : true,
      "o:sortable" : true
    },
    "labels" : {
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "type" : "string"
      }
    },
    "pixelUrls" : {
      "type" : "array",
      "items" : {
        "$ref" : "#pixelUrl"
      }
    },
    "deliveryIDs" : {
      "type" : "array",
      "description" : "Delivery Id Types used in this Campaign",
      "items" : {
        "$ref" : "#idType"
      },
      "o:queryable" : true
    },
    "prior7DaysDeliveryStat" : {
      "type" : "array",
      "items" : {
        "type" : "integer"
      }
    },
    "priority" : {
      "type" : "integer",
      "description" : "priority",
      "default" : 10
    },
    "partnerSitesOnly" : {
      "type" : "boolean",
      "default" : false
    },
    "winOnSites" : {
      "type" : "array",
      "items" : {
        "$ref" : "#stub"
      }
    },
    "simulationAccuracy" : {
      "type" : "integer",
      "description" : "Setting for simulating campaign"
    }
  },
  "required" : [ "name", "startDate", "campaignType", "audience" ],
  "links" : [ {
    "rel" : "search",
    "href" : "#",
    "schema" : {
      "type" : "object",
      "properties" : {
        "nameOrId" : {
          "type" : "string",
          "description" : "Filter by Name or ID"
        },
        "label" : {
          "type" : "string",
          "description" : "Filter by label"
        },
        "since" : {
          "type" : "string",
          "format" : "date-time"
        },
        "until" : {
          "type" : "string",
          "format" : "date-time"
        },
        "q" : {
          "type" : "string",
          "format" : "scim"
        },
        "vendorId" : {
          "type" : "integer",
          "description" : "Filter by vendorId"
        },
        "onRampFlag" : {
          "type" : "boolean",
          "description" : "onramp flag"
        },
        "createdBy" : {
          "type" : "integer",
          "description" : "Filter by creator user ID"
        },
        "appId" : {
          "type" : "integer",
          "description" : "Search campaigns that use specified app ID"
        },
        "deliveryIDs" : {
          "type" : "array",
          "description" : "Delivery Id Types that used in this campaign",
          "items" : {
            "$ref" : "#idType"
          }
        }
      }
    }
  }, {
    "rel" : "canonical",
    "href" : "/rest/campaigns/{id}"
  }, {
    "rel" : "collection",
    "href" : "/rest/campaigns"
  } ]
}

{
  "items" : [ {
    "id" : 131691,
    "name" : "Holiday Shopper Campaign",
    "partner" : {
      "id" : 9876,
      "name" : "Example Marketing"
    },
    "audience" : {
      "id" : 179743,
      "name" : "Holiday Shopper Audience"
    },
    "bid" : 0.1,
    "pacingGoal" : 0.0,
    "startDate" : "2017-02-14T00:00:00-06:00",
    "activated" : true,
    "includeTopNodes" : false,
    "pacingType" : "noRestriction",
    "categoryTransferMethod" : 2,
    "httpsPull" : false,
    "negativeRevenue" : false,
    "targetingSource" : "user",
    "winFrequency" : 0,
    "campaignType" : "normal",
    "revenueRecognition" : false,
    "testCampaign" : false,
    "idSwap" : false,
    "jsonPullMacro" : true,
    "pricingModel" : {
      "id" : 2,
      "name" : "CPM"
    },
    "solutionType" : {
      "id" : 3,
      "name" : "Site Optimization"
    },
    "recency" : -1,
    "retargetingSites" : [ ],
    "privateSellers" : [ ],
    "status" : "active",
    "createdAt" : "2017-02-14T10:24:04-06:00",
    "updatedAt" : "2017-02-14T10:24:15-06:00",
    "labels" : [ ],
    "pixelUrls" : [ ],
    "deliveryIDs" : [ {
      "id" : 6,
      "name" : "Google Advertising ID (AdID)",
      "partner" : {
        "id" : 0
      },
      "category" : {
        "id" : 489904
      },
      "id_key" : "adid",
      "ingest_key" : "adid",
      "super_space" : 3,
      "sub_space" : 1,
      "permission" : "public",
      "id_class" : "primary",
      "retention" : 100,
      "ingest_methods" : [ "url_argument" ],
      "usages" : [ "delivery", "matching", "storage", "opt_out" ],
      "device_group" : "mobile",
      "context_group" : "app",
      "metadata" : [ ],
      "sites" : [ 0, 26023, 26024, 33482, 41944 ],
      "target_partners" : [ ],
      "permissioned_partners" : [ ],
      "description" : "Target users whose data was collected from Android apps and are linked to an ADID.",
      "status" : "active"
    }, {
      "id" : 3,
      "name" : "Oracle Data Cloud Mobile Cookie ID",
      "partner" : {
        "id" : 0
      },
      "category" : {
        "id" : 489902
      },
      "id_key" : "bkmobileid",
      "ingest_key" : "bkmobileid",
      "super_space" : 0,
      "sub_space" : 32451,
      "permission" : "public",
      "id_class" : "primary",
      "retention" : 45,
      "ingest_methods" : [ ],
      "usages" : [ "delivery", "matching", "storage" ],
      "device_group" : "mobile",
      "context_group" : "web",
      "metadata" : [ ],
      "sites" : [ ],
      "target_partners" : [ ],
      "permissioned_partners" : [ ],
      "description" : "Target users whose data was collected from mobile web browsers and are linked to Oracle Data Cloud third-party mobile cookie ID.",
      "status" : "active"
    }, {
      "id" : 9,
      "name" : "Apple IDFA",
      "partner" : {
        "id" : 0
      },
      "category" : {
        "id" : 489903
      },
      "id_key" : "idfa",
      "ingest_key" : "idfa",
      "super_space" : 3,
      "sub_space" : 4,
      "permission" : "public",
      "id_class" : "primary",
      "retention" : 100,
      "ingest_methods" : [ "url_argument" ],
      "usages" : [ "delivery", "matching", "storage", "opt_out" ],
      "device_group" : "mobile",
      "context_group" : "app",
      "metadata" : [ ],
      "sites" : [ 0, 26023, 26024, 33482, 41944 ],
      "target_partners" : [ ],
      "permissioned_partners" : [ ],
      "description" : "Target users whose data was collected from iOS apps and are linked to an IDFA.",
      "status" : "active"
    },  
    {
      "id" : 1,
      "name" : "Oracle Data Cloud 3rd Party Desktop Cookie ID",
      "partner" : {
        "id" : 0
      },
      "category" : {
        "id" : 489900
      },
      "id_key" : "bkuuid",
      "ingest_key" : "bkuuid",
      "super_space" : 0,
      "sub_space" : 0,
      "permission" : "public",
      "id_class" : "primary",
      "retention" : 45,
      "ingest_methods" : [ "header" ],
      "usages" : [ "delivery", "matching", "storage" ],
      "device_group" : "desktop",
      "context_group" : "web",
      "metadata" : [ "collision", "single" ],
      "sites" : [ ],
      "target_partners" : [ ],
      "permissioned_partners" : [ ],
      "description" : "Target users whose data was collected from desktop web browsers and are linked to Oracle Data Cloud third-party cookie IDs.",
      "status" : "active"
    } ],
    "prior7DaysDeliveryStat" : [ ],
    "priority" : 1,
    "partnerSitesOnly" : false,
    "winOnSites" : [ ]
  } ],
  "totalResults" : 1,
  "limit" : 50,
  "offset" : 0,
  "count" : 1,
  "hasMore" : false
}