Available with Business Analyst license.
Summary
Generates a layer that displays expected customers by a selected geography level.
Usage
This tool requires a locally installed Business Analyst dataset.
The output of this tool predicts the quantity of customers in new areas based on the segmentation distribution of customers in existing markets.
The Expected Customers field is symbolized in the output feature class by default.
Ensure your input profiles were built with the same source Business Analyst dataset that is active when using this tool.
The optional output report contains the same information that is included in the output feature class attribute table in tabular format.
Expected customer values are created by applying segmentation penetration rates, calculated by comparing distributions of target and base profiles, to the segmentation distribution for each geography in the analysis extent.
Syntax
arcpy.ba.AnalyzeMarketPotential(target_profile, base_profile, geography_level, out_feature_class, {boundary_layer}, {create_report}, {report_title}, {report_folder}, {report_format})| Parameter | Explanation | Data Type |
target_profile | A segmentation profile representing the segments to be analyzed. The target profile usually represents your customer segmentation profile. | File |
base_profile | A segmentation profile representing the base profile segments. This is the segmentation used for comparison. The base profile usually represents your market area segmentation profile. | File |
geography_level | The geography level that will be used to define the market potential layer. | String |
out_feature_class | The output feature class containing the market potential analysis. | Feature Class |
boundary_layer (Optional) | The boundary that determines the layer extent. If not specified, the entire country will be used. | Feature Layer |
create_report (Optional) | Specifies whether a market potential report will be created.
| Boolean |
report_title (Optional) | The title of the report. | String |
report_folder (Optional) | The output location where the report will be saved. | Folder |
report_format [report_format,...] (Optional) | The report output format. The default value is PDF. Additional available formats are XLSX, HTML, CSV, and PAGX. | String |
Derived Output
| Name | Explanation | Data Type |
| output_report | The output report file. | File |
Code sample
The following stand-alone script demonstrates how to use the AnalyzeMarketPotential function.
import arcpy
arcpy.ba.AnalyzeMarketPotential(r"C:\Users\MyProject\customerprofile.sgprofile", r"C:\Users\MyProject\MarketAreaprofile.sgprofile", "US.ZIP5", r"C:\Users\MyProject\MyProject.gdb\MarketPotential", r"C:\Users\MyProject\MyProject.gdb\StudyArea", "CREATE_REPORT", '', r"C:\Users\MyProject\Reports", "PDF")Environments
Licensing information
- Basic: Requires Business Analyst
- Standard: Requires Business Analyst
- Advanced: Requires Business Analyst