Skip to main content

Mistplay

Overview

The Mistplay connector is a destination that exports audience membership as a CSV file to an Amazon S3 bucket used by Mistplay. Each run uploads a new file containing hashed device identifiers for users included in the audience.

Key behaviors:

  • Writes a CSV with a single header column that matches the configured identifier type.
  • Writes one hashed identifier per line (SHA-256 of the lowercased identifier).
  • Only exports records that are not marked as removed (records marked as removed are skipped).
  • Requires a data contract to validate records and to determine the identifier column name.

Prerequisites

  • AWS credentials available via the runtime environment (see Authentication).
  • A game_id value provided at run time (stream parameter).
  • A data contract configured for the destination (see Data contract).

Authentication

This destination authenticates to AWS using environment-based credentials.

Supported auth method

  • AWS environment credentials
    • The connector uses the AWS SDK default credential resolution (for example, IAM role credentials in the execution environment, or standard AWS environment configuration).

During login, the connector:

  1. Resolves the S3 bucket region automatically.
  2. Verifies the credentials by calling AWS STS to fetch the caller identity.

Note: This connector does not accept AWS access keys as destination configuration fields.

Configuration

Destination settings

FieldTypeRequiredDescription
game_studio_name_overridestringOptional override for the resolved game studio name used in the S3 output path. If set, this value is used instead of deriving the name from the account name. Leading/trailing whitespace is trimmed; empty values are ignored.

Stream parameters

FieldTypeRequiredDescription
game_idstringMistplay game identifier used in the output filename.

Data contract

A data contract is required for this destination.

Connector-specific settings

In the data contract, set:

  • connector_specific.identifier_type (string, required)

This value determines:

  • The CSV header (single column name).
  • The field name read from each record to extract the device identifier.

Example:

{
"connector_specific": {
"identifier_type": "gaid"
}
}

Record requirements

Each exported record must include:

  • A field whose name matches identifier_type (for example, gaid), containing a non-empty string device identifier.

Records are validated and cast using the data contract before export.

Output format and delivery

S3 location

The connector uploads a CSV file to an S3 bucket used by Mistplay.

The object key format is:

singular/{game_studio}/{game_id}_{timestamp}.csv

Where:

  • game_studio is derived from the account name (lowercased, spaces replaced with _).
  • timestamp is generated at runtime in the format YYYY-MM-DD_HHMMSS.

CSV format

  • First line: header containing the identifier_type
  • Subsequent lines: SHA-256 hash of the lowercased identifier value

Example:

gaid
e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
...

Streams

This connector is a destination and does not expose source streams.