API tools faq
paste
Advertisement
uzilan

Untitled

uzilan
Aug 16th, 2018
94
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
YAML 66.64 KB | None | 0 0
raw download clone embed print report
  1. ---
  2. swagger: "2.0"
  3. info:
  4.   version: "6.3-SNAPSHOT"
  5.   title: "campaign-service"
  6. tags:
  7. - name: "Ads"
  8.   description: "Ads operations"
  9. - name: "Banner Areas"
  10.   description: "Banner Areas operations"
  11. - name: "Campaigns"
  12.   description: "Campaign operations"
  13. - name: "Goals"
  14.   description: "goal operations"
  15. - name: "VAST URLs"
  16.   description: "VAST Operations."
  17. paths:
  18.   /campaign-internal/v3/sites:
  19.     get:
  20.       summary: "getSites"
  21.       description: ""
  22.       operationId: "getSites"
  23.       consumes:
  24.      - "application/json"
  25.       produces:
  26.      - "application/json"
  27.       parameters:
  28.       - name: "option"
  29.         in: "query"
  30.         required: false
  31.         type: "array"
  32.         items:
  33.           type: "string"
  34.         collectionFormat: "multi"
  35.       responses:
  36.         200:
  37.           description: "OK"
  38.           schema:
  39.             type: "array"
  40.             items:
  41.               $ref: "#/definitions/Site"
  42.         500:
  43.           description: "Internal Server Error"
  44.   /campaign-internal/v3/sites/{siteId}:
  45.     get:
  46.       summary: "getSite"
  47.       description: ""
  48.       operationId: "getSite"
  49.       consumes:
  50.      - "application/json"
  51.       produces:
  52.      - "application/json"
  53.       parameters:
  54.       - name: "siteId"
  55.         in: "path"
  56.         required: true
  57.         type: "string"
  58.         format: "uuid"
  59.       - name: "option"
  60.         in: "query"
  61.         required: false
  62.         type: "array"
  63.         items:
  64.           type: "string"
  65.         collectionFormat: "multi"
  66.       responses:
  67.         200:
  68.           description: "OK"
  69.           schema:
  70.             $ref: "#/definitions/Site"
  71.         404:
  72.           description: "Not Found"
  73.         500:
  74.           description: "Internal Server Error"
  75.   /campaign-internal/v3/sites/{siteId}/advertisers:
  76.     get:
  77.       operationId: "getAdvertisers"
  78.       produces:
  79.      - "application/json"
  80.       parameters:
  81.       - name: "siteId"
  82.         in: "path"
  83.         required: true
  84.         type: "string"
  85.         format: "uuid"
  86.       responses:
  87.         200:
  88.           description: "successful operation"
  89.           schema:
  90.             type: "array"
  91.             items:
  92.               $ref: "#/definitions/Client"
  93.   /campaign-internal/v3/sites/{siteId}/agencies:
  94.     get:
  95.       operationId: "getAgencies"
  96.       produces:
  97.      - "application/json"
  98.       parameters:
  99.       - name: "siteId"
  100.         in: "path"
  101.         required: true
  102.         type: "string"
  103.         format: "uuid"
  104.       responses:
  105.         200:
  106.           description: "successful operation"
  107.           schema:
  108.             type: "array"
  109.             items:
  110.               $ref: "#/definitions/Client"
  111.   /campaign-internal/v3/sites/{siteId}/brands:
  112.     get:
  113.       operationId: "getBrands"
  114.       produces:
  115.      - "application/json"
  116.       parameters:
  117.       - name: "siteId"
  118.         in: "path"
  119.         required: true
  120.         type: "string"
  121.         format: "uuid"
  122.       responses:
  123.         200:
  124.           description: "successful operation"
  125.           schema:
  126.             type: "array"
  127.             items:
  128.               $ref: "#/definitions/Client"
  129.   /campaign-internal/v3/sites/{siteId}/categories:
  130.     get:
  131.       operationId: "getCategories"
  132.       produces:
  133.      - "application/json"
  134.       parameters:
  135.       - name: "siteId"
  136.         in: "path"
  137.         required: true
  138.         type: "string"
  139.         format: "uuid"
  140.       - name: "leaves"
  141.         in: "query"
  142.         required: false
  143.         type: "string"
  144.         enum:
  145.        - "PRESENT"
  146.         - "ABSENT"
  147.       responses:
  148.         200:
  149.           description: "successful operation"
  150.           schema:
  151.             type: "array"
  152.             items:
  153.               $ref: "#/definitions/Category"
  154.   /campaign-internal/v3/sites/{siteId}/categories/{shareId}:
  155.     get:
  156.       operationId: "getCategory"
  157.       produces:
  158.      - "application/json"
  159.       parameters:
  160.       - name: "siteId"
  161.         in: "path"
  162.         required: true
  163.         type: "string"
  164.         format: "uuid"
  165.       - name: "shareId"
  166.         in: "path"
  167.         required: true
  168.         type: "string"
  169.         format: "uuid"
  170.       responses:
  171.         200:
  172.           description: "successful operation"
  173.           schema:
  174.             $ref: "#/definitions/Category"
  175.   /campaign-internal/v3/sites/{siteId}/content-partners:
  176.     get:
  177.       operationId: "getContentPartners"
  178.       produces:
  179.      - "application/json"
  180.       parameters:
  181.       - name: "siteId"
  182.         in: "path"
  183.         required: true
  184.         type: "string"
  185.         format: "uuid"
  186.       responses:
  187.         200:
  188.           description: "successful operation"
  189.           schema:
  190.             type: "array"
  191.             items:
  192.               $ref: "#/definitions/Share"
  193.   /campaign-internal/v3/sites/{siteId}/devicecontainers:
  194.     get:
  195.       operationId: "getDeviceContainers"
  196.       produces:
  197.      - "application/json"
  198.       parameters:
  199.       - name: "siteId"
  200.         in: "path"
  201.         required: true
  202.         type: "string"
  203.         format: "uuid"
  204.       - name: "includeDeleted"
  205.         in: "query"
  206.         required: false
  207.         type: "string"
  208.         enum:
  209.        - "PRESENT"
  210.         - "ABSENT"
  211.       responses:
  212.         200:
  213.           description: "successful operation"
  214.           schema:
  215.             type: "array"
  216.             items:
  217.               $ref: "#/definitions/DeviceContainer"
  218.   /campaign-internal/v3/sites/{siteId}/devicecontainers/{deviceContainerId}:
  219.     get:
  220.       operationId: "getDeviceContainerByID"
  221.       produces:
  222.      - "application/json"
  223.       parameters:
  224.       - name: "siteId"
  225.         in: "path"
  226.         required: true
  227.         type: "string"
  228.         format: "uuid"
  229.       - name: "deviceContainerId"
  230.         in: "path"
  231.         required: true
  232.         type: "string"
  233.         format: "uuid"
  234.       - name: "includeDeleted"
  235.         in: "query"
  236.         required: false
  237.         type: "string"
  238.         enum:
  239.        - "PRESENT"
  240.         - "ABSENT"
  241.       responses:
  242.         200:
  243.           description: "successful operation"
  244.           schema:
  245.             $ref: "#/definitions/DeviceContainer"
  246.   /campaign-internal/v3/sites/{siteId}/external-trackers:
  247.     get:
  248.       summary: "getExternalTrackers"
  249.       description: ""
  250.       operationId: "getExternalTrackers"
  251.       consumes:
  252.      - "application/json"
  253.       produces:
  254.      - "application/json"
  255.       parameters:
  256.       - name: "siteId"
  257.         in: "path"
  258.         required: true
  259.         type: "string"
  260.         format: "uuid"
  261.       responses:
  262.         200:
  263.           description: "OK"
  264.           schema:
  265.             type: "array"
  266.             items:
  267.               $ref: "#/definitions/ExternalTracker"
  268.         404:
  269.           description: "Not Found"
  270.         500:
  271.           description: "Internal Server Error"
  272.     post:
  273.       summary: "createExternalTrackers"
  274.       description: ""
  275.       operationId: "createExternalTracker"
  276.       consumes:
  277.      - "application/json"
  278.       produces:
  279.      - "application/json"
  280.       parameters:
  281.       - name: "siteId"
  282.         in: "path"
  283.         required: true
  284.         type: "string"
  285.         format: "uuid"
  286.       responses:
  287.         201:
  288.           description: "Created"
  289.         404:
  290.           description: "Not Found"
  291.         500:
  292.           description: "Internal Server Error"
  293.     put:
  294.       summary: "replaceExternalTrackers"
  295.       description: ""
  296.       operationId: "replaceExternalTrackers"
  297.       consumes:
  298.      - "application/json"
  299.       produces:
  300.      - "application/json"
  301.       parameters:
  302.       - name: "siteId"
  303.         in: "path"
  304.         required: true
  305.         type: "string"
  306.         format: "uuid"
  307.       responses:
  308.         200:
  309.           description: "OK"
  310.         404:
  311.           description: "Not Found"
  312.         500:
  313.           description: "Internal Server Error"
  314.   /campaign-internal/v3/sites/{siteId}/external-trackers/count:
  315.     get:
  316.       operationId: "countExternalTrackers"
  317.       consumes:
  318.      - "application/json"
  319.       produces:
  320.      - "application/json"
  321.       parameters:
  322.       - name: "siteId"
  323.         in: "path"
  324.         required: true
  325.         type: "string"
  326.         format: "uuid"
  327.       responses:
  328.         200:
  329.           description: "OK"
  330.           schema:
  331.             type: "integer"
  332.             format: "int64"
  333.         404:
  334.           description: "Not Found"
  335.         500:
  336.           description: "Internal Server Error"
  337.   /campaign-internal/v3/sites/{siteId}/options:
  338.     get:
  339.       operationId: "getOptions"
  340.       consumes:
  341.      - "application/json"
  342.       produces:
  343.      - "application/json"
  344.       parameters:
  345.       - name: "siteId"
  346.         in: "path"
  347.         required: true
  348.         type: "string"
  349.         format: "uuid"
  350.       - name: "startingWith"
  351.         in: "query"
  352.         required: false
  353.         type: "string"
  354.       responses:
  355.         200:
  356.           description: "successful operation"
  357.           schema:
  358.             type: "object"
  359.             additionalProperties:
  360.               type: "string"
  361.     post:
  362.       operationId: "setOptions"
  363.       consumes:
  364.      - "application/json"
  365.       produces:
  366.      - "application/json"
  367.       parameters:
  368.       - name: "siteId"
  369.         in: "path"
  370.         required: true
  371.         type: "string"
  372.         format: "uuid"
  373.       responses:
  374.         default:
  375.           description: "successful operation"
  376.   /v3/ads:
  377.     get:
  378.       tags:
  379.      - "Ads"
  380.       summary: "List Ads"
  381.       description: ""
  382.       operationId: "getAdsForSite"
  383.       consumes:
  384.      - "application/json"
  385.       produces:
  386.      - "application/json"
  387.       parameters:
  388.       - name: "embed"
  389.         in: "query"
  390.         description: "Embed additional information about objects. Note that projections\
  391.          \ is only available for goals."
  392.         required: false
  393.         type: "array"
  394.         items:
  395.           type: "string"
  396.           enum:
  397.          - "projections"
  398.           - "metrics"
  399.         collectionFormat: "multi"
  400.         enum:
  401.        - "projections"
  402.         - "metrics"
  403.       - name: "metrics"
  404.         in: "query"
  405.         description: "Specify which metrics to return."
  406.         required: false
  407.         type: "array"
  408.         items:
  409.           type: "string"
  410.         collectionFormat: "multi"
  411.         enum:
  412.        - "impression"
  413.         - "clickThrough"
  414.         - "start"
  415.         - "complete"
  416.         - "firstQuartile"
  417.         - "midpoint"
  418.         - "thirdQuartile"
  419.         - "all"
  420.       - name: "ads.created.before"
  421.         in: "query"
  422.         description: "Filter the result based on ad created date."
  423.         required: false
  424.         type: "string"
  425.       - name: "ads.created.after"
  426.         in: "query"
  427.         description: "Filter the result based on ad created date."
  428.         required: false
  429.         type: "string"
  430.       - name: "goal.id"
  431.         in: "query"
  432.         description: "Filter the result based on goal id."
  433.         required: false
  434.         type: "string"
  435.         format: "uuid"
  436.       - name: "pageSize"
  437.         in: "query"
  438.         description: "The number of entries to return in one page."
  439.         required: false
  440.         type: "integer"
  441.         format: "int32"
  442.       - name: "pageNumber"
  443.         in: "query"
  444.         description: "The page number"
  445.         required: false
  446.         type: "integer"
  447.         format: "int32"
  448.       responses:
  449.         200:
  450.           description: "OK"
  451.           schema:
  452.             $ref: "#/definitions/Ads"
  453.         404:
  454.           description: "Not Found"
  455.         500:
  456.           description: "Internal Server Error"
  457.       security:
  458.       - OAuth 2.0: []
  459.       - apiKey: []
  460.   /v3/ads/{adId}:
  461.     get:
  462.       tags:
  463.      - "Ads"
  464.       summary: "Get Ad by Id"
  465.       description: ""
  466.       operationId: "getAdByAdId"
  467.       consumes:
  468.      - "application/json"
  469.       produces:
  470.      - "application/json"
  471.       parameters:
  472.       - name: "adId"
  473.         in: "path"
  474.         required: true
  475.         type: "string"
  476.         format: "uuid"
  477.       - name: "embed"
  478.         in: "query"
  479.         description: "Embed additional information about objects. Note that projections\
  480.          \ is only available for goals."
  481.         required: false
  482.         type: "array"
  483.         items:
  484.           type: "string"
  485.           enum:
  486.          - "projections"
  487.           - "metrics"
  488.         collectionFormat: "multi"
  489.         enum:
  490.        - "projections"
  491.         - "metrics"
  492.       - name: "metrics"
  493.         in: "query"
  494.         description: "Specify which metrics to return."
  495.         required: false
  496.         type: "array"
  497.         items:
  498.           type: "string"
  499.         collectionFormat: "multi"
  500.         enum:
  501.        - "impression"
  502.         - "clickThrough"
  503.         - "start"
  504.         - "complete"
  505.         - "firstQuartile"
  506.         - "midpoint"
  507.         - "thirdQuartile"
  508.         - "all"
  509.       responses:
  510.         200:
  511.           description: "OK"
  512.           schema:
  513.             $ref: "#/definitions/Ad"
  514.         404:
  515.           description: "Not Found"
  516.         500:
  517.           description: "Internal Server Error"
  518.       security:
  519.       - OAuth 2.0: []
  520.       - apiKey: []
  521.   /v3/ads/{adId}/vasturl/category/{id}:
  522.     get:
  523.       tags:
  524.      - "VAST URLs"
  525.       summary: "Get VAST URLs by Ad and Category."
  526.       description: ""
  527.       operationId: "getVastUrlByAdIdAndCategory"
  528.       consumes:
  529.      - "application/json"
  530.       produces:
  531.      - "application/json"
  532.       parameters:
  533.       - name: "adId"
  534.         in: "path"
  535.         required: true
  536.         type: "string"
  537.         format: "uuid"
  538.       - name: "id"
  539.         in: "path"
  540.         required: true
  541.         type: "string"
  542.         format: "uuid"
  543.       - name: "rt"
  544.         in: "query"
  545.         description: "The format of the response ticket."
  546.         required: false
  547.         type: "string"
  548.         default: "vast_3.0"
  549.         enum:
  550.        - "VAST_2_0"
  551.         - "VAST_2_0_1"
  552.         - "VAST_3_0"
  553.         - "VMAP_1_0"
  554.       responses:
  555.         200:
  556.           description: "OK"
  557.           schema:
  558.             $ref: "#/definitions/VastUrl"
  559.         404:
  560.           description: "Not Found"
  561.         412:
  562.           description: "Precondition Failed"
  563.         500:
  564.           description: "Internal Server Error"
  565.       security:
  566.       - OAuth 2.0: []
  567.       - apiKey: []
  568.   /v3/ads/{adId}/vasturl/content-partner/{id}:
  569.     get:
  570.       tags:
  571.      - "VAST URLs"
  572.       summary: "Get VAST URLs by Ad and Content Partner."
  573.       description: ""
  574.       operationId: "getVastUrlByAdIdAndContentPartner"
  575.       consumes:
  576.      - "application/json"
  577.       produces:
  578.      - "application/json"
  579.       parameters:
  580.       - name: "adId"
  581.         in: "path"
  582.         required: true
  583.         type: "string"
  584.         format: "uuid"
  585.       - name: "id"
  586.         in: "path"
  587.         required: true
  588.         type: "string"
  589.         format: "uuid"
  590.       - name: "rt"
  591.         in: "query"
  592.         description: "The format of the response ticket."
  593.         required: false
  594.         type: "string"
  595.         default: "vast_3.0"
  596.         enum:
  597.        - "VAST_2_0"
  598.         - "VAST_2_0_1"
  599.         - "VAST_3_0"
  600.         - "VMAP_1_0"
  601.       responses:
  602.         200:
  603.           description: "OK"
  604.           schema:
  605.             $ref: "#/definitions/VastUrl"
  606.         404:
  607.           description: "Not Found"
  608.         412:
  609.           description: "Precondition Failed"
  610.         500:
  611.           description: "Internal Server Error"
  612.       security:
  613.       - OAuth 2.0: []
  614.       - apiKey: []
  615.   /v3/banner-areas:
  616.     get:
  617.       tags:
  618.      - "Banner Areas"
  619.       summary: "List Banner Areas"
  620.       description: ""
  621.       operationId: "getBannerAreas"
  622.       produces:
  623.      - "application/json"
  624.       parameters: []
  625.       responses:
  626.         200:
  627.           description: "OK"
  628.           schema:
  629.             type: "array"
  630.             items:
  631.               $ref: "#/definitions/BannerArea"
  632.         400:
  633.           description: "Bad Request"
  634.           schema:
  635.             $ref: "#/definitions/ErrorDetail"
  636.         500:
  637.           description: "Internal Server Error"
  638.       security:
  639.       - OAuth 2.0: []
  640.       - apiKey: []
  641.   /v3/banner-areas/{id}:
  642.     get:
  643.       tags:
  644.      - "Banner Areas"
  645.       summary: "Get Banner Area by Id"
  646.       description: ""
  647.       operationId: "getBannerAreaById"
  648.       produces:
  649.      - "application/json"
  650.       parameters:
  651.       - name: "id"
  652.         in: "path"
  653.         required: true
  654.         type: "string"
  655.         format: "uuid"
  656.       responses:
  657.         200:
  658.           description: "OK"
  659.           schema:
  660.             $ref: "#/definitions/BannerArea"
  661.         400:
  662.           description: "Bad Request"
  663.           schema:
  664.             $ref: "#/definitions/ErrorDetail"
  665.         404:
  666.           description: "Not Found"
  667.         500:
  668.           description: "Internal Server Error"
  669.       security:
  670.       - OAuth 2.0: []
  671.       - apiKey: []
  672.   /v3/campaigns:
  673.     get:
  674.       tags:
  675.      - "Campaigns"
  676.       summary: "List Campaigns"
  677.       description: ""
  678.       operationId: "getCampaigns"
  679.       consumes:
  680.      - "application/json"
  681.       produces:
  682.      - "application/json"
  683.       parameters:
  684.       - name: "includeDeletedGoals"
  685.         in: "query"
  686.         description: "Indicates whether the API should include deleted goals in the\
  687.          \ resulting campaign(s)."
  688.         required: false
  689.         type: "string"
  690.         enum:
  691.        - "PRESENT"
  692.         - "ABSENT"
  693.       - name: "includeDeletedCampaigns"
  694.         in: "query"
  695.         required: false
  696.         type: "string"
  697.         enum:
  698.        - "PRESENT"
  699.         - "ABSENT"
  700.       - name: "campaigns.started.before"
  701.         in: "query"
  702.         description: "Filter the result based on campaign start time."
  703.         required: false
  704.         type: "string"
  705.       - name: "campaigns.started.after"
  706.         in: "query"
  707.         description: "Filter the result based on campaign start time."
  708.         required: false
  709.         type: "string"
  710.       - name: "campaigns.ended.before"
  711.         in: "query"
  712.         description: "Filter the result based on campaign end time."
  713.         required: false
  714.         type: "string"
  715.       - name: "campaigns.ended.after"
  716.         in: "query"
  717.         description: "Filter the result based on campaign end time."
  718.         required: false
  719.         type: "string"
  720.       - name: "campaign.state"
  721.         in: "query"
  722.         description: "Filter the result based on campaign state."
  723.         required: false
  724.         type: "array"
  725.         items:
  726.           type: "string"
  727.           enum:
  728.          - "ENABLED"
  729.           - "DISABLED"
  730.           - "ARCHIVED"
  731.         collectionFormat: "multi"
  732.         enum:
  733.        - "enabled"
  734.         - "disabled"
  735.         - "archived"
  736.       - name: "ids"
  737.         in: "query"
  738.         required: false
  739.         type: "array"
  740.         items:
  741.           type: "string"
  742.           format: "uuid"
  743.         collectionFormat: "multi"
  744.       - name: "pageSize"
  745.         in: "query"
  746.         description: "The number of entries to return in one page."
  747.         required: false
  748.         type: "integer"
  749.         format: "int32"
  750.       - name: "pageNumber"
  751.         in: "query"
  752.         description: "The page number"
  753.         required: false
  754.         type: "integer"
  755.         format: "int32"
  756.       - name: "embed"
  757.         in: "query"
  758.         description: "Embed additional information about objects. Note that projections\
  759.          \ is only available for goals."
  760.         required: false
  761.         type: "array"
  762.         items:
  763.           type: "string"
  764.           enum:
  765.          - "projections"
  766.           - "metrics"
  767.         collectionFormat: "multi"
  768.         enum:
  769.        - "projections"
  770.         - "metrics"
  771.       - name: "metrics"
  772.         in: "query"
  773.         description: "Specify which metrics to return."
  774.         required: false
  775.         type: "array"
  776.         items:
  777.           type: "string"
  778.         collectionFormat: "multi"
  779.         enum:
  780.        - "impression"
  781.         - "clickThrough"
  782.         - "start"
  783.         - "complete"
  784.         - "firstQuartile"
  785.         - "midpoint"
  786.         - "thirdQuartile"
  787.         - "all"
  788.       - name: "expand"
  789.         in: "query"
  790.         description: "Adding &expand=goals or &expand=ads will expand goals in campaigns\
  791.          \ and ads in goals. If these are not supplied, links to the expandable objects\
  792.          \ are returned"
  793.         required: false
  794.         type: "array"
  795.         items:
  796.           type: "string"
  797.           enum:
  798.          - "goals"
  799.           - "ads"
  800.         collectionFormat: "multi"
  801.       responses:
  802.         200:
  803.           description: "OK"
  804.           schema:
  805.             $ref: "#/definitions/Campaigns"
  806.         400:
  807.           description: "Bad Request"
  808.           schema:
  809.             $ref: "#/definitions/ErrorDetail"
  810.         404:
  811.           description: "Not Found"
  812.         500:
  813.           description: "Internal Server Error"
  814.       security:
  815.       - OAuth 2.0: []
  816.       - apiKey: []
  817.   /v3/campaigns/{campaignId}:
  818.     get:
  819.       tags:
  820.      - "Campaigns"
  821.       summary: "Get Campaign by Id"
  822.       description: ""
  823.       operationId: "getCampaignBySiteAndCampaignId"
  824.       consumes:
  825.      - "application/json"
  826.       produces:
  827.      - "application/json"
  828.       parameters:
  829.       - name: "campaignId"
  830.         in: "path"
  831.         required: true
  832.         type: "string"
  833.         format: "uuid"
  834.       - name: "includeDeletedGoals"
  835.         in: "query"
  836.         description: "Indicates whether the API should include deleted goals in the\
  837.          \ resulting campaign(s)."
  838.         required: false
  839.         type: "string"
  840.         enum:
  841.        - "PRESENT"
  842.         - "ABSENT"
  843.       - name: "embed"
  844.         in: "query"
  845.         description: "Embed additional information about objects. Note that projections\
  846.          \ is only available for goals."
  847.         required: false
  848.         type: "array"
  849.         items:
  850.           type: "string"
  851.           enum:
  852.          - "projections"
  853.           - "metrics"
  854.         collectionFormat: "multi"
  855.         enum:
  856.        - "projections"
  857.         - "metrics"
  858.       - name: "metrics"
  859.         in: "query"
  860.         description: "Specify which metrics to return."
  861.         required: false
  862.         type: "array"
  863.         items:
  864.           type: "string"
  865.         collectionFormat: "multi"
  866.         enum:
  867.        - "impression"
  868.         - "clickThrough"
  869.         - "start"
  870.         - "complete"
  871.         - "firstQuartile"
  872.         - "midpoint"
  873.         - "thirdQuartile"
  874.         - "all"
  875.       - name: "expand"
  876.         in: "query"
  877.         description: "Adding &expand=goals or &expand=ads will expand goals in campaigns\
  878.          \ and ads in goals. If these are not supplied, links to the expandable objects\
  879.          \ are returned"
  880.         required: false
  881.         type: "array"
  882.         items:
  883.           type: "string"
  884.           enum:
  885.          - "goals"
  886.           - "ads"
  887.         collectionFormat: "multi"
  888.       responses:
  889.         200:
  890.           description: "OK"
  891.           schema:
  892.             $ref: "#/definitions/Campaign"
  893.         400:
  894.           description: "Bad Request"
  895.           schema:
  896.             $ref: "#/definitions/ErrorDetail"
  897.         404:
  898.           description: "Not Found"
  899.         500:
  900.           description: "Internal Server Error"
  901.       security:
  902.       - OAuth 2.0: []
  903.       - apiKey: []
  904.   /v3/campaigns/{campaignId}/vasturl/category/{id}:
  905.     get:
  906.       tags:
  907.      - "VAST URLs"
  908.       summary: "Get VAST URLs by Campaign and Category."
  909.       description: ""
  910.       operationId: "getVastUrlsByCampaignIdAndCategory"
  911.       consumes:
  912.      - "application/json"
  913.       produces:
  914.      - "application/json"
  915.       parameters:
  916.       - name: "campaignId"
  917.         in: "path"
  918.         required: true
  919.         type: "string"
  920.         format: "uuid"
  921.       - name: "id"
  922.         in: "path"
  923.         required: true
  924.         type: "string"
  925.         format: "uuid"
  926.       - name: "rt"
  927.         in: "query"
  928.         description: "The format of the response ticket."
  929.         required: false
  930.         type: "string"
  931.         default: "vast_3.0"
  932.         enum:
  933.        - "VAST_2_0"
  934.         - "VAST_2_0_1"
  935.         - "VAST_3_0"
  936.         - "VMAP_1_0"
  937.       responses:
  938.         200:
  939.           description: "OK"
  940.           schema:
  941.             type: "array"
  942.             items:
  943.               $ref: "#/definitions/VastUrl"
  944.         404:
  945.           description: "Not Found"
  946.         412:
  947.           description: "Precondition Failed"
  948.         500:
  949.           description: "Internal Server Error"
  950.       security:
  951.       - OAuth 2.0: []
  952.       - apiKey: []
  953.   /v3/campaigns/{campaignId}/vasturl/content-partner/{id}:
  954.     get:
  955.       tags:
  956.      - "VAST URLs"
  957.       summary: "Get VAST URLs by Campaign and Content Partner."
  958.       description: ""
  959.       operationId: "getVastUrlsByCampaignIdAndContentPartner"
  960.       consumes:
  961.      - "application/json"
  962.       produces:
  963.      - "application/json"
  964.       parameters:
  965.       - name: "campaignId"
  966.         in: "path"
  967.         required: true
  968.         type: "string"
  969.         format: "uuid"
  970.       - name: "id"
  971.         in: "path"
  972.         required: true
  973.         type: "string"
  974.         format: "uuid"
  975.       - name: "rt"
  976.         in: "query"
  977.         description: "The format of the response ticket."
  978.         required: false
  979.         type: "string"
  980.         default: "vast_3.0"
  981.         enum:
  982.        - "VAST_2_0"
  983.         - "VAST_2_0_1"
  984.         - "VAST_3_0"
  985.         - "VMAP_1_0"
  986.       responses:
  987.         200:
  988.           description: "OK"
  989.           schema:
  990.             type: "array"
  991.             items:
  992.               $ref: "#/definitions/VastUrl"
  993.         404:
  994.           description: "Not Found"
  995.         412:
  996.           description: "Precondition Failed"
  997.         500:
  998.           description: "Internal Server Error"
  999.       security:
  1000.       - OAuth 2.0: []
  1001.       - apiKey: []
  1002.   /v3/goals:
  1003.     get:
  1004.       tags:
  1005.      - "Goals"
  1006.       summary: "List Goals"
  1007.       description: ""
  1008.       operationId: "getGoalsForSite"
  1009.       consumes:
  1010.      - "application/json"
  1011.       produces:
  1012.      - "application/json"
  1013.       parameters:
  1014.       - name: "goals.started.before"
  1015.         in: "query"
  1016.         description: "Filter the result based on goal start time."
  1017.         required: false
  1018.         type: "string"
  1019.       - name: "goals.started.after"
  1020.         in: "query"
  1021.         description: "Filter the result based on goal start time."
  1022.         required: false
  1023.         type: "string"
  1024.       - name: "goals.ended.before"
  1025.         in: "query"
  1026.         description: "Filter the result based on goal end time."
  1027.         required: false
  1028.         type: "string"
  1029.       - name: "goals.ended.after"
  1030.         in: "query"
  1031.         description: "Filter the result based on goal end time."
  1032.         required: false
  1033.         type: "string"
  1034.       - name: "goal.name"
  1035.         in: "query"
  1036.         description: "Filter the result based on goal name."
  1037.         required: false
  1038.         type: "string"
  1039.       - name: "campaign.name"
  1040.         in: "query"
  1041.         description: "Filter the result based on campaign name."
  1042.         required: false
  1043.         type: "string"
  1044.       - name: "campaign.id"
  1045.         in: "query"
  1046.         description: "Filter the result based on campaign id."
  1047.         required: false
  1048.         type: "string"
  1049.         format: "uuid"
  1050.       - in: "body"
  1051.         name: "body"
  1052.         required: false
  1053.         schema:
  1054.           $ref: "#/definitions/GoalFlags"
  1055.       - name: "campaign.state"
  1056.         in: "query"
  1057.         description: "Filter the result based on campaign state."
  1058.         required: false
  1059.         type: "array"
  1060.         items:
  1061.           type: "string"
  1062.           enum:
  1063.          - "enabled"
  1064.           - "disabled"
  1065.           - "archived"
  1066.         collectionFormat: "multi"
  1067.       - name: "pageSize"
  1068.         in: "query"
  1069.         description: "The number of entries to return in one page."
  1070.         required: false
  1071.         type: "integer"
  1072.         format: "int32"
  1073.       - name: "pageNumber"
  1074.         in: "query"
  1075.         description: "The page number"
  1076.         required: false
  1077.         type: "integer"
  1078.         format: "int32"
  1079.       - name: "sorting"
  1080.         in: "query"
  1081.         description: "If this is present, the goals will be sorted based on given\
  1082.          \ value."
  1083.         required: false
  1084.         type: "string"
  1085.         enum:
  1086.        - "priority"
  1087.         - "type"
  1088.         - "booked"
  1089.         - "start"
  1090.         - "end"
  1091.         - "goalName"
  1092.         - "campaignName"
  1093.       - name: "sortingOrder"
  1094.         in: "query"
  1095.         description: "Specifies the sorting order: ascending or descending."
  1096.         required: false
  1097.         type: "string"
  1098.         default: "ascending"
  1099.         enum:
  1100.        - "ascending"
  1101.         - "descending"
  1102.       - name: "embed"
  1103.         in: "query"
  1104.         description: "Embed additional information about objects. Note that projections\
  1105.          \ is only available for goals."
  1106.         required: false
  1107.         type: "array"
  1108.         items:
  1109.           type: "string"
  1110.           enum:
  1111.          - "projections"
  1112.           - "metrics"
  1113.         collectionFormat: "multi"
  1114.         enum:
  1115.        - "projections"
  1116.         - "metrics"
  1117.       - name: "metrics"
  1118.         in: "query"
  1119.         description: "Specify which metrics to return."
  1120.         required: false
  1121.         type: "array"
  1122.         items:
  1123.           type: "string"
  1124.         collectionFormat: "multi"
  1125.         enum:
  1126.        - "impression"
  1127.         - "clickThrough"
  1128.         - "start"
  1129.         - "complete"
  1130.         - "firstQuartile"
  1131.         - "midpoint"
  1132.         - "thirdQuartile"
  1133.         - "all"
  1134.       responses:
  1135.         200:
  1136.           description: "OK"
  1137.           schema:
  1138.             $ref: "#/definitions/GoalList"
  1139.         400:
  1140.           description: "Bad Request"
  1141.           schema:
  1142.             $ref: "#/definitions/ErrorDetail"
  1143.         404:
  1144.           description: "Not Found"
  1145.         500:
  1146.           description: "Internal Server Error"
  1147.       security:
  1148.       - OAuth 2.0: []
  1149.       - apiKey: []
  1150.   /v3/goals/{goalId}:
  1151.     get:
  1152.       tags:
  1153.      - "Goals"
  1154.       summary: "Get Goal by Id"
  1155.       description: ""
  1156.       operationId: "getGoalBySiteAndGoalId"
  1157.       consumes:
  1158.      - "application/json"
  1159.       produces:
  1160.      - "application/json"
  1161.       parameters:
  1162.       - name: "goalId"
  1163.         in: "path"
  1164.         required: true
  1165.         type: "string"
  1166.         format: "uuid"
  1167.       - in: "body"
  1168.         name: "body"
  1169.         required: false
  1170.         schema:
  1171.           $ref: "#/definitions/GoalFlags"
  1172.       - name: "embed"
  1173.         in: "query"
  1174.         description: "Embed additional information about objects. Note that projections\
  1175.          \ is only available for goals."
  1176.         required: false
  1177.         type: "array"
  1178.         items:
  1179.           type: "string"
  1180.           enum:
  1181.          - "projections"
  1182.           - "metrics"
  1183.         collectionFormat: "multi"
  1184.         enum:
  1185.        - "projections"
  1186.         - "metrics"
  1187.       - name: "metrics"
  1188.         in: "query"
  1189.         description: "Specify which metrics to return."
  1190.         required: false
  1191.         type: "array"
  1192.         items:
  1193.           type: "string"
  1194.         collectionFormat: "multi"
  1195.         enum:
  1196.        - "impression"
  1197.         - "clickThrough"
  1198.         - "start"
  1199.         - "complete"
  1200.         - "firstQuartile"
  1201.         - "midpoint"
  1202.         - "thirdQuartile"
  1203.         - "all"
  1204.       responses:
  1205.         200:
  1206.           description: "OK"
  1207.           schema:
  1208.             $ref: "#/definitions/Goal"
  1209.         400:
  1210.           description: "Bad Request"
  1211.           schema:
  1212.             $ref: "#/definitions/ErrorDetail"
  1213.         404:
  1214.           description: "Not Found"
  1215.         500:
  1216.           description: "Internal Server Error"
  1217.       security:
  1218.       - OAuth 2.0: []
  1219.       - apiKey: []
  1220.   /v3/goals/{goalId}/vasturl/category/{id}:
  1221.     get:
  1222.       tags:
  1223.      - "VAST URLs"
  1224.       summary: "Get VAST URLs by Goal and Category."
  1225.       description: ""
  1226.       operationId: "getVastUrlsByGoalIdAndCategory"
  1227.       consumes:
  1228.      - "application/json"
  1229.       produces:
  1230.      - "application/json"
  1231.       parameters:
  1232.       - name: "goalId"
  1233.         in: "path"
  1234.         required: true
  1235.         type: "string"
  1236.         format: "uuid"
  1237.       - name: "id"
  1238.         in: "path"
  1239.         required: true
  1240.         type: "string"
  1241.         format: "uuid"
  1242.       - name: "rt"
  1243.         in: "query"
  1244.         description: "The format of the response ticket."
  1245.         required: false
  1246.         type: "string"
  1247.         default: "vast_3.0"
  1248.         enum:
  1249.        - "VAST_2_0"
  1250.         - "VAST_2_0_1"
  1251.         - "VAST_3_0"
  1252.         - "VMAP_1_0"
  1253.       responses:
  1254.         200:
  1255.           description: "OK"
  1256.           schema:
  1257.             type: "array"
  1258.             items:
  1259.               $ref: "#/definitions/VastUrl"
  1260.         404:
  1261.           description: "Not Found"
  1262.         412:
  1263.           description: "Precondition Failed"
  1264.         500:
  1265.           description: "Internal Server Error"
  1266.       security:
  1267.       - OAuth 2.0: []
  1268.       - apiKey: []
  1269.   /v3/goals/{goalId}/vasturl/content-partner/{id}:
  1270.     get:
  1271.       tags:
  1272.      - "VAST URLs"
  1273.       summary: "Get VAST URLs by Goal and Content Partner"
  1274.       description: ""
  1275.       operationId: "getVastUrlsByGoalIdAndContentPartner"
  1276.       consumes:
  1277.      - "application/json"
  1278.       produces:
  1279.      - "application/json"
  1280.       parameters:
  1281.       - name: "goalId"
  1282.         in: "path"
  1283.         required: true
  1284.         type: "string"
  1285.         format: "uuid"
  1286.       - name: "id"
  1287.         in: "path"
  1288.         required: true
  1289.         type: "string"
  1290.         format: "uuid"
  1291.       - name: "rt"
  1292.         in: "query"
  1293.         description: "The format of the response ticket."
  1294.         required: false
  1295.         type: "string"
  1296.         default: "vast_3.0"
  1297.         enum:
  1298.        - "VAST_2_0"
  1299.         - "VAST_2_0_1"
  1300.         - "VAST_3_0"
  1301.         - "VMAP_1_0"
  1302.       responses:
  1303.         200:
  1304.           description: "OK"
  1305.           schema:
  1306.             type: "array"
  1307.             items:
  1308.               $ref: "#/definitions/VastUrl"
  1309.         404:
  1310.           description: "Not Found"
  1311.         412:
  1312.           description: "Precondition Failed"
  1313.         500:
  1314.           description: "Internal Server Error"
  1315.       security:
  1316.       - OAuth 2.0: []
  1317.       - apiKey: []
  1318. definitions:
  1319.   AbstractGoal:
  1320.     type: "object"
  1321.     properties:
  1322.       id:
  1323.         type: "string"
  1324.         format: "uuid"
  1325.     description: "AbstractGoal can be either GoalLink or Goal (with detail information\
  1326.      \ as queried)."
  1327.   Ad:
  1328.     type: "object"
  1329.     properties:
  1330.       id:
  1331.         type: "string"
  1332.         format: "uuid"
  1333.         example: "0a6dc27d-06d9-41aa-b360-ff279b7e316a"
  1334.       name:
  1335.         type: "string"
  1336.         example: "Ad name"
  1337.         minLength: 0
  1338.         maxLength: 250
  1339.       creative:
  1340.         $ref: "#/definitions/Creative"
  1341.       enabled:
  1342.         type: "boolean"
  1343.       campaign:
  1344.         description: "Id of the campaign this ad belongs to and a reference to the\
  1345.          \ campaign API."
  1346.         $ref: "#/definitions/Link"
  1347.       goal:
  1348.         description: "The id of the goal this ad belongs to and reference to the goal\
  1349.          \ API."
  1350.         $ref: "#/definitions/Link"
  1351.       metrics:
  1352.         $ref: "#/definitions/Metrics"
  1353.       description:
  1354.         type: "string"
  1355.       weight:
  1356.         $ref: "#/definitions/Weight"
  1357.       customId:
  1358.         type: "string"
  1359.       start:
  1360.         description: "The start date-time of this ad in ISO 8601 format (for instance\
  1361.          \ 2016-04-02T10:05:23+01:00). Value is fetched from goal if empty."
  1362.         $ref: "#/definitions/InheritedValueZonedDateTime"
  1363.       end:
  1364.         description: "The end date-time of this ad in ISO 8601 format (for instance\
  1365.          \ 2016-04-02T10:05:23+01:00). Value is fetched from goal, if empty, or omitted\
  1366.          \ if goal has no end date."
  1367.         $ref: "#/definitions/InheritedValueZonedDateTime"
  1368.       externalTrackers:
  1369.         type: "array"
  1370.         items:
  1371.           $ref: "#/definitions/ExternalTracker"
  1372.       deviceContainers:
  1373.         type: "array"
  1374.         description: "List of device groups targeted by the ad."
  1375.         items:
  1376.           $ref: "#/definitions/Link"
  1377.       created:
  1378.         type: "string"
  1379.         format: "date-time"
  1380.         example: "2016-04-01T10:05:23+01:00"
  1381.         description: "The created date-time of this ad in ISO 8601 format."
  1382.       modified:
  1383.         type: "string"
  1384.         format: "date-time"
  1385.         example: "2016-04-01T10:05:23+01:00"
  1386.         description: "The last modification date-time of this ad in ISO 8601 format."
  1387.     description: "The public representation of an Ad."
  1388.   Ads:
  1389.     type: "object"
  1390.     properties:
  1391.       ads:
  1392.         type: "array"
  1393.         readOnly: true
  1394.         items:
  1395.           $ref: "#/definitions/Ad"
  1396.       pagination:
  1397.         readOnly: true
  1398.         $ref: "#/definitions/Pagination"
  1399.   AdsWrapper:
  1400.     type: "object"
  1401.     description: "AdsWrapper can be either list of AdLinks or list of Ads according\
  1402.      \ to supplied 'expand' parameter value."
  1403.   BannerArea:
  1404.     type: "object"
  1405.     properties:
  1406.       id:
  1407.         type: "string"
  1408.         format: "uuid"
  1409.       description:
  1410.         type: "string"
  1411.       type:
  1412.         type: "string"
  1413.         enum:
  1414.        - "companionBannerJavascript"
  1415.         - "companionBannerFlash"
  1416.       name:
  1417.         type: "string"
  1418.       height:
  1419.         type: "integer"
  1420.         format: "int32"
  1421.       width:
  1422.         type: "integer"
  1423.         format: "int32"
  1424.   Campaign:
  1425.     type: "object"
  1426.     required:
  1427.    - "id"
  1428.     - "name"
  1429.     properties:
  1430.       name:
  1431.         type: "string"
  1432.         description: "The name of this campaign."
  1433.       priority:
  1434.         $ref: "#/definitions/InheritedValueInteger"
  1435.       id:
  1436.         type: "string"
  1437.         format: "uuid"
  1438.         description: "The unique id of this campaign."
  1439.       state:
  1440.         type: "string"
  1441.         description: "State can be [DISABLED, ENABLED, ARCHIVED, DELETED]."
  1442.         enum:
  1443.        - "DISABLED"
  1444.         - "ENABLED"
  1445.         - "ARCHIVED"
  1446.       goals:
  1447.         type: "array"
  1448.         items:
  1449.           $ref: "#/definitions/AbstractGoal"
  1450.       description:
  1451.         type: "string"
  1452.         description: "An optional String describing the campaign."
  1453.       end:
  1454.         type: "string"
  1455.         format: "date-time"
  1456.         description: "End date is equal to the end date of the last goal within this\
  1457.          \ campaign."
  1458.       metrics:
  1459.         $ref: "#/definitions/Metrics"
  1460.       agency:
  1461.         $ref: "#/definitions/Link"
  1462.       brand:
  1463.         $ref: "#/definitions/Link"
  1464.       advertiser:
  1465.         $ref: "#/definitions/Link"
  1466.       ignoreGlobalExternalTrackers:
  1467.         type: "boolean"
  1468.         description: "Whether this campaign should ignore global external trackers."
  1469.       includedInForecast:
  1470.         type: "boolean"
  1471.         description: "Indicate whether campaign is included in forecast."
  1472.       exclusive:
  1473.         type: "boolean"
  1474.         description: "Indicate whether campaign is exclusive."
  1475.       deleted:
  1476.         type: "boolean"
  1477.       frontLoad:
  1478.         $ref: "#/definitions/InheritedValueInteger"
  1479.       sequenceScope:
  1480.         type: "string"
  1481.         enum:
  1482.        - "SESSION"
  1483.         - "LIFETIME"
  1484.       start:
  1485.         type: "string"
  1486.         format: "date-time"
  1487.         description: "Start date is equal to the start date of the earliest goal within\
  1488.          \ this campaign."
  1489.       customId:
  1490.         type: "string"
  1491.         description: "An optional custom id for this campaign."
  1492.   Campaigns:
  1493.     type: "object"
  1494.     properties:
  1495.       campaigns:
  1496.         type: "array"
  1497.         readOnly: true
  1498.         items:
  1499.           $ref: "#/definitions/Campaign"
  1500.       pagination:
  1501.         readOnly: true
  1502.         $ref: "#/definitions/Pagination"
  1503.   Cap:
  1504.     type: "object"
  1505.     properties:
  1506.       capType:
  1507.         type: "string"
  1508.         enum:
  1509.        - "dailycap"
  1510.         - "totalcap"
  1511.       capValue:
  1512.         type: "integer"
  1513.         format: "int64"
  1514.   Category:
  1515.     type: "object"
  1516.     properties:
  1517.       id:
  1518.         type: "string"
  1519.         format: "uuid"
  1520.         readOnly: true
  1521.       description:
  1522.         type: "string"
  1523.         readOnly: true
  1524.       name:
  1525.         type: "string"
  1526.         readOnly: true
  1527.       parent:
  1528.         type: "string"
  1529.         format: "uuid"
  1530.         readOnly: true
  1531.       visible:
  1532.         type: "boolean"
  1533.         readOnly: true
  1534.       shareGroup:
  1535.         type: "string"
  1536.         format: "uuid"
  1537.         readOnly: true
  1538.       parentTrail:
  1539.         type: "array"
  1540.         readOnly: true
  1541.         items:
  1542.           $ref: "#/definitions/PairUUIDString"
  1543.       enabled:
  1544.         type: "boolean"
  1545.         readOnly: true
  1546.   Client:
  1547.     type: "object"
  1548.     properties:
  1549.       id:
  1550.         type: "string"
  1551.         format: "uuid"
  1552.         readOnly: true
  1553.       type:
  1554.         type: "string"
  1555.         readOnly: true
  1556.         enum:
  1557.        - "ADVERTISER"
  1558.         - "AGENCY"
  1559.         - "BRAND"
  1560.       created:
  1561.         type: "string"
  1562.         format: "date-time"
  1563.         readOnly: true
  1564.       modified:
  1565.         type: "string"
  1566.         format: "date-time"
  1567.         readOnly: true
  1568.       name:
  1569.         type: "string"
  1570.         readOnly: true
  1571.   CompanionBanner:
  1572.     allOf:
  1573.     - $ref: "#/definitions/Creative"
  1574.     - type: "object"
  1575.       required:
  1576.      - "asset"
  1577.       properties:
  1578.         bannerArea:
  1579.           $ref: "#/definitions/Link"
  1580.         asset:
  1581.           $ref: "#/definitions/Link"
  1582.         clickDestinationUri:
  1583.           type: "string"
  1584.           example: "http://click-destination-uri.com"
  1585.         template:
  1586.           type: "string"
  1587.           example: "<a href='{clickurl}{urlenc(ad.linkurl)}'><img src='{ad.banner}'\
  1588.            \ width='{zone.width}' height='{zone.height}' border='0' /></a>"
  1589.         type:
  1590.           type: "string"
  1591.           example: "companionBanner"
  1592.           readOnly: true
  1593.           enum:
  1594.          - "companionBanner"
  1595.   CompanionBannerThirdparty:
  1596.     allOf:
  1597.     - $ref: "#/definitions/Creative"
  1598.     - type: "object"
  1599.       properties:
  1600.         bannerArea:
  1601.           $ref: "#/definitions/Link"
  1602.         template:
  1603.           type: "string"
  1604.           example: "<a href='{clickurl}{urlenc(ad.linkurl)}'><img src='{ad.banner}'\
  1605.            \ width='{zone.width}' height='{zone.height}' border='0' /></a>"
  1606.         type:
  1607.           type: "string"
  1608.           example: "companionBannerThirdparty"
  1609.           readOnly: true
  1610.           enum:
  1611.          - "companionBannerThirdparty"
  1612.   Creative:
  1613.     type: "object"
  1614.     discriminator: "type"
  1615.     properties:
  1616.       type:
  1617.         type: "string"
  1618.         example: "standardPlaceholder"
  1619.         readOnly: true
  1620.         enum:
  1621.        - "standard"
  1622.         - "standardThirdparty"
  1623.         - "iptv"
  1624.         - "iptvPlaceholder"
  1625.         - "pause"
  1626.         - "overlay"
  1627.         - "companionBanner"
  1628.         - "companionBannerThirdparty"
  1629.         - "standardPlaceholder"
  1630.         - "overlayPlaceholder"
  1631.         - "pausePlaceholder"
  1632.         - "takeover"
  1633.         - "takeoverPlaceholder"
  1634.         - "takeoverThirdparty"
  1635.         - "pixeltracker"
  1636.         - "rtb"
  1637.         - "rtbPlaceholder"
  1638.         - "placeholder1"
  1639.         - "placeholder1Thirdparty"
  1640.         - "placeholder1Placeholder"
  1641.         - "unknown"
  1642.   DeviceContainer:
  1643.     type: "object"
  1644.     properties:
  1645.       name:
  1646.         type: "string"
  1647.       id:
  1648.         type: "string"
  1649.         format: "uuid"
  1650.       position:
  1651.         type: "integer"
  1652.         format: "int32"
  1653.       siteId:
  1654.         type: "string"
  1655.         format: "uuid"
  1656.       shortName:
  1657.         type: "string"
  1658.       visible:
  1659.         type: "boolean"
  1660.   ErrorDetail:
  1661.     type: "object"
  1662.     properties:
  1663.       message:
  1664.         type: "string"
  1665.       invalidValue:
  1666.         type: "object"
  1667.       propertyPath:
  1668.         type: "string"
  1669.   ExpandFlags:
  1670.     type: "object"
  1671.     properties:
  1672.       expand:
  1673.         type: "array"
  1674.         items:
  1675.           type: "string"
  1676.   ExternalTracker:
  1677.     type: "object"
  1678.     properties:
  1679.       id:
  1680.         type: "string"
  1681.         format: "uuid"
  1682.         readOnly: true
  1683.       url:
  1684.         type: "string"
  1685.         readOnly: true
  1686.       event:
  1687.         type: "string"
  1688.         example: "IMPRESSION"
  1689.         readOnly: true
  1690.         enum:
  1691.        - "IMPRESSION"
  1692.         - "CLICK_THROUGH"
  1693.         - "AD_START"
  1694.         - "AD_FIRST_QUARTILE"
  1695.         - "AD_MIDPOINT"
  1696.         - "AD_THIRD_QUARTILE"
  1697.         - "AD_COMPLETE"
  1698.         - "MUTE"
  1699.         - "UNMUTE"
  1700.         - "PAUSE"
  1701.         - "REWIND"
  1702.         - "RESUME"
  1703.         - "FULLSCREEN"
  1704.         - "EXPAND"
  1705.         - "CLOSE"
  1706.   Goal:
  1707.     allOf:
  1708.     - $ref: "#/definitions/AbstractGoal"
  1709.     - type: "object"
  1710.       properties:
  1711.         name:
  1712.           type: "string"
  1713.         priority:
  1714.           $ref: "#/definitions/InheritedValueInteger"
  1715.         type:
  1716.           type: "string"
  1717.         target:
  1718.           $ref: "#/definitions/Target"
  1719.         variant:
  1720.           type: "string"
  1721.           enum:
  1722.          - "normal"
  1723.           - "sponsor"
  1724.         description:
  1725.           type: "string"
  1726.         campaign:
  1727.           $ref: "#/definitions/Link"
  1728.         end:
  1729.           type: "string"
  1730.           format: "date-time"
  1731.           description: "An ISO-8601 formatted date-time string."
  1732.         metrics:
  1733.           $ref: "#/definitions/Metrics"
  1734.         ads:
  1735.           $ref: "#/definitions/AdsWrapper"
  1736.         cap:
  1737.           $ref: "#/definitions/Cap"
  1738.         pricing:
  1739.           $ref: "#/definitions/Pricing"
  1740.         deleted:
  1741.           type: "boolean"
  1742.         adPosition:
  1743.           type: "string"
  1744.           enum:
  1745.          - "any"
  1746.           - "first"
  1747.           - "last"
  1748.           - "firstOrLast"
  1749.           - "breakExclusive"
  1750.         goalSequence:
  1751.           $ref: "#/definitions/GoalSequence"
  1752.         projectedDelivery:
  1753.           type: "integer"
  1754.           format: "int32"
  1755.         skipSettings:
  1756.           $ref: "#/definitions/InheritedValueSkipSettings"
  1757.         frontLoad:
  1758.           example: "50"
  1759.           $ref: "#/definitions/InheritedValueInteger"
  1760.         start:
  1761.           type: "string"
  1762.           format: "date-time"
  1763.           description: "An ISO-8601 formatted date-time string."
  1764.         customId:
  1765.           type: "string"
  1766.       description: "Representation of a Goal."
  1767.   GoalFlags:
  1768.     type: "object"
  1769.     properties:
  1770.       expandFlags:
  1771.         $ref: "#/definitions/ExpandFlags"
  1772.   GoalLink:
  1773.     allOf:
  1774.     - $ref: "#/definitions/AbstractGoal"
  1775.     - type: "object"
  1776.       properties:
  1777.         id:
  1778.           type: "string"
  1779.           format: "uuid"
  1780.           example: "5c4de482-b71a-4014-bfed-81df1ccfe4bd"
  1781.           description: "The id of the entity."
  1782.         href:
  1783.           type: "string"
  1784.           format: "uri"
  1785.           example: "/v1/goal/{goalId}"
  1786.           description: "The link to the API containing the entity's details."
  1787.       description: "Representation of a GoalLink, used when listing goals in a non\
  1788.        \ expanded mode."
  1789.   GoalList:
  1790.     type: "object"
  1791.     properties:
  1792.       goals:
  1793.         type: "array"
  1794.         readOnly: true
  1795.         items:
  1796.           $ref: "#/definitions/Goal"
  1797.       pagination:
  1798.         readOnly: true
  1799.         $ref: "#/definitions/Pagination"
  1800.   GoalSequence:
  1801.     type: "object"
  1802.     properties:
  1803.       sequence:
  1804.         type: "integer"
  1805.         format: "int32"
  1806.       totalAmountOfGoals:
  1807.         type: "integer"
  1808.         format: "int32"
  1809.       sequenceScope:
  1810.         type: "string"
  1811.         enum:
  1812.        - "session"
  1813.         - "lifetime"
  1814.   InheritedValue:
  1815.     type: "object"
  1816.     properties:
  1817.       value:
  1818.         type: "object"
  1819.       origin:
  1820.         description: "Indicates that a value is inherited from another entity. If\
  1821.          \ the value is not inherited this object is omitted."
  1822.         $ref: "#/definitions/Origin"
  1823.     description: "Indication of origin of value."
  1824.   InheritedValueInteger:
  1825.     type: "object"
  1826.     properties:
  1827.       value:
  1828.         type: "integer"
  1829.         format: "int32"
  1830.       origin:
  1831.         description: "Indicates that a value is inherited from another entity. If\
  1832.          \ the value is not inherited this object is omitted."
  1833.         $ref: "#/definitions/Origin"
  1834.     description: "Indication of origin of value."
  1835.   InheritedValueSkipSettings:
  1836.     type: "object"
  1837.     properties:
  1838.       value:
  1839.         $ref: "#/definitions/SkipSettings"
  1840.       origin:
  1841.         description: "Indicates that a value is inherited from another entity. If\
  1842.          \ the value is not inherited this object is omitted."
  1843.         $ref: "#/definitions/Origin"
  1844.     description: "Indication of origin of value."
  1845.   InheritedValueZonedDateTime:
  1846.     type: "object"
  1847.     properties:
  1848.       value:
  1849.         type: "string"
  1850.         format: "date-time"
  1851.       origin:
  1852.         description: "Indicates that a value is inherited from another entity. If\
  1853.          \ the value is not inherited this object is omitted."
  1854.         $ref: "#/definitions/Origin"
  1855.     description: "Indication of origin of value."
  1856.   Iptv:
  1857.     allOf:
  1858.     - $ref: "#/definitions/Creative"
  1859.     - type: "object"
  1860.       required:
  1861.      - "insertionPoint"
  1862.       - "videoCreativeId"
  1863.       properties:
  1864.         insertionPoint:
  1865.           type: "string"
  1866.           example: "preroll"
  1867.           readOnly: true
  1868.           enum:
  1869.          - "preroll"
  1870.           - "midroll"
  1871.           - "postroll"
  1872.         videoCreativeId:
  1873.           type: "string"
  1874.           readOnly: true
  1875.         clickDestinationUri:
  1876.           type: "string"
  1877.           example: "http://click-destination-uri.com"
  1878.           readOnly: true
  1879.         estimatedAdDuration:
  1880.           type: "integer"
  1881.           format: "int64"
  1882.           example: 42
  1883.           readOnly: true
  1884.         type:
  1885.           type: "string"
  1886.           example: "iptv"
  1887.           readOnly: true
  1888.           enum:
  1889.          - "iptv"
  1890.   IptvPlaceholder:
  1891.     allOf:
  1892.     - $ref: "#/definitions/Creative"
  1893.     - type: "object"
  1894.       required:
  1895.      - "insertionPoint"
  1896.       properties:
  1897.         insertionPoint:
  1898.           type: "string"
  1899.           example: "preroll"
  1900.           enum:
  1901.          - "preroll"
  1902.           - "midroll"
  1903.           - "postroll"
  1904.         type:
  1905.           type: "string"
  1906.           example: "iptvPlaceholder"
  1907.           readOnly: true
  1908.           enum:
  1909.          - "iptvPlaceholder"
  1910.   Link:
  1911.     type: "object"
  1912.     properties:
  1913.       id:
  1914.         type: "string"
  1915.         format: "uuid"
  1916.         example: "5c4de482-b71a-4014-bfed-81df1ccfe4bd"
  1917.         description: "The id of the entity."
  1918.       href:
  1919.         type: "string"
  1920.         format: "uri"
  1921.         example: "/v1/goal/{goalId}"
  1922.         description: "The link to the API containing the entity's details."
  1923.     description: "A structure containing the id of a certain entity and a link to\
  1924.      \ the API where its details can be found."
  1925.   Metrics:
  1926.     type: "object"
  1927.     properties:
  1928.       impression:
  1929.         type: "integer"
  1930.         format: "int32"
  1931.         readOnly: true
  1932.       error:
  1933.         type: "string"
  1934.         example: "Could not connect to metrics service."
  1935.         description: "If an error occurs while embedding metrics, the reason will\
  1936.          \ be displayed here."
  1937.         readOnly: true
  1938.       clickThrough:
  1939.         type: "integer"
  1940.         format: "int32"
  1941.         readOnly: true
  1942.       start:
  1943.         type: "integer"
  1944.         format: "int32"
  1945.         readOnly: true
  1946.       firstQuartile:
  1947.         type: "integer"
  1948.         format: "int32"
  1949.         readOnly: true
  1950.       midpoint:
  1951.         type: "integer"
  1952.         format: "int32"
  1953.         readOnly: true
  1954.       thirdQuartile:
  1955.         type: "integer"
  1956.         format: "int32"
  1957.         readOnly: true
  1958.       complete:
  1959.         type: "integer"
  1960.         format: "int32"
  1961.         readOnly: true
  1962.       delivered:
  1963.         type: "integer"
  1964.         format: "int32"
  1965.         readOnly: true
  1966.       ctr:
  1967.         type: "number"
  1968.         format: "double"
  1969.         readOnly: true
  1970.       completionRate:
  1971.         type: "number"
  1972.         format: "double"
  1973.         readOnly: true
  1974.       ecpm:
  1975.         type: "number"
  1976.         format: "double"
  1977.         readOnly: true
  1978.     description: "Representation of Metrics."
  1979.   Origin:
  1980.     type: "object"
  1981.     properties:
  1982.       id:
  1983.         type: "string"
  1984.         format: "uuid"
  1985.         example: "5c4de482-b71a-4014-bfed-81df1ccfe4bd"
  1986.         description: "The id of the entity."
  1987.       href:
  1988.         type: "string"
  1989.         format: "uri"
  1990.         example: "/v1/goal/{goalId}"
  1991.         description: "The link to the API containing the entity's details."
  1992.       entity:
  1993.         type: "string"
  1994.         example: "/v1/resource/{resourceId}"
  1995.         description: "The entity type containing the inherited value."
  1996.         enum:
  1997.        - "SITE"
  1998.         - "CAMPAIGN"
  1999.         - "GOAL"
  2000.         - "AD"
  2001.     description: "Representation of where a certain value is resolved from."
  2002.   Overlay:
  2003.     allOf:
  2004.     - $ref: "#/definitions/Creative"
  2005.     - type: "object"
  2006.       required:
  2007.      - "asset"
  2008.       properties:
  2009.         asset:
  2010.           $ref: "#/definitions/Link"
  2011.         clickDestinationUri:
  2012.           type: "string"
  2013.           example: "http://click-destination-uri.com"
  2014.         linkText:
  2015.           type: "string"
  2016.           example: "Click here"
  2017.         type:
  2018.           type: "string"
  2019.           example: "overlay"
  2020.           readOnly: true
  2021.           enum:
  2022.          - "overlay"
  2023.   OverlayPlaceholder:
  2024.     allOf:
  2025.     - $ref: "#/definitions/Creative"
  2026.     - type: "object"
  2027.       properties:
  2028.         type:
  2029.           type: "string"
  2030.           example: "overlayPlaceholder"
  2031.           readOnly: true
  2032.           enum:
  2033.          - "overlayPlaceholder"
  2034.   Pagination:
  2035.     type: "object"
  2036.     properties:
  2037.       totalCount:
  2038.         type: "integer"
  2039.         format: "int32"
  2040.         readOnly: true
  2041.       pageSize:
  2042.         type: "integer"
  2043.         format: "int32"
  2044.         readOnly: true
  2045.       pageNumber:
  2046.         type: "integer"
  2047.         format: "int32"
  2048.         readOnly: true
  2049.   Pair:
  2050.     type: "object"
  2051.     properties:
  2052.       value:
  2053.         type: "object"
  2054.       key:
  2055.         type: "object"
  2056.       right:
  2057.         type: "object"
  2058.       left:
  2059.         type: "object"
  2060.   PairUUIDString:
  2061.     type: "object"
  2062.     properties:
  2063.       value:
  2064.         type: "string"
  2065.       key:
  2066.         type: "string"
  2067.         format: "uuid"
  2068.       right:
  2069.         type: "string"
  2070.       left:
  2071.         type: "string"
  2072.         format: "uuid"
  2073.   Pause:
  2074.     allOf:
  2075.     - $ref: "#/definitions/Creative"
  2076.     - type: "object"
  2077.       required:
  2078.      - "asset"
  2079.       properties:
  2080.         asset:
  2081.           $ref: "#/definitions/Link"
  2082.         clickDestinationUri:
  2083.           type: "string"
  2084.           example: "http://some-url"
  2085.         type:
  2086.           type: "string"
  2087.           example: "pause"
  2088.           readOnly: true
  2089.           enum:
  2090.          - "pause"
  2091.   PausePlaceholder:
  2092.     allOf:
  2093.     - $ref: "#/definitions/Creative"
  2094.     - type: "object"
  2095.       properties:
  2096.         type:
  2097.           type: "string"
  2098.           example: "pausePlaceholder"
  2099.           readOnly: true
  2100.           enum:
  2101.          - "pausePlaceholder"
  2102.   Pixeltracker:
  2103.     allOf:
  2104.     - $ref: "#/definitions/Creative"
  2105.     - type: "object"
  2106.       required:
  2107.      - "insertionPoint"
  2108.       properties:
  2109.         insertionPoint:
  2110.           type: "string"
  2111.           example: "preroll"
  2112.           readOnly: true
  2113.           enum:
  2114.          - "preroll"
  2115.           - "midroll"
  2116.           - "postroll"
  2117.         clickDestinationUri:
  2118.           type: "string"
  2119.           example: "http://click-destination-uri.com"
  2120.           readOnly: true
  2121.         type:
  2122.           type: "string"
  2123.           example: "pixeltracker"
  2124.           readOnly: true
  2125.           enum:
  2126.          - "pixeltracker"
  2127.   Placeholder1:
  2128.     allOf:
  2129.     - $ref: "#/definitions/Creative"
  2130.     - type: "object"
  2131.       required:
  2132.      - "asset"
  2133.       properties:
  2134.         asset:
  2135.           $ref: "#/definitions/Link"
  2136.         clickDestinationUri:
  2137.           type: "string"
  2138.           example: "http://click-destination-uri.com"
  2139.         type:
  2140.           type: "string"
  2141.           example: "placeholder1"
  2142.           readOnly: true
  2143.           enum:
  2144.          - "placeholder1"
  2145.   Placeholder1Placeholder:
  2146.     allOf:
  2147.     - $ref: "#/definitions/Creative"
  2148.     - type: "object"
  2149.       properties:
  2150.         type:
  2151.           type: "string"
  2152.           example: "placeholder1Placeholder"
  2153.           readOnly: true
  2154.           enum:
  2155.          - "placeholder1Placeholder"
  2156.   Placeholder1Thirdparty:
  2157.     allOf:
  2158.     - $ref: "#/definitions/Creative"
  2159.     - type: "object"
  2160.       required:
  2161.      - "vastUri"
  2162.       properties:
  2163.         vastUri:
  2164.           type: "string"
  2165.           example: "http://vast-uri-example.com"
  2166.         vpaidStrict:
  2167.           type: "boolean"
  2168.           example: true
  2169.         vpaidCountdown:
  2170.           type: "boolean"
  2171.           example: false
  2172.         estimatedAdDuration:
  2173.           type: "integer"
  2174.           format: "int64"
  2175.           example: 42
  2176.         type:
  2177.           type: "string"
  2178.           example: "placeholder1Thirdparty"
  2179.           readOnly: true
  2180.           enum:
  2181.          - "placeholder1Thirdparty"
  2182.   Pricing:
  2183.     type: "object"
  2184.     properties:
  2185.       value:
  2186.         type: "number"
  2187.       pricingModel:
  2188.         type: "string"
  2189.         enum:
  2190.        - "BUDGET"
  2191.         - "CPM"
  2192.         - "CPMV_25"
  2193.         - "CPMV_50"
  2194.         - "CPMV_75"
  2195.         - "CPMV_100"
  2196.         - "CPC"
  2197.         - "NO_PRICING"
  2198.   Rtb:
  2199.     allOf:
  2200.     - $ref: "#/definitions/Creative"
  2201.     - type: "object"
  2202.       required:
  2203.      - "insertionPoint"
  2204.       - "marketplaceId"
  2205.       properties:
  2206.         insertionPoint:
  2207.           type: "string"
  2208.           example: "preroll"
  2209.           readOnly: true
  2210.           enum:
  2211.          - "preroll"
  2212.           - "midroll"
  2213.           - "postroll"
  2214.         marketplaceId:
  2215.           type: "integer"
  2216.           format: "int64"
  2217.           example: 42
  2218.           readOnly: true
  2219.         type:
  2220.           type: "string"
  2221.           example: "rtb"
  2222.           readOnly: true
  2223.           enum:
  2224.          - "rtb"
  2225.   RtbPlaceholder:
  2226.     allOf:
  2227.     - $ref: "#/definitions/Creative"
  2228.     - type: "object"
  2229.       required:
  2230.      - "insertionPoint"
  2231.       properties:
  2232.         insertionPoint:
  2233.           type: "string"
  2234.           example: "preroll"
  2235.           readOnly: true
  2236.           enum:
  2237.          - "preroll"
  2238.           - "midroll"
  2239.           - "postroll"
  2240.         type:
  2241.           type: "string"
  2242.           example: "rtbPlaceholder"
  2243.           readOnly: true
  2244.           enum:
  2245.          - "rtbPlaceholder"
  2246.   Share:
  2247.     type: "object"
  2248.     properties:
  2249.       id:
  2250.         type: "string"
  2251.         format: "uuid"
  2252.         readOnly: true
  2253.       description:
  2254.         type: "string"
  2255.         readOnly: true
  2256.       name:
  2257.         type: "string"
  2258.         readOnly: true
  2259.       parent:
  2260.         type: "string"
  2261.         format: "uuid"
  2262.         readOnly: true
  2263.       visible:
  2264.         type: "boolean"
  2265.         readOnly: true
  2266.       shareGroup:
  2267.         type: "string"
  2268.         format: "uuid"
  2269.         readOnly: true
  2270.       enabled:
  2271.         type: "boolean"
  2272.         readOnly: true
  2273.   Site:
  2274.     type: "object"
  2275.     properties:
  2276.       id:
  2277.         type: "string"
  2278.         format: "uuid"
  2279.         readOnly: true
  2280.       customerId:
  2281.         type: "string"
  2282.         format: "uuid"
  2283.         readOnly: true
  2284.       name:
  2285.         type: "string"
  2286.         readOnly: true
  2287.       description:
  2288.         type: "string"
  2289.         readOnly: true
  2290.       language:
  2291.         type: "string"
  2292.         readOnly: true
  2293.       timezone:
  2294.         type: "string"
  2295.         readOnly: true
  2296.       subdomain:
  2297.         type: "string"
  2298.         readOnly: true
  2299.       visible:
  2300.         type: "boolean"
  2301.         readOnly: true
  2302.       externalTrackers:
  2303.         type: "array"
  2304.         readOnly: true
  2305.         uniqueItems: true
  2306.         items:
  2307.           $ref: "#/definitions/ExternalTracker"
  2308.       options:
  2309.         type: "object"
  2310.         readOnly: true
  2311.         additionalProperties:
  2312.           type: "string"
  2313.   SkipOffset:
  2314.     type: "object"
  2315.     properties:
  2316.       value:
  2317.         type: "integer"
  2318.         format: "int32"
  2319.         description: "Skip setting offset."
  2320.       unit:
  2321.         type: "string"
  2322.         description: "Skip setting offset time unit."
  2323.         enum:
  2324.        - "seconds"
  2325.         - "percent"
  2326.   SkipSettings:
  2327.     type: "object"
  2328.     properties:
  2329.       resetAfter:
  2330.         type: "integer"
  2331.         format: "int32"
  2332.         description: "Skip setting reset interval, given in hours."
  2333.         enum:
  2334.        - 1
  2335.         - 2
  2336.         - 3
  2337.         - 6
  2338.         - 12
  2339.         - 24
  2340.         - 36
  2341.         - 48
  2342.       showWhen:
  2343.         type: "string"
  2344.         description: "Skip setting strategy."
  2345.         enum:
  2346.        - "never"
  2347.         - "always"
  2348.         - "afterFirstImpression"
  2349.       skipOffset:
  2350.         $ref: "#/definitions/SkipOffset"
  2351.       parentOverride:
  2352.         type: "boolean"
  2353.         description: "Skip setting override indicator. When set to false, no override\
  2354.          \ exists in the campaign>goal>ad hierarchy, or the skip policy is not set\
  2355.          \ on the current object. When set to true, the skip policy is overriden\
  2356.          \ somewhere in the hierarchy (campaign > goal > ad) of the current object.\
  2357.          \  A reference to the object where the skip policy comes from is available\
  2358.          \ in the origin object."
  2359.   Standard:
  2360.     allOf:
  2361.     - $ref: "#/definitions/Creative"
  2362.     - type: "object"
  2363.       required:
  2364.      - "asset"
  2365.       - "insertionPoint"
  2366.       properties:
  2367.         insertionPoint:
  2368.           type: "string"
  2369.           example: "preroll"
  2370.           readOnly: true
  2371.           enum:
  2372.          - "preroll"
  2373.           - "midroll"
  2374.           - "postroll"
  2375.         asset:
  2376.           readOnly: true
  2377.           $ref: "#/definitions/Link"
  2378.         clickDestinationUri:
  2379.           type: "string"
  2380.           example: "http://click-destination-uri.com"
  2381.           readOnly: true
  2382.         type:
  2383.           type: "string"
  2384.           example: "standard"
  2385.           readOnly: true
  2386.           enum:
  2387.          - "standard"
  2388.   StandardPlaceholder:
  2389.     allOf:
  2390.     - $ref: "#/definitions/Creative"
  2391.     - type: "object"
  2392.       required:
  2393.      - "insertionPoint"
  2394.       properties:
  2395.         insertionPoint:
  2396.           type: "string"
  2397.           example: "preroll"
  2398.           enum:
  2399.          - "preroll"
  2400.           - "midroll"
  2401.           - "postroll"
  2402.         type:
  2403.           type: "string"
  2404.           example: "standardPlaceholder"
  2405.           readOnly: true
  2406.           enum:
  2407.          - "standardPlaceholder"
  2408.   StandardThirdparty:
  2409.     allOf:
  2410.     - $ref: "#/definitions/Creative"
  2411.     - type: "object"
  2412.       required:
  2413.      - "insertionPoint"
  2414.       - "vastUri"
  2415.       properties:
  2416.         insertionPoint:
  2417.           type: "string"
  2418.           example: "preroll"
  2419.           readOnly: true
  2420.           enum:
  2421.          - "preroll"
  2422.           - "midroll"
  2423.           - "postroll"
  2424.         vastUri:
  2425.           type: "string"
  2426.           example: "http://vast-uri-example.com"
  2427.           readOnly: true
  2428.         vpaidStrict:
  2429.           type: "boolean"
  2430.           example: true
  2431.           readOnly: true
  2432.         vpaidCountdown:
  2433.           type: "boolean"
  2434.           example: false
  2435.           readOnly: true
  2436.         estimatedAdDuration:
  2437.           type: "integer"
  2438.           format: "int64"
  2439.           example: 42
  2440.           readOnly: true
  2441.         type:
  2442.           type: "string"
  2443.           example: "standardThirdparty"
  2444.           readOnly: true
  2445.           enum:
  2446.          - "standardThirdparty"
  2447.   Takeover:
  2448.     allOf:
  2449.     - $ref: "#/definitions/Creative"
  2450.     - type: "object"
  2451.       required:
  2452.      - "asset"
  2453.       - "insertionPoint"
  2454.       properties:
  2455.         insertionPoint:
  2456.           type: "string"
  2457.           example: "preroll"
  2458.           readOnly: true
  2459.           enum:
  2460.          - "preroll"
  2461.           - "midroll"
  2462.           - "postroll"
  2463.         asset:
  2464.           readOnly: true
  2465.           $ref: "#/definitions/Link"
  2466.         clickDestinationUri:
  2467.           type: "string"
  2468.           example: "http://click-destination-uri.com"
  2469.           readOnly: true
  2470.         type:
  2471.           type: "string"
  2472.           example: "takeover"
  2473.           readOnly: true
  2474.           enum:
  2475.          - "takeover"
  2476.   TakeoverPlaceholder:
  2477.     allOf:
  2478.     - $ref: "#/definitions/Creative"
  2479.     - type: "object"
  2480.       required:
  2481.      - "insertionPoint"
  2482.       properties:
  2483.         insertionPoint:
  2484.           type: "string"
  2485.           example: "preroll"
  2486.           enum:
  2487.          - "preroll"
  2488.           - "midroll"
  2489.           - "postroll"
  2490.         type:
  2491.           type: "string"
  2492.           example: "takeoverPlaceholder"
  2493.           readOnly: true
  2494.           enum:
  2495.          - "takeoverPlaceholder"
  2496.   TakeoverThirdparty:
  2497.     allOf:
  2498.     - $ref: "#/definitions/Creative"
  2499.     - type: "object"
  2500.       required:
  2501.      - "insertionPoint"
  2502.       - "vastUri"
  2503.       properties:
  2504.         insertionPoint:
  2505.           type: "string"
  2506.           example: "preroll"
  2507.           readOnly: true
  2508.           enum:
  2509.          - "preroll"
  2510.           - "midroll"
  2511.           - "postroll"
  2512.         vastUri:
  2513.           type: "string"
  2514.           example: "http://vast-uri-example.com"
  2515.           readOnly: true
  2516.         vpaidStrict:
  2517.           type: "boolean"
  2518.           example: true
  2519.           readOnly: true
  2520.         vpaidCountdown:
  2521.           type: "boolean"
  2522.           example: false
  2523.           readOnly: true
  2524.         estimatedAdDuration:
  2525.           type: "integer"
  2526.           format: "int64"
  2527.           example: 42
  2528.           readOnly: true
  2529.         type:
  2530.           type: "string"
  2531.           example: "takeoverThirdparty"
  2532.           readOnly: true
  2533.           enum:
  2534.          - "takeoverThirdparty"
  2535.   Target:
  2536.     type: "object"
  2537.   Unknown:
  2538.     allOf:
  2539.     - $ref: "#/definitions/Creative"
  2540.     - type: "object"
  2541.       properties:
  2542.         unknownType:
  2543.           type: "string"
  2544.         type:
  2545.           type: "string"
  2546.           example: "unknown"
  2547.           readOnly: true
  2548.           enum:
  2549.          - "unknown"
  2550.       description: "Representation of invalid parameters."
  2551.   VastUrl:
  2552.     type: "object"
  2553.     properties:
  2554.       formatType:
  2555.         type: "string"
  2556.         example: "preroll"
  2557.         description: "Type of ad."
  2558.         enum:
  2559.        - "preroll"
  2560.         - "midroll"
  2561.         - "postroll"
  2562.         - "overlay"
  2563.         - "companionBanner"
  2564.         - "inskin"
  2565.         - "splash"
  2566.         - "seekroll"
  2567.         - "pauseAd"
  2568.       vastUrl:
  2569.         type: "string"
  2570.         format: "url"
  2571.         example: "http://domain.videoplaza.test/proxy/distributor/v2?s=5c4de482-b71a-4014-bfed-81df1ccfe4bc&tt=p&rt=vast_3.0&rnd=12341341234&xgid=5c4de482-b71a-4014-bfed-81df1ccfe4bd"
  2572.         description: "Representation of a Vast URL."
  2573.     description: "Representation of VastUrl for a specific ad-type."
  2574.   Weight:
  2575.     type: "object"
  2576.     required:
  2577.    - "proportional"
  2578.     - "totalOverridden"
  2579.     - "value"
  2580.     properties:
  2581.       proportional:
  2582.         type: "boolean"
  2583.         description: "Indicates if this ad's weight is proportionally split between\
  2584.          \ ads of the same format or ads of the same insertion point, or it is manually\
  2585.          \ overridden."
  2586.       totalOverridden:
  2587.         type: "number"
  2588.         format: "double"
  2589.         description: "Sum of all overridden weights for ads of the same format and\
  2590.          \ insertion point."
  2591.         minimum: 0
  2592.         maximum: 1
  2593.       value:
  2594.         type: "number"
  2595.         format: "double"
  2596.         description: "Specify how often a specific ad should be picked out of multiple\
  2597.          \ ads of the same ad format or insertion point, possible values are 0.0\
  2598.          \ to 1.0."
  2599.         minimum: 0
  2600.         maximum: 1
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!