Aangepast object bulksgewijs importeren
Bulk de Verwijzing van het Eindpunt van de Invoer van de Objecten van de Douane
Wanneer u veel aangepaste objectrapporten wilt gebruiken importeren, is het aan te raden deze asynchroon te importeren met de bulk-API. Hiertoe importeert u een vlak bestand dat gescheiden records bevat (komma, tab of puntkomma). Het bestand kan een willekeurig aantal records bevatten, op voorwaarde dat het bestand kleiner is dan 10 MB (anders een HTTP-bestand 413 statuscode wordt geretourneerd). De inhoud van het bestand is afhankelijk van de definitie van het aangepaste object. De eerste rij bevat altijd een koptekst waarin de velden worden vermeld waarin waarden van elke rij moeten worden toegewezen. Alle veldnamen in de header moeten overeenkomen met een API-naam (zoals hieronder wordt beschreven). Resterende rijen bevatten de te importeren gegevens, één record per rij. De recordbewerking is alleen "invoegen of bijwerken".
Verwerkingslimieten
U kunt meer dan één aanvraag voor bulkimport indienen, binnen de limieten. Elke aanvraag wordt als een taak toegevoegd aan een FIFO-wachtrij die moet worden verwerkt. Er worden maximaal twee banen tegelijk verwerkt. De wachtrij kan maximaal tien taken tegelijk uitvoeren (inclusief de twee momenteel verwerkte taken). Als u het maximum van tien taken overschrijdt, wordt de fout "1016, Te veel import" geretourneerd.
Voorbeeld van aangepast object
Alvorens de bulk API te gebruiken, moet u eerst Marketo Admin UI gebruiken om uw douanevoorwerptot stand te brengen. Stel bijvoorbeeld dat we een aangepast object 'Auto' hebben gemaakt met de velden 'Kleur', 'Merk', 'Model' en 'VIN'. Hieronder ziet u de Admin UI-schermen die het aangepaste object weergeven. U ziet dat we VIN-veld hebben gebruikt voor deduplicatie. De API-namen worden gemarkeerd, omdat ze moeten worden gebruikt bij het aanroepen van API-gerelateerde eindpunten in bulk.
Hier volgen de aangepaste objectvelden die worden weergegeven in de interface voor beheer.
API-namen
U kunt API namen programmatically terugwinnen door de naam van douanevoorwerp API tot over te gaan beschrijf heteindpunt van de Objecten van de Douane {.
/rest/v1/customobjects/{apiName}/describe.json
{
"requestId": "46ff#15a686e66de",
"result": [
{
"name": "car_c",
"displayName": "Car",
"description": "It's a car.",
"createdAt": "2017-02-22T19:55:51Z",
"updatedAt": "2017-02-22T19:55:51Z",
"idField": "marketoGUID",
"dedupeFields": [
"vin"
],
"searchableFields": [
[
"vin"
],
[
"marketoGUID"
]
],
"fields": [
{
"name": "createdAt",
"displayName": "Created At",
"dataType": "datetime",
"updateable": false
},
{
"name": "marketoGUID",
"displayName": "Marketo GUID",
"dataType": "string",
"length": 36,
"updateable": false
},
{
"name": "updatedAt",
"displayName": "Updated At",
"dataType": "datetime",
"updateable": false
},
{
"name": "color",
"displayName": "Color",
"dataType": "string",
"length": 255,
"updateable": true
},
{
"name": "make",
"displayName": "Make",
"dataType": "string",
"length": 255,
"updateable": true
},
{
"name": "model",
"displayName": "Model",
"dataType": "string",
"length": 255,
"updateable": true
},
{
"name": "vin",
"displayName": "VIN",
"dataType": "string",
"length": 255,
"updateable": true
}
]
}
],
"success": true
}
Bestand importeren
Stel nu dat u drie aangepaste objectrecords 'Auto' wilt importeren. Met een door komma's gescheiden indeling (CSV) kan het bestand er als volgt uitzien:
color,make,model,vin
red,bmw,2002,WBA4R7C55HK895912
yellow,bmw,320i,WBA4R7C30HK896061
blue,bmw,325i,WBS3U9C52HP970604
Regel 1 is de kopbal, en lijnen 2-4 zijn de verslagen van de douaneobjecten gegevens.
Een taak maken
Om het bulkinvoerverzoek te maken, moet u de API naam van het douanevoorwerp in de weg aan het eind omvatten van de Objecten van de Douane van de Invoer. U moet ook een parameter "file" opnemen die naar de naam van het importbestand verwijst, en een parameter "format" die aangeeft hoe het importbestand wordt gescheiden ("csv", "tsv" of "ssv").
POST /bulk/v1/customobjects/{apiName}/import.json?format=csv
Transfer-Encoding: chunked
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryXjWP6BP8Ciq6bPeo
Content-Length: 290
Host: <munchkinId>.mktorest.com
------WebKitFormBoundaryXjWP6BP8Ciq6bPeo
Content-Disposition: form-data; name="file"; filename="custom_object_import.csv"
Content-Type: text/csv
color,make,model,vin
red,bmw,2002,WBA4R7C55HK895912
yellow,bmw,320i,WBA4R7C30HK896061
blue,bmw,325i,WBS3U9C52HP970604
------WebKitFormBoundaryXjWP6BP8Ciq6bPeo--
{
"requestId": "c015#15a68a23418",
"result": [
{
"batchId": 1013,
"status": "Queued",
"objectApiName": "car_c"
}
],
"success": true
}
In dit voorbeeld hebben we de indeling "csv" opgegeven en ons importbestand de naam "custom_object_import.csv" gegeven.
Bericht in het antwoord op onze vraag, hier is geen lijst van successen of mislukkingen zoals u van het eindpunt van de Objecten van de Douane van de Synchronisatie zou terugkomen. In plaats daarvan ontvangt u een batchId . De reden hiervoor is dat de aanroep asynchroon is en een status van "In wachtrij", "Importeren" of "Mislukt" kan retourneren. U moet de batchId behouden, zodat u de status van de importtaak kunt ophalen of fouten en/of waarschuwingen kunt ophalen wanneer de taak is voltooid. De batchId blijft zeven dagen geldig.
Een eenvoudige manier om de aanvraag voor bulkimport te repliceren is door krullen vanaf de opdrachtregel te gebruiken:
curl -X POST -i -F format='csv' -F file='@custom_object_import.csv' -F access_token='<Access Token>' <REST API Endpoint URL>/bulk/v1/customobjects/car_c/import.json
Waar het importbestand "custom_object_import.csv" het volgende bevat:
color,make,model,vin
red,bmw,2002,WBA4R7C55HK895912
yellow,bmw,320i,WBA4R7C30HK896061
blue,bmw,325i,WBS3U9C52HP970604
Status opiniepeilingtaak
Nadat de importtaak is gemaakt, moet u een query uitvoeren op de status ervan. Het is aan te raden de importtaak elke 5-30 seconden te peilen. Doe dit door de API naam van het douanevoorwerp en batchId in de weg tot het overgaan krijgt de Status van de Objecten van de Douane van de Invoereindpunt.
GET /bulk/v1/customobjects/{apiName}/import/{batchId}/status.json
{
"requestId": "2a5#15a68dd9be1",
"result": [
{
"batchId": 1013,
"operation": "import",
"status": "Complete",
"objectApiName": "car_c",
"numOfObjectsProcessed": 3,
"numOfRowsFailed": 0,
"numOfRowsWithWarning": 0,
"importTime": "2 second(s)",
"message": "Import succeeded, 3 records imported (3 members)"
}
],
"success": true
}
In deze reactie wordt een voltooide import getoond, maar de status kan een van de volgende zijn: Voltooid, In wachtrij geplaatst, Importeren, Mislukt. Als de taak is voltooid, ziet u een overzicht van het aantal verwerkte rijen, met fouten en waarschuwingen. Het berichtattribuut is ook een goede plaats om naar extra baaninformatie te zoeken.
Mislukt
De mislukkingen worden vermeld door het numOfRowsFailed attribuut in krijgen de Status van de Objecten van de Douane van de Invoerreactie. Als numOfRowsFailed groter is dan nul, dan wijst die waarde op het aantal mislukkingen die voorkwamen. De vraag krijgt het Eigen Voorwerp van de Invoereindpunt om een dossier met mislukkingsdetail te verkrijgen. Ook hier moet u de API-naam voor het aangepaste object en batchId in het pad doorgeven. Als er geen foutbestand bestaat, wordt een HTTP 404-statuscode geretourneerd.
Als u doorgaat met het voorbeeld, kunt u een fout forceren door de koptekst te wijzigen en "vin" in " vin" te wijzigen (door een spatie tussen de komma en "vin" toe te voegen).
color,make,model, vin
Wanneer we de status opnieuw importeren en controleren, zien we dit antwoord met numRowsFailed: 3. Dit wijst op drie mislukkingen.
GET /bulk/v1/customobjects/car_c/import/{batchId}/status.json
{
"requestId": "12260#15a68f491ed",
"result": [
{
"batchId": 1016,
"operation": "import",
"status": "Complete",
"objectApiName": "car_c",
"numOfObjectsProcessed": 0,
"numOfRowsFailed": 3,
"numOfRowsWithWarning": 0,
"importTime": "1 second(s)",
"message": "Import completed with errors, 0 records imported (0 members), 3 failed"
}
],
"success": true
}
Nu maken wij Get het eindpuntvraag van Objecten van de Douane van de Invoer om extra mislukkingsdetail te krijgen:
GET /bulk/v1/customobjects/car_c/import/{batchId}/failures.json
color,make,model, vin,Import Failure Reason
red,bmw,2002,WBA4R7C55HK895912,missing.dedupe.fields
yellow,bmw,320i,WBA4R7C30HK896061,missing.dedupe.fields
blue,bmw,325i,WBS3U9C52HP970604,missing.dedupe.fields
We kunnen zien dat we ons deduplicatieveld vin missen.
Waarschuwingen
Waarschuwingen worden aangegeven door het kenmerk numOfRowsWithWarning in de statusreactie Aangepast object importeren ophalen. Als numOfRowsWithWarning groter is dan nul, dan wijst die waarde op het aantal waarschuwingen die voorkwamen. De vraag krijgt de Waarschuwingen van het Voorwerp van de Douane van de Invoereindpunt om een dossier met waarschuwingsdetail te verkrijgen. Ook hier moet u de API-naam voor het aangepaste object en batchId in het pad doorgeven. Als er geen waarschuwingsbestand bestaat, wordt een HTTP 404-statuscode geretourneerd.
GET /bulk/v1/customobjects/car_c/import/{batchId}/warnings.json