Data Qualification (DQE)
Step 1: Getting Started ✓
Step 2: API Integration (AIE) ✓
Step 3: Data Qualification (DQE)
Step 4: Production Launch
Step 3: Submit All Your Data
In the Data Qualification Environment (DQE), you will submit your data for evaluation by Apple Business before you are granted approval for the production environment. Your submission should be as close as possible to production quality.
- Data qualification is typically completed within one to two weeks.
- The data submitted for data qualification is not published externally.
- Data sent to DQE is not automatically promoted to production.
- When creating a location for DQE, the
partnersLocationIdyou specify will be used for the entire lifecycle of the location. Be sure to record thepartnersLocationId. Any time you change location data, you must reuse the samepartnersLocationId.
Data Qualification Sequence of Tasks
- Receive email granting access to DQE (includes DQE endpoint).
- Create a Service Account for DQE.
- Collect Integration Parameters.
- Submit Data for Qualification.
- Request Data Qualification Verification.
- View Data Qualification Progress Reports.
- Complete the Data Qualification Exit Process.
New Partners vs. Existing Partners
The data qualification steps differ depending on whether you are a new or existing partner:
- New Partner: You are sending data to Apple Maps for the first time and have no previous bulk ingests.
- Existing Partner: You are currently sending bulk data to Apple.
Submit Data for Qualification
Note the differences in some steps for new and existing partners.
- You will receive an email granting you access to DQE. Retrieve the DQE endpoint from this email.
- Create a Service Account for DQE.
- Collect the Integration Parameters.
- Send your data.
New Partner
- Send all of your location data for evaluation.
- When locations are initially submitted, their resource state is
SUBMITTED. After Apple Business finalizes the analysis and approves the location data, the location state will update toPUBLISHED.
- When locations are initially submitted, their resource state is
- After your locations are
PUBLISHED, send the rest of your production data for evaluation.
Existing Partner
- Send all of your production data for evaluation.
- Each
site_codein a bulk record must be captured as apartnersLocationId. - Apple Business will run a differential analysis between your previous bulk ingest and the data you submit to DQE.
Request Data Qualification Verification
Only request verification when all of your data has been sent to DQE.
- Navigate to Organization > Organization Name > API > Data Qualification (
). - Select Verify Data Quality > Send. Apple Business will then evaluate your data for quality and accuracy.
- You can optionally confirm receipt via the embedded alert in the API Access pane.
View Data Qualification Progress Reports
- You will receive an email with your DQE results.
- If you pass, you can proceed to Step 4: Launch to Production.
- If you do not pass, continue to the next step.
- Sign in to the Apple Business portal and select Organization > Organization Name > API.
- In the Data Qualification pane, a message will indicate that your submitted data was not approved. Select View Details.
- Access the reports in your Box folder.
- Proceed to the Data Qualification Exit Criteria.
Access Box Folder Reports
In the "Not Approved" dialog, select the Box folder link to view your progress reports.
If the Box folder does not open, sign in to your organization's Box account first, then select the Box folder link again.