📘

This page is specifically for ComeOn group. The profile attributes described in this page are specific to ComeOn's implementation of the player eligibility check integration.

The player eligibility check integration allows you to send campaigns to eligible players only. Before a campaign is sent, the integration verifies each player's exclusion status against a national regulatory body, ensuring that players who have self-excluded do not receive marketing communications. If a player is excluded, the campaign is not sent to them.

This player exclusion checks works for both single and multistage campaigns.

How the eligibility check works

To use this player eligibility check integration:

1. Configure your player eligibility check integration in Xtremepush.

2. Send player data to Xtremepush using the Profile Import API, including the following profile attributes for each player:

   • franchise: The country the player is associated with.
   • exclusion_type: The national exclusion register the player is registered with (SPELPAUS, OASIS, or ROFUS).
   • is_excluded: Whether the player is currently excluded (true or false).
   • last_exclusion_check_time: The timestamp of the most recent eligibility check (ISO-8601 format).

3. Create an Engagement Category using your player eligibility check integration.

   The engagement category controls which players are eligible to receive messages from a campaign, and ensures the eligibility check is run before each send. For more information, see Engagement Categories.

4. Add the engagement category to your campaign.

When a campaign sends, Xtremepush checks each player's exclusion status. If the status was last checked within 24 hours, the stored value is used. If not, Xtremepush calls the gRPC endpoint to get an up-to-date status. The following table shows what happens based on those attribute values:

Configure the Player Eligibility Integration

To set up the player eligibility check integration, you need the host address and port number of the external gRPC endpoint.

1. Go to Settings > Integrations Marketplace > Player Eligibility Check
2. Click Connect Now.
3. In the Name field, enter a name for your integration.
4. In the Host field, enter the gRPC endpoint host address.
5. In the Port field, enter the gRPC endpoint port number.
6. Click Save.

Once the integration is configured, send or update player profile attributes using the Profile Import API.

Use the Player Eligibility Check in a campaign

To apply the eligibility check to a campaign, you must create an Engagement Category with the configured Player Eligibility Check integration.

📘

Multistage Campaigns

For multistage campaigns, you can also enable the National Exclusion Check toggle on individual Engagement nodes in the workflow builder. This does not require creating an engagement category.

Create the Engagement Category

1. Go to Audiences > Engagement Categories.
2. Open an existing category or click Create category.
3. Enable the Use National Exclusion toggle.
4. In the National Exclusion Check drop-down, select your player eligibility check integration.
5. Complete the remaining category settings and click Save.

Use the Category in a Campaign

1. Create a single or multistage campaign.
2. In the campaign builder, select your engagement category underEngagement Category in the Setup tab.
3. Complete the remaining campaign setup and click Launch.

When the campaign sends, Xtremepush runs the player eligibility check for each player in the selected category. The campaign is not sent to players whose exclusion status is confirmed as excluded .

The check is not performed on every send. Xtremepush refreshes each player's exclusion status every 24 hours.

To check campaign delivery, go to Campaigns > Notifications Log and open your campaign. Under Individual Messages, the Status column shows Failed for players the campaign was not sent to, with the error Excluded by National Exclusion Check (ComeOn).

👍

Before you Send

• The eligibility check does not affect the recipient count shown in the campaign builder. Players are filtered at send time only, so the preview count will include players the campaign may not be sent to. These appear as errors in the campaign Notifications Log after the campaign sends.
• If a player does not have a user_id set on their profile, no eligibility check is performed and the message is not sent. This is logged as a missing user_id error in the Notifications Log.