Deliver File Match
deliver_file_matchTrigger download delivery for a file-based identity match job. Always delivers to download — returns a signed URL to the enriched output file. Use this instead of deliver_audience for matched segments created via create_segment(subtype=matched). The match_id is the segment_id returned by create_segment(subtype=matched) — delivery still routes through an audience wrapper internally. Matched segments do not support LiveRamp or Narrative destinations. Supply template_id OR field_list — not both. Use get_field_catalog() to browse options. Requires 'creator' scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| match_id | Yes | The segment_id returned by create_segment(subtype=matched) — also accepted as match_id for backward compatibility | |
| field_list | No | Custom list of field names to include. Mutually exclusive with template_id. | |
| template_id | No | Enrichment template ID from get_field_catalog(). Mutually exclusive with field_list. | |
| webhook_url | No | Optional HTTPS URL to notify when delivery completes. | |
| output_format | No | Output file format. Defaults to csv if not specified. | |
| include_unmatched | No | Include rows that did not resolve to a known identity. Defaults to true. | |
| output_compression | No | Explicit output compression. gzip supports csv/json/jsonl; Avro uses native DEFLATE. | none |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cost | Yes | ||
| status | Yes | Current delivery state | |
| guidance | No | Interpretation or recovery guidance for this result | |
| count_unit | No | ||
| page_count | No | Number of objects on this page, not the organization total | |
| audience_id | Yes | ||
| count_state | No | Unknown means no count; available does not guarantee freshness. Recount for a current value. | |
| delivery_id | Yes | ||
| destination | Yes | ||
| next_actions | No | Suggested next calls using returned IDs and available scopes. Not executed and not user consent. | |
| download_urls | No | Fresh signed artifact URLs on an individual completed download delivery | |
| money_display | No | Currency amounts formatted once from source paths ending in _cents. Use verbatim; do not divide again. Null/missing source amounts are omitted, not zero. | |
| population_input | No | Population input used for the preview; IDs refer to their current saved definitions |