Get project achievements

post https://us-central1-readysandbox.cloudfunctions.net/achievements-getProjectAchievements

Retrieves currently active achievements for a project.

Responses

Response body

object

loginDaysInRowAchievements

array of objects

Daily achievements. Triggered when the user logs in.
Use the 'repeatNoMoreOftenThanCron' field to specify how often the achievement can give rewards.

loginDaysInRowAchievements

object

loginDaysInRow

int32

The number of consecutive days for the login achievement

achievementId

string

The ID of the achievement to trigger

loginDaysAchievements

array of objects

Daily achievements. Triggered when the user logs in.
Use the 'repeatNoMoreOftenThanCron' field to specify how often the achievement can give rewards.

loginDaysAchievements

object

loginDays

int32

The number of consecutive days for the login achievement

achievementId

string

The ID of the achievement to trigger

playerProgressAchievements

array of objects

Player progress achievements. Triggered when the player progress field reaches the specified value.
Is triggered when 'game-updatePlayerProgress' or 'game-addPlayerProgress' is called.

playerProgressAchievements

object

playerProgressFieldName

string

The name of the player progress field

playerProgressFieldValueToReach

int32

The value of the player progress field to reach for the achievement

achievementId

string

The ID of the achievement to trigger

purchaseAchievements

array of objects

Purchase achievements. Triggered when the user purchases a virtual item with the specified tag.
Is triggered when 'storeV2-buyStoreOffer' or 'storeV2-buyVirtualItems' is called.

purchaseAchievements

object

virtualItemTag

string

The tag of the virtual item. When the user purchases a virtual item with this tag, the achievement is triggered.

achievementId

string

The ID of the achievement to trigger

signInAchievements

object

Sign-in achievements. Triggered when the user signs in.
Use the 'signInEventSource' field to specify the source of the sign-in event.

guest_sign_up

string

The ID of the achievement to trigger when a guest user signs up

string

The ID of the achievement to trigger when a user logs in

create_custom_token

string

The ID of the achievement to trigger when a user logs in with a custom token

refresh_tokens_guest

string

The ID of the achievement to trigger when a user refreshes a guest account token

refresh_tokens_email

string

The ID of the achievement to trigger when a user refreshes an email account token

sign_in_with_email_password

string

The ID of the achievement to trigger when a user logs in with email and password

400

Invalid argument error, indicating that one or more of the provided fields are invalid or missing.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://us-central1-readysandbox.cloudfunctions.net/achievements-getProjectAchievements \
3
     --header 'accept: application/json'


xxxxxxxxxx
35
}
1
{
2
  "loginDaysInRowAchievements": [
3
    {
4
      "loginDaysInRow": 0,
5
      "achievementId": "string"
6
    }
7
  ],
8
  "loginDaysAchievements": [
9
    {
10
      "loginDays": 0,
11
      "achievementId": "string"
12
    }
13
  ],
14
  "playerProgressAchievements": [
15
    {
16
      "playerProgressFieldName": "string",
17
      "playerProgressFieldValueToReach": 0,
18
      "achievementId": "string"
19
    }
20
  ],
21
  "purchaseAchievements": [
22
    {
23
      "virtualItemTag": "string",
24
      "achievementId": "string"
25
    }

200Successful retrieval of achievements and user achievements data.

401Unauthenticated error 401 indicating the user is not authenticated.