{"type":"doc","content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"expand","attrs":{"title":"Content"},"content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Table of Contents","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"2"}},"macroMetadata":{"macroId":{"value":"ab3f188b-a9ee-41bb-bb8b-561f55746cd7"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"In order to use the Programmatic Data Import API, your Salesforce Org needs to have API usage activated through having an API usage License. ","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"numberedheadings","parameters":{"macroParams":{"start-numbering-with":{"value":"1"}},"macroMetadata":{"macroId":{"value":"d08939d6-a6b4-4c6e-a850-e5b954dc421e"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://numberedheadings.bobswift.appfire.app/logo-black-72.png"}}],"title":"Numbered Headings"}}},"content":[{"type":"paragraph","content":[{"text":"The Programmatic Data Import API function is implemented as Apex class and is exposed as REST web service by using Salesforce standard functionality (see ","type":"text"},{"text":"Apex Developer Guide","type":"text","marks":[{"type":"link","attrs":{"href":"https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest.htm"}}]},{"text":" for more information). For general information about the Forecast API feature, see ","type":"text"},{"text":"4.4 Availability Forecast.","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/SO/pages/622704"}}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"REST web service","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL","type":"text"}]},{"type":"paragraph","content":[{"text":"https://.","type":"text"},{"text":"my.salesforce.com/","type":"text"},{"text":"services/apexrest/ADvendio/ProgrammaticDataService/loadCSV/","type":"text","marks":[{"type":"textColor","attrs":{"color":"#212121"}}]}]},{"type":"paragraph","content":[{"text":"https://.","type":"text"},{"text":"my.salesforce.com/","type":"text"},{"text":"services/apexrest/ADvendio/ProgrammaticDataService/loadCSV/","type":"text","marks":[{"type":"textColor","attrs":{"color":"#212121"}}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Method","type":"text"}]},{"type":"paragraph","content":[{"text":"POST","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL Params","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Value","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ex: ","type":"text"},{"text":"a0M5r000000xkfkEAA","type":"text","marks":[{"type":"textColor","attrs":{"color":"#212121"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Salesforce id of the connection object to which the data to be imported is related to.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request body should content a csv file binary containing the data to be imported according the following mapping. More information about the mapping and the file to attach can be found here: ","type":"text"},{"text":"7.7.8.6.1 CSV structure for generic Programmatic Revenue upload and how mapping is defined","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/SO/pages/3224436741"}}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"CSV Column","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Imported in object/field","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"month","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__Month__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"advertiserId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticAdvertiser__c.ADvendio__AdvertiserId__c","type":"text"}]},{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__AdvertiserId__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"advertiserName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticAdvertiser__c.ADvendio__AdvertiserName__c","type":"text"}]},{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__AdvertiserName__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"partnerName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticPartner__c.ADvendio__PartnerName__c","type":"text"}]},{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__SSPPartner__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"adUnitId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticPrice__c.ADvendio__AdUnitId__c","type":"text"}]},{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__AdUnitId__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"adUnitName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticPrice__c.ADvendio__AdUnitName__c","type":"text"}]},{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__AdUnitName__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"dealType","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticPrice__c.ADvendio__DealType__c","type":"text"}]},{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__DealType__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"costType","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticPrice__c.ADvendio__CostType__c","type":"text"}]},{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__CostType__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"creativeSize","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticPrice__c.ADvendio__CreativeSize__c","type":"text"}]},{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__CreativeSize__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"currencyCode","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticPrice__c.CurrencyIsoCode","type":"text"}]},{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.CurrencyIsoCode","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"impressions","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Number","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__Impressions__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"clicks","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Number","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__Clicks__c","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"revenue","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Number","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProgrammaticDataWorkingSet__c.ADvendio__Revenue__c","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Success Response","type":"text"}]},{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]},{"text":": 200","type":"text"}]},{"type":"paragraph","content":[{"text":"Content","type":"text","marks":[{"type":"strong"}]},{"text":": A serialized JSON with the batch job id that will handle the import process.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]},{"text":": {\"jobId\":\"7075r00001lfCmsAAE\"}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Error Response","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"text":"Salesforce Apex REST Documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest_methods.htm"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Examples","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Get a Session-ID","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Get a Session ID","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl -v https://.my.salesforce.com/services/oauth2/token -d \"grant_type=password\" -d \"client_id=\" -d \"client_secret=\" -d \"username=\" -d \"password=\" -H 'X-PrettyPrint:1'","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Connected App","type":"text"}]},{"type":"paragraph","content":[{"text":"Get CLIENT_ID and CLIENT_SECRET from any connected app or create a new app in your org: App Manager -> New Connected App","type":"text"}]},{"type":"paragraph","content":[{"text":"Enable ","type":"text"},{"text":"Enable OAuth Settings","type":"text","marks":[{"type":"textColor","attrs":{"color":"#27282e"}}]},{"text":" to see the consumer key (CLIENT_ID) and Consumer Secret (CLIENT_SECRET)","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Minimal request","type":"text"}]},{"type":"paragraph","content":[{"text":"A simple request for a data set connected to an Ad Server.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Call Check Availability web service","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl https://.my.salesforce.com/services/apexrest/ADvendio/ProgrammaticDataService/loadCSV?id= -H 'Authorization: Bearer ' -H \"Content-Type: text/csv\" -H 'X-PrettyPrint:1' --data-binary @ --request POST","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n\t\"jobId\":\"7075r00001lfCmsAAE\"\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Programmatic Data Import API - Documentation

Table of Contents