diff --git a/.acrolinx-config.edn b/.acrolinx-config.edn index cddebf863..fd2404316 100644 --- a/.acrolinx-config.edn +++ b/.acrolinx-config.edn @@ -11,7 +11,7 @@ } :scores { ;;:terminology 100 - :qualityscore 70 + :qualityscore 80 ;;:spelling 40 } } diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 6b7393165..f13af9242 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -5,4 +5,4 @@ # The '*' pattern is global owners. -/playfab-docs/ @KevinAsgari @williacj @thomasgu +/playfab-docs/ @MicrosoftDocs/xbox-learning-resources @williacj @thomasgu diff --git a/.github/workflows/merge-main-to-live.yml b/.github/workflows/merge-main-to-live.yml new file mode 100644 index 000000000..c019e86b0 --- /dev/null +++ b/.github/workflows/merge-main-to-live.yml @@ -0,0 +1,166 @@ +name: Merge Main to Live + +on: + schedule: + # Run at 9:00 AM UTC every Tuesday + - cron: '0 9 * * 2' + workflow_dispatch: # Allow manual trigger for testing + +jobs: + merge: + runs-on: ubuntu-latest + permissions: + contents: read # Required for checking out code + pull-requests: write # Required for creating pull requests + issues: write # Required for creating issues on failure + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + token: ${{ secrets.GITHUB_TOKEN }} + + - name: Check if today is 2nd or 4th Tuesday + id: check_date + run: | + # Get current day of month + DAY=$(date +%d) + # Get day of week (1=Monday, 2=Tuesday, ..., 7=Sunday) + DOW=$(date +%u) + + # Check if today is Tuesday (2) + if [ "$DOW" -eq 2 ]; then + # Calculate which week of the month we're in (1-5) + # Remove leading zero if present + DAY=$((10#$DAY)) + WEEK=$(( (DAY - 1) / 7 + 1 )) + + # Check if it's the 2nd or 4th Tuesday + if [ "$WEEK" -eq 2 ] || [ "$WEEK" -eq 4 ]; then + echo "is_target_tuesday=true" >> $GITHUB_OUTPUT + echo "This is the 2nd or 4th Tuesday of the month" + else + echo "is_target_tuesday=false" >> $GITHUB_OUTPUT + echo "This is not the 2nd or 4th Tuesday" + fi + else + echo "is_target_tuesday=false" >> $GITHUB_OUTPUT + echo "Today is not Tuesday" + fi + + - name: Check for existing PR + if: steps.check_date.outputs.is_target_tuesday == 'true' + id: check_pr + uses: actions/github-script@v7 + with: + script: | + const { data: pulls } = await github.rest.pulls.list({ + owner: context.repo.owner, + repo: context.repo.repo, + state: 'open', + head: `${context.repo.owner}:Main`, + base: 'Live' + }); + + if (pulls.length > 0) { + core.setOutput('pr_exists', 'true'); + core.setOutput('pr_number', pulls[0].number); + core.setOutput('pr_url', pulls[0].html_url); + } else { + core.setOutput('pr_exists', 'false'); + } + + - name: Create Pull Request + if: steps.check_date.outputs.is_target_tuesday == 'true' && steps.check_pr.outputs.pr_exists == 'false' + id: create_pr + uses: actions/github-script@v7 + with: + script: | + const date = new Date().toISOString().split('T')[0]; + const title = `Scheduled Merge: Main to Live on ${date}`; + const body = [ + 'This is an automated pull request to merge Main into Live branch.', + '', + `**Scheduled merge date:** ${date}`, + `**Schedule:** This PR is created on the 2nd and 4th Tuesday of each month.`, + `**Workflow run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}`, + '', + '**Instructions:**', + '- Review the changes', + '- Ensure all checks pass', + '- Code owners should approve this PR', + '- Merge when ready', + '', + 'If there are conflicts, they will need to be resolved manually.', + '', + '---', + '*This PR was automatically created by the scheduled merge workflow.*' + ].join('\n'); + + try { + const { data: pr } = await github.rest.pulls.create({ + owner: context.repo.owner, + repo: context.repo.repo, + title: title, + body: body, + head: 'Main', + base: 'Live' + }); + + core.setOutput('pr_number', pr.number); + core.setOutput('pr_url', pr.html_url); + console.log(`Pull request created: ${pr.html_url}`); + } catch (error) { + core.setFailed(`Failed to create pull request: ${error.message}`); + throw error; + } + + - name: Comment on existing PR + if: steps.check_date.outputs.is_target_tuesday == 'true' && steps.check_pr.outputs.pr_exists == 'true' + uses: actions/github-script@v7 + env: + PR_NUMBER: ${{ steps.check_pr.outputs.pr_number }} + with: + script: | + const date = new Date().toISOString().split('T')[0]; + const prNumber = parseInt(process.env.PR_NUMBER); + const comment = [ + `♻️ Scheduled merge workflow ran again on ${date}.`, + '', + 'This PR is still open and ready for review.', + '', + `**Workflow run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}` + ].join('\n'); + + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: prNumber, + body: comment + }); + + console.log(`Comment added to existing PR #${prNumber}`); + + - name: Create Issue on Failure + if: failure() && steps.check_date.outputs.is_target_tuesday == 'true' + uses: actions/github-script@v7 + with: + script: | + const date = new Date().toISOString().split('T')[0]; + const title = `Scheduled Merge PR Creation Failed: Main to Live on ${date}`; + const body = [ + 'The scheduled merge workflow failed to create a pull request from Main to Live branch.', + '', + `**Workflow Run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}`, + '', + 'Please review the workflow logs and create the pull request manually if needed.' + ].join('\n'); + + await github.rest.issues.create({ + owner: context.repo.owner, + repo: context.repo.repo, + title: title, + body: body, + labels: ['workflow-failure', 'automated'] + }); diff --git a/playfab-docs/api-references/events/Addons/title-addon-changed.md b/playfab-docs/api-references/events/Addons/title-addon-changed.md new file mode 100644 index 000000000..eee0c4985 --- /dev/null +++ b/playfab-docs/api-references/events/Addons/title-addon-changed.md @@ -0,0 +1,29 @@ +--- +title: title_addon_changed +author: ronnyparedes +description: title_addon_changed event. +ms.author: ronnyparedes +ms.date: 06/02/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_addon_changed + +This event is triggered when a marketplace AddOn is installed, or changes state. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|AddOnId|String|Unique identifier of the AddOn affected.| +|AddOnName|String|Name of the AddOn affected.| +|DeveloperId|String|Developer/Studio ID.| +|State|[AddOnProvisioningState](../data-types/addonprovisioningstate.md)|Current state of the AddOn. Values include Inactive, Paused, Active, Pending, and PendingWithError.| +|UserId|String|May be null if user is unknown (Admin API, partner source).| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/ApiAccessPolicy/title-api-settings-changed.md b/playfab-docs/api-references/events/ApiAccessPolicy/title-api-settings-changed.md new file mode 100644 index 000000000..13d7309a1 --- /dev/null +++ b/playfab-docs/api-references/events/ApiAccessPolicy/title-api-settings-changed.md @@ -0,0 +1,28 @@ +--- +title: title_api_settings_changed +author: joannaleecy +description: title_api_settings_changed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_api_settings_changed + +This event is triggered when an API Features setting is changed for the title. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeveloperId|String|| +|PreviousSettingsValues|[APISettings](../data-types/apisettings.md)|Settings values before the change.| +|SettingsValues|[APISettings](../data-types/apisettings.md)|Settings values after the change.| +|UserId|String|| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/ApiAccessPolicy/title-permission-policy-changed.md b/playfab-docs/api-references/events/ApiAccessPolicy/title-permission-policy-changed.md new file mode 100644 index 000000000..0434064f5 --- /dev/null +++ b/playfab-docs/api-references/events/ApiAccessPolicy/title-permission-policy-changed.md @@ -0,0 +1,28 @@ +--- +title: title_permission_policy_changed +author: joannaleecy +description: title_permission_policy_changed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_permission_policy_changed + +This event is triggered when an update occurs to a a title's permission policies. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeveloperId|String|| +|NewPolicy|String|The contents new policy.| +|PolicyName|String|The name of the policy that was changed| +|UserId|String|| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/CloudScript/cloudscript-executed.md b/playfab-docs/api-references/events/CloudScript/cloudscript-executed.md new file mode 100644 index 000000000..4da59a2c3 --- /dev/null +++ b/playfab-docs/api-references/events/CloudScript/cloudscript-executed.md @@ -0,0 +1,27 @@ +--- +title: cloudscript_executed +author: ronnyparedes +description: cloudscript_executed event. +ms.author: ronnyparedes +ms.date: 06/02/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# cloudscript_executed + +This event is triggered when a CloudScript function is executed. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|CloudScriptExecutionResult|[ExecuteCloudScriptResult](../data-types/executecloudscriptresult.md)|The details of the execution result.| +|FunctionName|String|Name of the CloudScript function that was executed.| +|Source|String|The source that caused the function to be executed; PlayStreamV2, Task.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/CloudScript/entity-executed-cloud-script.md b/playfab-docs/api-references/events/CloudScript/entity-executed-cloud-script.md new file mode 100644 index 000000000..1e8ad14aa --- /dev/null +++ b/playfab-docs/api-references/events/CloudScript/entity-executed-cloud-script.md @@ -0,0 +1,28 @@ +--- +title: entity_executed_cloud_script +author: joannaleecy +description: entity_executed_cloud_script event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# entity_executed_cloud_script + +This event is optionally triggered when a CloudScript function is executed by calling the ExecuteEntityCloudScript API. If you want the Event logged, you can pass in GeneratePlayStreamEvent. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|CloudScriptExecutionResult|[ExecuteCloudScriptResult](../data-types/executecloudscriptresult.md)|Result of the CloudScript function, including diagnostic information that is useful for debugging.| +|EntityChain|String|The chain of ownership for this entity.| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|FunctionName|String|Name of the CloudScript function that was called.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/CloudScript/player-executed-cloudscript.md b/playfab-docs/api-references/events/CloudScript/player-executed-cloudscript.md new file mode 100644 index 000000000..4c526f032 --- /dev/null +++ b/playfab-docs/api-references/events/CloudScript/player-executed-cloudscript.md @@ -0,0 +1,27 @@ +--- +title: player_executed_cloudscript +author: joannaleecy +description: player_executed_cloudscript event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# player_executed_cloudscript + +This event is optionally triggered when a CloudScript function is executed, either by calling the ExecuteCloudScript API with the GeneratePlayStreamEvent option or triggered by a PlayStream event action with the 'Publish results as a PlayStream Event' box checked. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|CloudScriptExecutionResult|[ExecuteCloudScriptResult](../data-types/executecloudscriptresult.md)|Result of the CloudScript function, including diagnostic information that is useful for debugging.| +|FunctionName|String|Name of the CloudScript function that was called.| +|TitleId|String|The ID of the title to which this player event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/CloudScript/player-triggered-action-executed-cloudscript.md b/playfab-docs/api-references/events/CloudScript/player-triggered-action-executed-cloudscript.md new file mode 100644 index 000000000..55cf4e3c0 --- /dev/null +++ b/playfab-docs/api-references/events/CloudScript/player-triggered-action-executed-cloudscript.md @@ -0,0 +1,30 @@ +--- +title: player_triggered_action_executed_cloudscript +author: joannaleecy +description: player_triggered_action_executed_cloudscript event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# player_triggered_action_executed_cloudscript + +This event is triggered when a CloudScript function is run as the result of a PlayStream action, and the 'Publish results as a PlayStream Event' box was checked. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|CloudScriptExecutionResult|[ExecuteCloudScriptResult](../data-types/executecloudscriptresult.md)|Result of the CloudScript function, including an error information. Useful for debugging.| +|FunctionName|String|Name of the CloudScript function that was called.| +|TitleId|String|The ID of the title to which this player event applies.| +|TriggeringEventData|object|The full JSON data of the event that triggered this CloudScript function to run. Useful for debugging.| +|TriggeringEventName|String|Name of the event that triggered this CloudScript function to run.| +|TriggeringPlayer|[PlayerProfile](../data-types/playerprofile.md)|JSON data profile of the player that triggered this CloudScript function to run.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/CloudScript/title-added-cloudscript.md b/playfab-docs/api-references/events/CloudScript/title-added-cloudscript.md new file mode 100644 index 000000000..bc7b41782 --- /dev/null +++ b/playfab-docs/api-references/events/CloudScript/title-added-cloudscript.md @@ -0,0 +1,30 @@ +--- +title: title_added_cloudscript +author: joannaleecy +description: title_added_cloudscript event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_added_cloudscript + +This event is triggered when new CloudScript is uploaded to PlayFab. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeveloperId|String|| +|Published|Boolean|Whether the CloudScript that was uploaded is live.| +|Revision|int32|Revision number of the CloudScript file that was added.| +|ScriptNames|[]|Names of the individual script files modified. Currently this is just 'CloudScript.js' but later we will support multiple files.| +|UserId|String|| +|Version|int32|Version number of the CloudScript file that was added.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/CloudScript/title-published-cloudscript.md b/playfab-docs/api-references/events/CloudScript/title-published-cloudscript.md new file mode 100644 index 000000000..ef282187f --- /dev/null +++ b/playfab-docs/api-references/events/CloudScript/title-published-cloudscript.md @@ -0,0 +1,27 @@ +--- +title: title_published_cloudscript +author: joannaleecy +description: title_published_cloudscript event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_published_cloudscript + +An inactive revision of CloudScript has been made into the active 'live' version. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeveloperId|String|| +|Revision|int32|Revision number of the CloudScript that was activated.| +|UserId|String|| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/CloudScript/title-scheduled-cloudscript-executed.md b/playfab-docs/api-references/events/CloudScript/title-scheduled-cloudscript-executed.md new file mode 100644 index 000000000..bf3e55063 --- /dev/null +++ b/playfab-docs/api-references/events/CloudScript/title-scheduled-cloudscript-executed.md @@ -0,0 +1,27 @@ +--- +title: title_scheduled_cloudscript_executed +author: joannaleecy +description: title_scheduled_cloudscript_executed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_scheduled_cloudscript_executed + +This event is triggered when a CloudScript function is run by a scheduled task. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|CloudScriptExecutionResult|[ExecuteCloudScriptResult](../data-types/executecloudscriptresult.md)|Result of the CloudScript function, including an error information. Useful for debugging.| +|FunctionName|String|Name of the CloudScript function that was called.| +|ScheduledTask|[NameId](../data-types/nameid.md)|Scheduled task that called the CloudScript| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Extension/export-completed.md b/playfab-docs/api-references/events/Extension/export-completed.md new file mode 100644 index 000000000..4dda3453e --- /dev/null +++ b/playfab-docs/api-references/events/Extension/export-completed.md @@ -0,0 +1,30 @@ +--- +title: export_completed +author: ronnyparedes +description: export_completed event. +ms.author: ronnyparedes +ms.date: 09/02/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# export_completed + +This event is triggered when an export operation is completed. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Artifacts|[Artifact](../data-types/artifact.md)[]|An array of artifact objects representing the exported files or resources.| +|FailureReason|String|The reason for the export failure, if the export did not succeed.| +|Id|String|The unique identifier for this export operation.| +|Name|String|The name of the export operation.| +|StartTime|DateTime|The timestamp when the export operation started.| +|Status|[EventExportCompletionStatus](../data-types/eventexportcompletionstatus.md)|The status of the export operation indicating whether it succeeded, failed, or was cancelled.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/Extension/title-aborted-task.md b/playfab-docs/api-references/events/Extension/title-aborted-task.md new file mode 100644 index 000000000..af0b74882 --- /dev/null +++ b/playfab-docs/api-references/events/Extension/title-aborted-task.md @@ -0,0 +1,27 @@ +--- +title: title_aborted_task +author: joannaleecy +description: title_aborted_task event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_aborted_task + +This event is triggered when a task instance is aborted. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeveloperId|String|| +|TaskInstanceId|String|ID of the aborted task instance| +|UserId|String|| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Extension/title-completed-task.md b/playfab-docs/api-references/events/Extension/title-completed-task.md new file mode 100644 index 000000000..01a0be65a --- /dev/null +++ b/playfab-docs/api-references/events/Extension/title-completed-task.md @@ -0,0 +1,30 @@ +--- +title: title_completed_task +author: joannaleecy +description: title_completed_task event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_completed_task + +This event is triggered when a scheduled task has completed + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|AbortedAt|DateTime|Timestamp on when the task was aborted. Null if task never was aborted.| +|IsAborted|Boolean|Whether the task was aborted.| +|Result|[TaskInstanceStatus](../data-types/taskinstancestatus.md)|Result of the task run, whether it has succeeded, failed or aborted.| +|Summary|object|Summary of the task run. Different task types have different summary structure.| +|TaskInstanceId|String|ID of the running instance of the task| +|TaskType|String|Type of the scheduled task| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Extension/title-created-task.md b/playfab-docs/api-references/events/Extension/title-created-task.md new file mode 100644 index 000000000..baa3a757f --- /dev/null +++ b/playfab-docs/api-references/events/Extension/title-created-task.md @@ -0,0 +1,26 @@ +--- +title: title_created_task +author: joannaleecy +description: title_created_task event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_created_task + +This event is triggered when a task is created. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeveloperId|String|| +|ScheduledTask|[NameIdentifier](../data-types/nameidentifier.md)|Identity of the scheduled task| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Extension/title-deleted-task.md b/playfab-docs/api-references/events/Extension/title-deleted-task.md new file mode 100644 index 000000000..562a0e672 --- /dev/null +++ b/playfab-docs/api-references/events/Extension/title-deleted-task.md @@ -0,0 +1,28 @@ +--- +title: title_deleted_task +author: joannaleecy +description: title_deleted_task event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_deleted_task + +This event is triggered when a task is deleted. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeveloperId|String|| +|ScheduledTask|[NameIdentifier](../data-types/nameidentifier.md)|Identity of the scheduled task| +|UserId|String|| + + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Extension/title-exceeded-limit.md b/playfab-docs/api-references/events/Extension/title-exceeded-limit.md new file mode 100644 index 000000000..25a501a11 --- /dev/null +++ b/playfab-docs/api-references/events/Extension/title-exceeded-limit.md @@ -0,0 +1,30 @@ +--- +title: title_exceeded_limit +author: joannaleecy +description: title_exceeded_limit event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_exceeded_limit + +This event is triggered when a title exceeds a service limit and receives an error. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Details|Object|Additional details about the exceeded limit| +|LimitDisplayName|String|The display name of the limit that was exceeded.| +|LimitId|String|The unique identifier of the limit that was exceeded.| +|LimitValue|double|The limit value that was exceeded.| +|Unit|[MetricUnit](../data-types/metricunit.md)|The unit of the limit that was exceeded.| +|Value|double|The value that exceeded the limit.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Extension/title-limit-changed.md b/playfab-docs/api-references/events/Extension/title-limit-changed.md new file mode 100644 index 000000000..5bed689a0 --- /dev/null +++ b/playfab-docs/api-references/events/Extension/title-limit-changed.md @@ -0,0 +1,32 @@ +--- +title: title_limit_changed +author: joannaleecy +description: title_limit_changed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_limit_changed + +This event is triggered when a title changes a service limit. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|LimitDisplayName|String|The display name of the limit that changed.| +|LimitId|String|The unique identifier of the limit that changed.| +|PreviousPriceUSD|double|The price of the limit level in US Dollars before the change, if any.| +|PreviousValue|double|The limit value before the change, if any.| +|PriceUSD|double|The price of the limit level in US Dollars, if any.| +|TransactionId|String|The unique identifier of the limit change transaction.| +|Unit|[MetricUnit](../data-types/metricunit.md)|The unit of the limit that changed.| +|Value|double|The limit value after the change, if any.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Extension/title-started-task.md b/playfab-docs/api-references/events/Extension/title-started-task.md new file mode 100644 index 000000000..a9ffb5cc3 --- /dev/null +++ b/playfab-docs/api-references/events/Extension/title-started-task.md @@ -0,0 +1,31 @@ +--- +title: title_started_task +author: joannaleecy +description: title_started_task event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_started_task + +This event is triggered when a task is scheduled to run. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeveloperId|String|| +|Parameter|object|Parameter of the scheduled task| +|ScheduledByUserId|String|ID of user who manually scheduled the task, null if scheduled automatically| +|ScheduledTask|[NameIdentifier](../data-types/nameidentifier.md)|Identity of the scheduled task| +|TaskInstanceId|String|ID of the running instance of the task| +|TaskType|String|Type of the scheduled task| +|UserId|String|| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Extension/title-updated-task.md b/playfab-docs/api-references/events/Extension/title-updated-task.md new file mode 100644 index 000000000..603940b6f --- /dev/null +++ b/playfab-docs/api-references/events/Extension/title-updated-task.md @@ -0,0 +1,28 @@ +--- +title: title_updated_task +author: joannaleecy +description: title_updated_task event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_updated_task + +This event is triggered when a task is updated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeveloperId|String|| +|HasRenamed|Boolean|| +|ScheduledTask|[NameIdentifier](../data-types/nameidentifier.md)|Identity of the scheduled task| +|UserId|String|| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Functions/function-executed.md b/playfab-docs/api-references/events/Functions/function-executed.md new file mode 100644 index 000000000..73095f966 --- /dev/null +++ b/playfab-docs/api-references/events/Functions/function-executed.md @@ -0,0 +1,29 @@ +--- +title: function_executed +author: joannaleecy +description: function_executed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# function_executed + +This event is triggered when a CloudScript function is executed. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|ExecutionTimeMilliseconds|int|The execution time of the function in milliseconds.| +|FunctionName|String|The name of the function that was executed.| +|Result|[ExecuteFunctionResult](../data-types/executefunctionresult.md)|The result returned by the function execution.| +|ResultTooLarge|Boolean|Indicates if the result was too large to return and was truncated.| +|Source|String|The source or trigger that caused the function to execute.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/Functions/function-registered.md b/playfab-docs/api-references/events/Functions/function-registered.md new file mode 100644 index 000000000..238697ce6 --- /dev/null +++ b/playfab-docs/api-references/events/Functions/function-registered.md @@ -0,0 +1,25 @@ +--- +title: function_registered +author: joannaleecy +description: function_registered event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# function_registered + +This event is triggered when a CloudScript function is registered. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|FunctionName|String|The name of the function that was registered.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/Functions/function-unregistered.md b/playfab-docs/api-references/events/Functions/function-unregistered.md new file mode 100644 index 000000000..a75e9db6a --- /dev/null +++ b/playfab-docs/api-references/events/Functions/function-unregistered.md @@ -0,0 +1,25 @@ +--- +title: function_unregistered +author: joannaleecy +description: function_unregistered event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# function_unregistered + +This event is triggered when a CloudScript function is unregistered. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|FunctionName|String|The name of the function that was unregistered.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/Functions/player-triggered-action-executed-function.md b/playfab-docs/api-references/events/Functions/player-triggered-action-executed-function.md new file mode 100644 index 000000000..42cbf7518 --- /dev/null +++ b/playfab-docs/api-references/events/Functions/player-triggered-action-executed-function.md @@ -0,0 +1,30 @@ +--- +title: player_triggered_action_executed_function +author: joannaleecy +description: player_triggered_action_executed_function event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# player_triggered_action_executed_function + +This event is triggered when a CloudScript Azure Function is run as the result of a PlayStream action, and the 'Publish results as a PlayStream Event' box was checked. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|FunctionExecutionResult|[ExecuteFunctionResult](../data-types/executefunctionresult.md)|Result of the CloudScript Azure Function.| +|FunctionName|String|Name of the CloudScript Azure Function that was called.| +|TriggeringEventData|Object|The full JSON data of the event that triggered this CloudScript function to run. Useful for debugging.| +|TriggeringEventName|String|Name of the event that triggered this CloudScript function to run.| +|TriggeringPlayer|[PlayerProfile](../data-types/playerprofile.md)|JSON data profile of the player that triggered this CloudScript function to run.| +|TitleId|String|The ID of the title to which this player event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/Functions/title-scheduled-function-executed.md b/playfab-docs/api-references/events/Functions/title-scheduled-function-executed.md new file mode 100644 index 000000000..4da6bd7bf --- /dev/null +++ b/playfab-docs/api-references/events/Functions/title-scheduled-function-executed.md @@ -0,0 +1,27 @@ +--- +title: title_scheduled_function_executed +author: joannaleecy +description: title_scheduled_function_executed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# title_scheduled_function_executed + +This event is triggered when a scheduled CloudScript function is executed for a title. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|FunctionExecutionResult|[ExecuteFunctionResult](../data-types/executefunctionresult.md)|The result returned from executing the scheduled function.| +|FunctionName|String|The name of the scheduled function that was executed.| +|ScheduledTask|[NameId](../data-types/nameid.md)|The scheduled task that triggered this function execution.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Groups/group-created.md b/playfab-docs/api-references/events/Groups/group-created.md new file mode 100644 index 000000000..9f9683c83 --- /dev/null +++ b/playfab-docs/api-references/events/Groups/group-created.md @@ -0,0 +1,30 @@ +--- +title: group_created +author: joannaleecy +description: group_created event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# group_created + +This event is triggered when an entity group is created. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|CreatorEntityId|String|The identifier for the entity that created the group to which this event applies.| +|CreatorEntityType|String|The type of entity that created the group to which this event applies.| +|EntityChain|String|The chain of ownership for this entity.| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|GroupName|String|The name of the group to which this event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] + diff --git a/playfab-docs/api-references/events/Groups/group-members-added.md b/playfab-docs/api-references/events/Groups/group-members-added.md new file mode 100644 index 000000000..33d5eda4c --- /dev/null +++ b/playfab-docs/api-references/events/Groups/group-members-added.md @@ -0,0 +1,31 @@ +--- +title: group_members_added +author: joannaleecy +description: group_members_added event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# group_members_added + +This event is triggered when a member is added to an entity group. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityChain|String|The chain of ownership for this entity.| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|GroupName|String|The name of the group to which this event applies.| +|Members|[Member](../data-types/member.md)|The list of entities that were added to the group and role to which this event applies.| +|RoleId|String|The role ID of the role to which this event applies.| +|RoleName|String|The display name of the role to which this event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] + diff --git a/playfab-docs/api-references/events/Groups/group-members-removed.md b/playfab-docs/api-references/events/Groups/group-members-removed.md new file mode 100644 index 000000000..2185c99c0 --- /dev/null +++ b/playfab-docs/api-references/events/Groups/group-members-removed.md @@ -0,0 +1,28 @@ +--- +title: group_members_removed +author: joannaleecy +description: group_members_removed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# group_members_removed + +This event is triggered when a member is removed from an entity group + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityChain|String|The chain of ownership for this entity.| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|GroupName|String|The name of the group to which this event applies.| +|Members|[Member](../data-types/member.md)|The list of entities that were removed from the group to which this event applies| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Groups/group-role-created.md b/playfab-docs/api-references/events/Groups/group-role-created.md new file mode 100644 index 000000000..2b9433a8c --- /dev/null +++ b/playfab-docs/api-references/events/Groups/group-role-created.md @@ -0,0 +1,35 @@ +--- +title: group_role_created +author: joannaleecy +description: group_role_created event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# group_role_created + +This event is triggered when a role is created for a group. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|CreatorEntityId|String|The identifier for that the entity that created the role to which this event applies.| +|CreatorEntityType|String|The type of entity that created the role to which this event applies.| +|EntityChain|String|The chain of ownership for this entity.| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|GroupName|String|The name of the group to which this event applies.| +|RoleId|String|The role ID of the role to which this event applies.| +|RoleName|String|The display name of the role to which this event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] + + + + diff --git a/playfab-docs/api-references/events/Groups/group-role-deleted.md b/playfab-docs/api-references/events/Groups/group-role-deleted.md new file mode 100644 index 000000000..0c885d63a --- /dev/null +++ b/playfab-docs/api-references/events/Groups/group-role-deleted.md @@ -0,0 +1,34 @@ +--- +title: group_role_deleted +author: joannaleecy +description: group_role_deleted event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# group_role_deleted + +This event is triggered when a role is deleted from a group. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeleterEntityId|String|The identifier for the entity that deleted the role to which this event applies.| +|DeleterEntityType|String|The type of entity that deleted the role to which this event applies.| +|EntityChain|String|The chain of ownership for this entity.| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|GroupName|String|The name of the group to which this event applies.| +|RoleId|String|The role ID of the role to which this event applies.| +|RoleName|String|The display name of the role to which this event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] + + + diff --git a/playfab-docs/api-references/events/Groups/group-role-members-added.md b/playfab-docs/api-references/events/Groups/group-role-members-added.md new file mode 100644 index 000000000..87251e7ad --- /dev/null +++ b/playfab-docs/api-references/events/Groups/group-role-members-added.md @@ -0,0 +1,33 @@ +--- +title: group_role_members_added +author: joannaleecy +description: group_role_members_added event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# group_role_members_added + +This event is triggered when a list of entities are added to a role within a group. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityChain|String|The chain of ownership for this entity.| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|GroupName|String|The name of the group to which this event applies.| +|Members|[Member](../data-types/member.md)|The list of entities that were added to the group and role to which this event applies| +|RoleId|String|The role ID of the role to which this event applies.| +|RoleName|String|The display name of the role to which this event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] + + + diff --git a/playfab-docs/api-references/events/Groups/group-role-members-removed.md b/playfab-docs/api-references/events/Groups/group-role-members-removed.md new file mode 100644 index 000000000..8712f082f --- /dev/null +++ b/playfab-docs/api-references/events/Groups/group-role-members-removed.md @@ -0,0 +1,33 @@ +--- +title: group_role_members_removed +author: joannaleecy +description: group_role_members_removed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# group_role_members_removed + +This event is triggered when a list of entities are removed from a role within a group. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityChain|String|The chain of ownership for this entity.| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|GroupName|String|The name of the group to which this event applies.| +|Members|[Member](../data-types/member.md)|The list of entities that were removed from the group to which this event applies| +|RoleId|String|The role ID of the role to which this event applies.| +|RoleName|String|The display name of the role to which this event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] + + + diff --git a/playfab-docs/api-references/events/Groups/group-role-updated.md b/playfab-docs/api-references/events/Groups/group-role-updated.md new file mode 100644 index 000000000..1a4f5d154 --- /dev/null +++ b/playfab-docs/api-references/events/Groups/group-role-updated.md @@ -0,0 +1,35 @@ +--- +title: group_role_updated +author: joannaleecy +description: group_role_updated event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# group_role_updated + +This event is triggered when a role is updated within a group. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityChain|String|The chain of ownership for this entity.| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|GroupName|String|The name of the group to which this event applies.| +|NewValues|[RolePropertyValues](../data-types/rolepropertyvalues.md)|The new values of the role's changed properties| +|OldValues|[RolePropertyValues](../data-types/rolepropertyvalues.md)|The previous values of the role's changed properties| +|RoleId|String|The role ID of the role to which this event applies.| +|RoleName|String|The display name of the role to which this event applies.| +|UpdaterEntityId|String|The identifier for the entity that updated the container to which this event applies.| +|UpdaterEntityType|String|The type of entity that updated the container to which this event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] + + diff --git a/playfab-docs/api-references/events/Groups/group-updated.md b/playfab-docs/api-references/events/Groups/group-updated.md new file mode 100644 index 000000000..fd55e7a9d --- /dev/null +++ b/playfab-docs/api-references/events/Groups/group-updated.md @@ -0,0 +1,33 @@ +--- +title: group_updated +author: joannaleecy +description: group_updated event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# group_updated + +This event is triggered when an entity group is updated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityChain|String|The chain of ownership for this entity.| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|GroupName|String|The name of the group to which this event applies.| +|NewValues|[GroupPropertyValues](../data-types/grouppropertyvalues.md)|The new values of the group's changed properties| +|OldValues|[GroupPropertyValues](../data-types/grouppropertyvalues.md)|The previous values of the group's changed properties| +|UpdaterEntityId|String|The identifier for the entity that updated the group to which this event applies.| +|UpdaterEntityType|String|The type of entity that updated the group to which this event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] + + diff --git a/playfab-docs/api-references/events/Groups/members-added.md b/playfab-docs/api-references/events/Groups/members-added.md new file mode 100644 index 000000000..5309a7ffc --- /dev/null +++ b/playfab-docs/api-references/events/Groups/members-added.md @@ -0,0 +1,27 @@ +--- +title: members_added +author: joannaleecy +description: members_added event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# members_added + +This event is triggered when members are added to a group role. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Members|[EntityKey](../data-types/entitykey.md)[]|Entity keys of all members that were added to the role.| +|RoleId|String|Id of role members were added to.| +|RoleName|String|Name of role members were added to.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/Groups/members-removed.md b/playfab-docs/api-references/events/Groups/members-removed.md new file mode 100644 index 000000000..a339bb0c1 --- /dev/null +++ b/playfab-docs/api-references/events/Groups/members-removed.md @@ -0,0 +1,27 @@ +--- +title: members_removed +author: joannaleecy +description: members_removed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# members_removed + +This event is triggered when members are removed from a group role. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Members|[EntityKey](../data-types/entitykey.md)[]|Entity keys of all members that were removed from the role.| +|RoleId|String|Id of role members were removed from.| +|RoleName|String|Name of role members were removed from.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/Groups/members-role-updated.md b/playfab-docs/api-references/events/Groups/members-role-updated.md new file mode 100644 index 000000000..6fcea50e2 --- /dev/null +++ b/playfab-docs/api-references/events/Groups/members-role-updated.md @@ -0,0 +1,28 @@ +--- +title: members_role_updated +author: joannaleecy +description: members_role_updated event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# members_role_updated + +This event is triggered when existing group members change from one role to another. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Members|[EntityKey](../data-types/entitykey.md)[]|Entity keys of all members that were updated with the role.| +|Operation|[OperationTypes](../data-types/operationtypes.md)|The operation that was performed.| +|RoleId|String|Id of the role.| +|RoleName|String|Name of the role.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/Groups/player-updated-membership.md b/playfab-docs/api-references/events/Groups/player-updated-membership.md new file mode 100644 index 000000000..73d02b8a9 --- /dev/null +++ b/playfab-docs/api-references/events/Groups/player-updated-membership.md @@ -0,0 +1,31 @@ +--- +title: player_updated_membership +author: joannaleecy +description: player_updated_membership event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# player_updated_membership + +This event is triggered when a player's membership is updated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|MembershipId|String|The unique identifier for the membership.| +|MembershipName|String|The name of the membership.| +|MembershipValue|[PlayerMemberships](../data-types/playermemberships.md)|The current membership value after the update.| +|PreviousMembershipValue|[PlayerMemberships](../data-types/playermemberships.md)|The previous membership value before the update.| +|SetViaOverride|Boolean|Whether the membership was set via an override.| +|TitleId|String|The ID of the title to which this player event applies.| +|UpdatedSubscription|[Subscriptions](../data-types/subscriptions.md)|The subscription that was updated.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/Groups/role-updated.md b/playfab-docs/api-references/events/Groups/role-updated.md new file mode 100644 index 000000000..8c7a2c12a --- /dev/null +++ b/playfab-docs/api-references/events/Groups/role-updated.md @@ -0,0 +1,28 @@ +--- +title: role_updated +author: joannaleecy +description: role_updated event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# role_updated + +This event is triggered when a group role is updated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Operation|[OperationTypes](../data-types/operationtypes.md)|The operation that was performed.| +|PreviousRoleName|String|Previous name of the role.| +|RoleId|String|Id of the role to update.| +|RoleName|String|New name of the role.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/Telemetry/apikey-activated.md b/playfab-docs/api-references/events/Telemetry/apikey-activated.md new file mode 100644 index 000000000..e617ae962 --- /dev/null +++ b/playfab-docs/api-references/events/Telemetry/apikey-activated.md @@ -0,0 +1,29 @@ +--- +title: apikey_activated +author: ronnyparedes +description: apikey_activated event. +ms.author: ronnyparedes +ms.date: 09/02/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# apikey_activated + +This event is triggered when an API key is activated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| +|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| +|Payload|[APIKeyActivatedPayload](../data-types/apikeyactivatedpayload.md)|The payload of this event.| +|WriterEntity|[EntityKey](../data-types/entitykey.md)|The entity that wrote this event, included only if different from the entity specified on the event.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/Telemetry/apikey-created.md b/playfab-docs/api-references/events/Telemetry/apikey-created.md new file mode 100644 index 000000000..17d6314c4 --- /dev/null +++ b/playfab-docs/api-references/events/Telemetry/apikey-created.md @@ -0,0 +1,29 @@ +--- +title: apikey_created +author: ronnyparedes +description: apikey_created event. +ms.author: ronnyparedes +ms.date: 09/02/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# apikey_created + +This event is triggered when an API key is created. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| +|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| +|Payload|[APIKeyCreatedPayload](../data-types/apikeycreatedpayload.md)|The payload of this event.| +|WriterEntity|[EntityKey](../data-types/entitykey.md)|The entity that wrote this event, included only if different from the entity specified on the event.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/Telemetry/apikey-deactivated.md b/playfab-docs/api-references/events/Telemetry/apikey-deactivated.md new file mode 100644 index 000000000..50e43ecbe --- /dev/null +++ b/playfab-docs/api-references/events/Telemetry/apikey-deactivated.md @@ -0,0 +1,29 @@ +--- +title: apikey_deactivated +author: ronnyparedes +description: apikey_deactivated event. +ms.author: ronnyparedes +ms.date: 09/02/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# apikey_deactivated + +This event is triggered when an API key is deactivated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| +|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| +|Payload|[APIKeyDeactivatedPayload](../data-types/apikeydeactivatedpayload.md)|The payload of this event.| +|WriterEntity|[EntityKey](../data-types/entitykey.md)|The entity that wrote this event, included only if different from the entity specified on the event.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/Telemetry/apikey-deleted.md b/playfab-docs/api-references/events/Telemetry/apikey-deleted.md new file mode 100644 index 000000000..100decc64 --- /dev/null +++ b/playfab-docs/api-references/events/Telemetry/apikey-deleted.md @@ -0,0 +1,29 @@ +--- +title: apikey_deleted +author: ronnyparedes +description: apikey_deleted event. +ms.author: ronnyparedes +ms.date: 09/02/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# apikey_deleted + +This event is triggered when an API key is deleted. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.| +|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| +|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| +|Payload|[APIKeyDeletedPayload](../data-types/apikeydeletedpayload.md)|The payload of this event.| +|WriterEntity|[EntityKey](../data-types/entitykey.md)|The entity that wrote this event, included only if different from the entity specified on the event.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/TitleCommunications/email-sent.md b/playfab-docs/api-references/events/TitleCommunications/email-sent.md new file mode 100644 index 000000000..712303ea9 --- /dev/null +++ b/playfab-docs/api-references/events/TitleCommunications/email-sent.md @@ -0,0 +1,29 @@ +--- +title: email_sent +author: ronnyparedes +description: email_sent event. +ms.author: ronnyparedes +ms.date: 09/02/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# email_sent + +This event is triggered when an email is sent to a player. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EmailName|String|The name of the player's contact email.| +|EmailTemplateId|String|The email template id.| +|EmailTemplateName|String|The friendly name of the Template.| +|ErrorMessage|String|The error that occurred if failed.| +|Succeeded|Boolean|Whether the email was sent successfully.| + +## Common Properties + +[!INCLUDE [playstream-events-common-properties-v2](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/TitleCommunications/player-registered-push-notifications.md b/playfab-docs/api-references/events/TitleCommunications/player-registered-push-notifications.md new file mode 100644 index 000000000..22c06d0fb --- /dev/null +++ b/playfab-docs/api-references/events/TitleCommunications/player-registered-push-notifications.md @@ -0,0 +1,27 @@ +--- +title: player_registered_push_notifications +author: joannaleecy +description: player_registered_push_notifications event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# player_registered_push_notifications + +This event is triggered when a player registers for push notifications. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|DeviceToken|String|Unique device token registered for push notifications.| +|Platform|[PushNotificationPlatform](../data-types/pushnotificationplatform.md)|Platform on which the player is registering for push notifications.| +|TitleId|String|The ID of the title to which this player event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/TitleCommunications/push-notification-sent.md b/playfab-docs/api-references/events/TitleCommunications/push-notification-sent.md new file mode 100644 index 000000000..efd85760a --- /dev/null +++ b/playfab-docs/api-references/events/TitleCommunications/push-notification-sent.md @@ -0,0 +1,28 @@ +--- +title: push_notification_sent +author: joannaleecy +description: push_notification_sent event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# push_notification_sent + +This event is triggered when a push notification is sent to a player. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|ErrorMessage|String|The error that occurred if failed.| +|PushNotificationTemplateId|String|The push notification template id.| +|PushNotificationTemplateName|String|The friendly name of the push notification template.| +|Success|Boolean|Whether the push notification was sent successfully.| + +## Common Properties + +[!INCLUDE [playstream-events-common-properties-v2](../../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/TitleCommunications/sent-email.md b/playfab-docs/api-references/events/TitleCommunications/sent-email.md new file mode 100644 index 000000000..bb4734538 --- /dev/null +++ b/playfab-docs/api-references/events/TitleCommunications/sent-email.md @@ -0,0 +1,36 @@ +--- +title: sent_email +author: ronnyparedes +description: sent_email event. +ms.author: ronnyparedes +ms.date: 09/02/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# sent_email + +This event is triggered when an email is sent or fails to send to a player. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Body|String|The content of the email body, truncated to 4096 characters.| +|EmailName|String|The name of the player's contact email the email was sent to.| +|EmailTemplateId|String|The email template id during a send email attempt.| +|EmailTemplateName|String|The email template name during a send email attempt.| +|EmailTemplateType|[EmailTemplateType](../data-types/emailtemplatetype.md)|The email template type during a send email attempt.| +|ErrorMessage|String|The error that occurred if an email failed to send.| +|ErrorName|String|The name of the error that occurred if an email failed to send.| +|Language|String|The language the email was sent in| +|Subject|String|The content of the email subject, truncated to 1024 characters.| +|Success|Boolean|Indicates if the email was successfully sent.| +|TitleId|String|The ID of the title to which this player event applies.| +|Token|String|The auth token included in the sent email as part of a confirmation URL.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/TitleCommunications/sent-push-notification.md b/playfab-docs/api-references/events/TitleCommunications/sent-push-notification.md new file mode 100644 index 000000000..6daa0839d --- /dev/null +++ b/playfab-docs/api-references/events/TitleCommunications/sent-push-notification.md @@ -0,0 +1,33 @@ +--- +title: sent_push_notification +author: joannaleecy +description: sent_push_notification event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# sent_push_notification + +This event is triggered when a push notification is sent or fails to be sent to a player. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Body|String|The content of the push notification body, truncated to 4096 characters.| +|ErrorMessage|String|The error that occurred if the push notification failed to be sent.| +|ErrorName|String|The name of the error that occurred if the push notification failed to be sent.| +|Language|String|The language the push notification was sent in if a matching localized template was used.| +|PushNotificationTemplateId|String|The push notification template id during a send push notification attempt.| +|PushNotificationTemplateName|String|The push notification template name during a send push notification attempt.| +|Subject|String|The content of the push notification subject, truncated to 1024 characters.| +|Success|Boolean|Indicates whether the push notification was successfully sent.| +|TitleId|String|The ID of the title to which this player event applies.| + +## Common Properties + +[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/auth-token-validated.md b/playfab-docs/api-references/events/auth-token-validated.md index 0e3c0b93c..ef68c556a 100644 --- a/playfab-docs/api-references/events/auth-token-validated.md +++ b/playfab-docs/api-references/events/auth-token-validated.md @@ -24,18 +24,4 @@ This event is triggered when an email confirmation link is clicked. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/build-alias-created.md b/playfab-docs/api-references/events/build-alias-created.md new file mode 100644 index 000000000..aa9694760 --- /dev/null +++ b/playfab-docs/api-references/events/build-alias-created.md @@ -0,0 +1,26 @@ +--- +title: build_alias_created +author: valexao +description: build_alias_created event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# build_alias_created + +This event is triggered when a multiplayer server build alias is created. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[BuildAliasCreatedEventPayload](data-types/buildaliascreatedeventpayload.md)|The multiplayer server build alias created event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/build-alias-deleted.md b/playfab-docs/api-references/events/build-alias-deleted.md new file mode 100644 index 000000000..babf5b7f0 --- /dev/null +++ b/playfab-docs/api-references/events/build-alias-deleted.md @@ -0,0 +1,26 @@ +--- +title: build_alias_deleted +author: valexao +description: build_alias_deleted event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# build_alias_deleted + +This event is triggered when a multiplayer server build alias is deleted. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[BuildAliasDeletedEventPayload](data-types/buildaliasdeletedeventpayload.md)|The multiplayer server build alias deleted event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/build-alias-updated.md b/playfab-docs/api-references/events/build-alias-updated.md new file mode 100644 index 000000000..69d72c93b --- /dev/null +++ b/playfab-docs/api-references/events/build-alias-updated.md @@ -0,0 +1,27 @@ +--- +title: build_alias_updated +author: valexao +description: build_alias_updated event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# build_alias_updated + +This event is triggered when a multiplayer server build alias is updated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[BuildAliasUpdatedEventPayload](data-types/buildaliasupdatedeventpayload.md)|The multiplayer server build alias updated event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/build-deleted.md b/playfab-docs/api-references/events/build-deleted.md new file mode 100644 index 000000000..fdbe4f5a7 --- /dev/null +++ b/playfab-docs/api-references/events/build-deleted.md @@ -0,0 +1,28 @@ +--- +title: build_deleted +author: joannaleecy +description: build_deleted event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# build_deleted + +This event is triggered when a multiplayer server build is deleted. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[BuildDeletedEventPayload](data-types/builddeletedeventpayload.md)|The multiplayer server build deleted event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + + diff --git a/playfab-docs/api-references/events/build-region-status-changed.md b/playfab-docs/api-references/events/build-region-status-changed.md new file mode 100644 index 000000000..0471bdc63 --- /dev/null +++ b/playfab-docs/api-references/events/build-region-status-changed.md @@ -0,0 +1,28 @@ +--- +title: build_region_status_changed +author: joannaleecy +description: build_region_status_changed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# build_region_status_changed + +This event is triggered when a multiplayer server's build region status is changed. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[BuildRegionStatusChangedEventPayload](data-types/buildregionstatuschangedeventpayload.md)|The multiplayer server build region status changed event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + + diff --git a/playfab-docs/api-references/events/build-region-updated.md b/playfab-docs/api-references/events/build-region-updated.md new file mode 100644 index 000000000..44ca49a79 --- /dev/null +++ b/playfab-docs/api-references/events/build-region-updated.md @@ -0,0 +1,27 @@ +--- +title: build_region_updated +author: joannaleecy +description: build_region_updated event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# build_region_updated + +This event is triggered when a multiplayer server build region is updated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[BuildRegionUpdatedEventPayload](data-types/buildregionupdatedeventpayload.md)|The multiplayer server build region updated event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/build-region-utilization.md b/playfab-docs/api-references/events/build-region-utilization.md new file mode 100644 index 000000000..0a87a9e95 --- /dev/null +++ b/playfab-docs/api-references/events/build-region-utilization.md @@ -0,0 +1,27 @@ +--- +title: build_region_utilization +author: valexao +description: build_region_utilization event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# build_region_utilization + +This event is triggered to display the utilization of servers for a build in each region. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[BuildRegionUtilizationEventPayload](data-types/buildregionutilizationeventpayload.md)|The multiplayer server build region utilization event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/certificate-deleted.md b/playfab-docs/api-references/events/certificate-deleted.md new file mode 100644 index 000000000..5f4987aa9 --- /dev/null +++ b/playfab-docs/api-references/events/certificate-deleted.md @@ -0,0 +1,26 @@ +--- +title: certificate_deleted +author: joannaleecy +description: certificate_deleted event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# certificate_deleted + +This event is triggered when a multiplayer server certificate is deleted. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[CertificateDeletedEventPayload](data-types/certificatedeletedeventpayload.md)|The multiplayer server certificate deleted event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/certificate-uploaded.md b/playfab-docs/api-references/events/certificate-uploaded.md new file mode 100644 index 000000000..6a334d05b --- /dev/null +++ b/playfab-docs/api-references/events/certificate-uploaded.md @@ -0,0 +1,27 @@ +--- +title: certificate_uploaded +author: joannaleecy +description: certificate_uploaded event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# certificate_uploaded + +This event is triggered when a multiplayer server certificate is uploaded. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[CertificateUploadedEventPayload](data-types/certificateuploadedeventpayload.md)|The multiplayer server certificate uploaded event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/character-consumed-item.md b/playfab-docs/api-references/events/character-consumed-item.md index b2ad18335..88ee4d266 100644 --- a/playfab-docs/api-references/events/character-consumed-item.md +++ b/playfab-docs/api-references/events/character-consumed-item.md @@ -28,18 +28,4 @@ This event is triggered when a character consumes an item from their inventory. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/character-created.md b/playfab-docs/api-references/events/character-created.md index f47f302a0..04fdef752 100644 --- a/playfab-docs/api-references/events/character-created.md +++ b/playfab-docs/api-references/events/character-created.md @@ -25,18 +25,4 @@ This event is triggered when a character is created for the first time. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/character-inventory-item-added.md b/playfab-docs/api-references/events/character-inventory-item-added.md index 87e2edbe4..cd36929d2 100644 --- a/playfab-docs/api-references/events/character-inventory-item-added.md +++ b/playfab-docs/api-references/events/character-inventory-item-added.md @@ -33,18 +33,4 @@ This event is triggered when an item is granted to a character. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/character-statistic-changed.md b/playfab-docs/api-references/events/character-statistic-changed.md index 6d36ea590..3a8fe5345 100644 --- a/playfab-docs/api-references/events/character-statistic-changed.md +++ b/playfab-docs/api-references/events/character-statistic-changed.md @@ -27,18 +27,4 @@ This event is triggered when a character statistic is changed. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/character-statistic-deleted.md b/playfab-docs/api-references/events/character-statistic-deleted.md index a971bb771..31c7b4b80 100644 --- a/playfab-docs/api-references/events/character-statistic-deleted.md +++ b/playfab-docs/api-references/events/character-statistic-deleted.md @@ -25,18 +25,4 @@ This event is triggered when a character statistic is deleted. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/character-vc-item-purchased.md b/playfab-docs/api-references/events/character-vc-item-purchased.md index f145fbbc0..fd58520c1 100644 --- a/playfab-docs/api-references/events/character-vc-item-purchased.md +++ b/playfab-docs/api-references/events/character-vc-item-purchased.md @@ -30,18 +30,4 @@ This event is triggered when the character makes a purchase using virtual curren ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/character-virtual-currency-balance-changed.md b/playfab-docs/api-references/events/character-virtual-currency-balance-changed.md index e94de6bc3..26922799c 100644 --- a/playfab-docs/api-references/events/character-virtual-currency-balance-changed.md +++ b/playfab-docs/api-references/events/character-virtual-currency-balance-changed.md @@ -27,18 +27,4 @@ This event is triggered when a character's virtual currency balance changes. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/client-focus-change.md b/playfab-docs/api-references/events/client-focus-change.md index 83f0f472f..f6b179762 100644 --- a/playfab-docs/api-references/events/client-focus-change.md +++ b/playfab-docs/api-references/events/client-focus-change.md @@ -26,18 +26,4 @@ This event is triggered every time the application enters or exits focus on the ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/client-session-start.md b/playfab-docs/api-references/events/client-session-start.md index c459a1cb7..04046abf0 100644 --- a/playfab-docs/api-references/events/client-session-start.md +++ b/playfab-docs/api-references/events/client-session-start.md @@ -26,18 +26,4 @@ Properties ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/crash-detected.md b/playfab-docs/api-references/events/crash-detected.md new file mode 100644 index 000000000..9f3e6a6c7 --- /dev/null +++ b/playfab-docs/api-references/events/crash-detected.md @@ -0,0 +1,27 @@ +--- +title: crash_detected +author: valexao +description: crash_detected event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# crash_detected + +This event triggered when a crash dump is found on a terminating server. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[CrashDetectedEventPayload](data-types/crashdetectedeventpayload.md)|The multiplayer server crash detected event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/create-build-initiated.md b/playfab-docs/api-references/events/create-build-initiated.md new file mode 100644 index 000000000..0eeba5338 --- /dev/null +++ b/playfab-docs/api-references/events/create-build-initiated.md @@ -0,0 +1,27 @@ +--- +title: create_build_initiated +author: joannaleecy +description: create_build_initiated event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# create_build_initiated + +This event is triggered when a multiplayer server build is initiated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[CreateBuildInitiatedEventPayload](data-types/createbuildinitiatedeventpayload.md)|The multiplayer server create build initiated event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/data-types/addonprovisioningstate.md b/playfab-docs/api-references/events/data-types/addonprovisioningstate.md new file mode 100644 index 000000000..7de52da43 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/addonprovisioningstate.md @@ -0,0 +1,27 @@ +--- +title: AddOnProvisioningState +author: playfab +description: AddOnProvisioningState data type. +ms.author: playfab +ms.date: 01/27/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# AddOnProvisioningState + +Represents the provisioning state of an AddOn. + +## Values + +|Value|Description| +| :--------------------|:----------------------| +|Inactive|The AddOn is inactive.| +|Active|The AddOn is active.| +|Pending|The AddOn is pending provisioning.| +|PendingWithError|The AddOn is pending with an error.| +|Paused|The AddOn is paused.| +|Waitlist|The AddOn is on a waitlist.| +|Unknown|None of the above states.| diff --git a/playfab-docs/api-references/events/data-types/apikeyactivatedpayload.md b/playfab-docs/api-references/events/data-types/apikeyactivatedpayload.md new file mode 100644 index 000000000..6d224a0ea --- /dev/null +++ b/playfab-docs/api-references/events/data-types/apikeyactivatedpayload.md @@ -0,0 +1,17 @@ +--- +author: WarrenAlpert +title: APIKeyActivatedPayload +description: Payload for when an entity API key is activated. +ms.author: waralper +ms.topic: reference +--- + +# APIKeyActivatedPayload + +Payload for when an entity API key is activated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|APIKeyId|String|Unique identifier for the entity API key.| diff --git a/playfab-docs/api-references/events/data-types/apikeycreatedpayload.md b/playfab-docs/api-references/events/data-types/apikeycreatedpayload.md new file mode 100644 index 000000000..35e670a2e --- /dev/null +++ b/playfab-docs/api-references/events/data-types/apikeycreatedpayload.md @@ -0,0 +1,18 @@ +--- +author: WarrenAlpert +title: APIKeyCreatedPayload +description: Payload for when an entity API key is created. +ms.author: waralper +ms.topic: reference +--- + +# APIKeyCreatedPayload + +Payload for when an entity API key is created. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|APIKeyId|String|Unique identifier for the entity API key.| +|Active|Boolean|Indicates whether the API key is active or not.| diff --git a/playfab-docs/api-references/events/data-types/apikeydeactivatedpayload.md b/playfab-docs/api-references/events/data-types/apikeydeactivatedpayload.md new file mode 100644 index 000000000..487df9ac9 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/apikeydeactivatedpayload.md @@ -0,0 +1,17 @@ +--- +author: WarrenAlpert +title: APIKeyDeactivatedPayload +description: Payload for when an entity API key is deactivated. +ms.author: waralper +ms.topic: reference +--- + +# APIKeyDeactivatedPayload + +Payload for when an entity API key is deactivated. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|APIKeyId|String|Unique identifier for the entity API key.| diff --git a/playfab-docs/api-references/events/data-types/apikeydeletedpayload.md b/playfab-docs/api-references/events/data-types/apikeydeletedpayload.md new file mode 100644 index 000000000..5752b890c --- /dev/null +++ b/playfab-docs/api-references/events/data-types/apikeydeletedpayload.md @@ -0,0 +1,17 @@ +--- +author: WarrenAlpert +title: APIKeyDeletedPayload +description: Payload for when an entity API key is deleted. +ms.author: waralper +ms.topic: reference +--- + +# APIKeyDeletedPayload + +Payload for when an entity API key is deleted. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|APIKeyId|String|Unique identifier for the entity API key.| diff --git a/playfab-docs/api-references/events/data-types/artifact.md b/playfab-docs/api-references/events/data-types/artifact.md new file mode 100644 index 000000000..6c0f3fe05 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/artifact.md @@ -0,0 +1,23 @@ +--- +title: Artifact +author: ronnyparedes +description: Artifact data type. +ms.author: ronnyparedes +ms.date: 09/02/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# Artifact + +Provides details about an exported artifact (e.g Azure blob, Amazon S3 object, etc.) + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|NumberOfEvents|int64|The number of events in the artifact.| +|Path|String|The location in storage where the artifact was written to.| +|SizeInBytes|int64|The size of the artifact in bytes.| diff --git a/playfab-docs/api-references/events/data-types/buildaliascreatedeventpayload.md b/playfab-docs/api-references/events/data-types/buildaliascreatedeventpayload.md new file mode 100644 index 000000000..c6cb27d95 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/buildaliascreatedeventpayload.md @@ -0,0 +1,20 @@ +--- +title: BuildAliasCreatedEventPayload +author: valexao +description: BuildAliasCreatedEventPayload data type. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# BuildAliasCreatedEventPayload + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|AliasName|String|The name of the build alias that was created.| +|AliasId|String|The Guid ID of the build alias that was created.| diff --git a/playfab-docs/api-references/events/data-types/buildaliasdeletedeventpayload.md b/playfab-docs/api-references/events/data-types/buildaliasdeletedeventpayload.md new file mode 100644 index 000000000..a585f18ff --- /dev/null +++ b/playfab-docs/api-references/events/data-types/buildaliasdeletedeventpayload.md @@ -0,0 +1,19 @@ +--- +title: BuildAliasDeletedEventPayload +author: valexao +description: BuildAliasDeletedEventPayload data type. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# BuildAliasDeletedEventPayload + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|AliasId|String|The Guid ID of the build alias that was deleted.| diff --git a/playfab-docs/api-references/events/data-types/buildaliasupdatedeventpayload.md b/playfab-docs/api-references/events/data-types/buildaliasupdatedeventpayload.md new file mode 100644 index 000000000..67c1eab2e --- /dev/null +++ b/playfab-docs/api-references/events/data-types/buildaliasupdatedeventpayload.md @@ -0,0 +1,20 @@ +--- +title: BuildAliasUpdatedEventPayload +author: valexao +description: BuildAliasUpdatedEventPayload data type. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# BuildAliasUpdatedEventPayload + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|AliasName|String|The name of the build alias that was updated.| +|AliasId|String|The Guid ID of the build alias that was updated.| diff --git a/playfab-docs/api-references/events/data-types/multiplayerserverbuilddeletedeventpayload.md b/playfab-docs/api-references/events/data-types/builddeletedeventpayload.md similarity index 70% rename from playfab-docs/api-references/events/data-types/multiplayerserverbuilddeletedeventpayload.md rename to playfab-docs/api-references/events/data-types/builddeletedeventpayload.md index 264ec7491..50343df28 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerserverbuilddeletedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/builddeletedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerBuildDeletedEventPayload +title: BuildDeletedEventPayload author: joannaleecy -description: MultiplayerServerBuildDeletedEventPayload data type. +description: BuildDeletedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerBuildDeletedEventPayload +# BuildDeletedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/multiplayerserverbuildregionstatuschangedeventpayload.md b/playfab-docs/api-references/events/data-types/buildregionstatuschangedeventpayload.md similarity index 74% rename from playfab-docs/api-references/events/data-types/multiplayerserverbuildregionstatuschangedeventpayload.md rename to playfab-docs/api-references/events/data-types/buildregionstatuschangedeventpayload.md index 58c5bf085..d55fae1eb 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerserverbuildregionstatuschangedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/buildregionstatuschangedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerBuildRegionStatusChangedEventPayload +title: BuildRegionStatusChangedEventPayload author: joannaleecy -description: MultiplayerServerBuildRegionStatusChangedEventPayload data type. +description: BuildRegionStatusChangedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerBuildRegionStatusChangedEventPayload +# BuildRegionStatusChangedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/multiplayerserverbuildregionupdatedeventpayload.md b/playfab-docs/api-references/events/data-types/buildregionupdatedeventpayload.md similarity index 74% rename from playfab-docs/api-references/events/data-types/multiplayerserverbuildregionupdatedeventpayload.md rename to playfab-docs/api-references/events/data-types/buildregionupdatedeventpayload.md index 46c25e274..49533b362 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerserverbuildregionupdatedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/buildregionupdatedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerBuildRegionUpdatedEventPayload +title: BuildRegionUpdatedEventPayload author: joannaleecy -description: MultiplayerServerBuildRegionUpdatedEventPayload data type. +description: BuildRegionUpdatedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerBuildRegionUpdatedEventPayload +# BuildRegionUpdatedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/buildregionutilizationeventpayload.md b/playfab-docs/api-references/events/data-types/buildregionutilizationeventpayload.md new file mode 100644 index 000000000..f59a30494 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/buildregionutilizationeventpayload.md @@ -0,0 +1,25 @@ +--- +title: BuildRegionUtilizationEventPayload +author: valexao +description: BuildRegionUtilizationEventPayload data type. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# BuildRegionUtilizationEventPayload + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|BuildId|String|The guid string ID of the multiplayer server build that regions were updated on.| +|Region|[AzureRegion](azureregion.md)|The build region.| +|Active|Int|The number of active servers.| +|StandingBy|Int|The number of standingby servers.| +|Propping|Int|The number of servers still downloading game resources.| +|Total|Int|The total number of servers.| +|VmCount|Int|The total number of running virtual machines.| diff --git a/playfab-docs/api-references/events/data-types/multiplayerservercertificatedeletedeventpayload.md b/playfab-docs/api-references/events/data-types/certificatedeletedeventpayload.md similarity index 67% rename from playfab-docs/api-references/events/data-types/multiplayerservercertificatedeletedeventpayload.md rename to playfab-docs/api-references/events/data-types/certificatedeletedeventpayload.md index 0de591ca1..a6c2fd2db 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerservercertificatedeletedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/certificatedeletedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerCertificateDeletedEventPayload +title: CertificateDeletedEventPayload author: joannaleecy -description: MultiplayerServerCertificateDeletedEventPayload data type. +description: CertificateDeletedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerCertificateDeletedEventPayload +# CertificateDeletedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/multiplayerservercertificateuploadedeventpayload.md b/playfab-docs/api-references/events/data-types/certificateuploadedeventpayload.md similarity index 66% rename from playfab-docs/api-references/events/data-types/multiplayerservercertificateuploadedeventpayload.md rename to playfab-docs/api-references/events/data-types/certificateuploadedeventpayload.md index e85c07fac..cd663316e 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerservercertificateuploadedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/certificateuploadedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MMultiplayerServerCertificateUploadedEventPayload +title: CertificateUploadedEventPayload author: joannaleecy -description: MultiplayerServerCertificateUploadedEventPayload data type. +description: CertificateUploadedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerCertificateUploadedEventPayload +# CertificateUploadedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/crashdetectedeventpayload.md b/playfab-docs/api-references/events/data-types/crashdetectedeventpayload.md new file mode 100644 index 000000000..38ce9d734 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/crashdetectedeventpayload.md @@ -0,0 +1,24 @@ +--- +title: CrashDetectedEventPayload +author: valexao +description: CrashDetectedEventPayload data type. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# CrashDetectedEventPayload + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|BuildId|String|The guid string ID of the multiplayer server build that regions were updated on.| +|Region|[AzureRegion](azureregion.md)|The build region.| +|ServerId|String|The guid string ID of the session.| +|VmId|String|The virtual machine ID the multiplayer server is located on.| +|CrashDumpUploaded|bool|If true, the crash dump was uploaded with the server's logs.| +|CrashDumpStatus|String|The reason a crash dump wasn't uploaded. If null, assume no crash dump was found.| diff --git a/playfab-docs/api-references/events/data-types/multiplayerservercreatebuildinitiatedeventpayload.md b/playfab-docs/api-references/events/data-types/createbuildinitiatedeventpayload.md similarity index 73% rename from playfab-docs/api-references/events/data-types/multiplayerservercreatebuildinitiatedeventpayload.md rename to playfab-docs/api-references/events/data-types/createbuildinitiatedeventpayload.md index 0a3b999be..d4827582c 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerservercreatebuildinitiatedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/createbuildinitiatedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerCreateBuildInitiatedEventPayload +title: CreateBuildInitiatedEventPayload author: joannaleecy -description: MultiplayerServerCreateBuildInitiatedEventPayload data type. +description: CreateBuildInitiatedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerCreateBuildInitiatedEventPayload +# CreateBuildInitiatedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/entityobject.md b/playfab-docs/api-references/events/data-types/entityobject.md new file mode 100644 index 000000000..3367f81c2 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/entityobject.md @@ -0,0 +1,20 @@ +--- +title: EntityObject +author: valexao +description: EntityObject data type. +ms.author: vorelien +ms.date: 01/21/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# EntityObject + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Id|String|Unique ID of the entity.| +|Type|String|One of the [available built-in entity types](../../../live-service-management/game-configuration/entities/available-built-in-entity-types.md).| \ No newline at end of file diff --git a/playfab-docs/api-references/events/data-types/eventexportcompletionstatus.md b/playfab-docs/api-references/events/data-types/eventexportcompletionstatus.md new file mode 100644 index 000000000..413ecfb9e --- /dev/null +++ b/playfab-docs/api-references/events/data-types/eventexportcompletionstatus.md @@ -0,0 +1,22 @@ +--- +title: EventExportCompletionStatus +author: joannaleecy +description: EventExportCompletionStatus data type. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# EventExportCompletionStatus + +The possible status upon completion of an event export execution. + +## Values + +|Name|Description| +| :--------------------|:----------------------| +|Failed|The export execution failed.| +|Succeeded|The export execution succeeded.| diff --git a/playfab-docs/api-references/events/data-types/executefunctionresult.md b/playfab-docs/api-references/events/data-types/executefunctionresult.md new file mode 100644 index 000000000..f095ec221 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/executefunctionresult.md @@ -0,0 +1,26 @@ +--- +title: ExecuteFunctionResult +author: joannaleecy +description: ExecuteFunctionResult data type. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# ExecuteFunctionResult + +The result from executing a CloudScript Azure Function. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Error|[FunctionExecutionError](functionexecutionerror.md)|Error from the CloudScript Azure Function, if any.| +|ExecutionTimeMilliseconds|int|The amount of time the function took to execute in milliseconds.| +|FunctionName|String|The name of the function that executed.| +|FunctionResult|Object|The object returned from the function, if any.| +|FunctionResultSize|int|The size in bytes of the object returned from the function, if any.| +|FunctionResultTooLarge|Boolean|Flag indicating if the FunctionResult was too large and was subsequently dropped from this event.| diff --git a/playfab-docs/api-references/events/data-types/fullnameobject.md b/playfab-docs/api-references/events/data-types/fullnameobject.md new file mode 100644 index 000000000..15824cd78 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/fullnameobject.md @@ -0,0 +1,20 @@ +--- +title: FullNameObject +author: valexao +description: FullNameObject data type. +ms.author: vorelien +ms.date: 01/21/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# FullNameObject + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EventName|String|The name of this event.| +|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| \ No newline at end of file diff --git a/playfab-docs/api-references/events/data-types/multiplayerservergameassetdeletedeventpayload.md b/playfab-docs/api-references/events/data-types/gameassetdeletedeventpayload.md similarity index 67% rename from playfab-docs/api-references/events/data-types/multiplayerservergameassetdeletedeventpayload.md rename to playfab-docs/api-references/events/data-types/gameassetdeletedeventpayload.md index 3c90072f2..12cdf018b 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerservergameassetdeletedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/gameassetdeletedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerGameAssetDeletedEventPayload +title: GameAssetDeletedEventPayload author: joannaleecy -description: MMultiplayerServerGameAssetDeletedEventPayload data type. +description: GameAssetDeletedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerGameAssetDeletedEventPayload +# GameAssetDeletedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/gamecertificatedeployed.md b/playfab-docs/api-references/events/data-types/gamecertificatedeployed.md new file mode 100644 index 000000000..c5356515f --- /dev/null +++ b/playfab-docs/api-references/events/data-types/gamecertificatedeployed.md @@ -0,0 +1,24 @@ +--- +title: GameCertificateDeployed +author: valexao +description: GameCertificateDeployed data type. +ms.author: vorelien +ms.date: 12/10/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# GameCertificateDeployed + +Information about the game certificate deployed in the VM. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Name|String|The certificate name.| +|Thumbprint|String|The certificate thumbprint.| +|Version|String|The certificate version.| +|Expiration|String|The certificate expiration date.| diff --git a/playfab-docs/api-references/events/data-types/gamesaveconflict.md b/playfab-docs/api-references/events/data-types/gamesaveconflict.md new file mode 100644 index 000000000..3ad1941e1 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/gamesaveconflict.md @@ -0,0 +1,20 @@ +--- +title: GameSaveConflict +author: alzakrze +description: GameSaveConflict data type. +ms.author: alzakrze +ms.date: 01/22/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events, gamesave +ms.localizationpriority: medium +--- + +# GameSaveConflict + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|ConflictingVersion|Int64|The ID of the version that was in conflict with this version. That version should be assumed to have the opposite IsWinner value.| +|IsWinner|Boolean|Whether this version is the winner of the conflict resolution process.| diff --git a/playfab-docs/api-references/events/data-types/loginidentityprovider.md b/playfab-docs/api-references/events/data-types/loginidentityprovider.md index 13cad61f2..d4e6cc636 100644 --- a/playfab-docs/api-references/events/data-types/loginidentityprovider.md +++ b/playfab-docs/api-references/events/data-types/loginidentityprovider.md @@ -1,9 +1,9 @@ --- title: LoginIdentityProvider -author: joannaleecy +author: yuto chikazawa description: LoginIdentityProvider data type. -ms.author: jenelleb -ms.date: 02/19/2019 +ms.author: ychikazawa +ms.date: 08/19/2025 ms.topic: article ms.service: azure-playfab keywords: playfab, playstream events @@ -35,3 +35,9 @@ ms.localizationpriority: medium |NintendoSwitch| |FacebookInstantGames| |OpenIdConnect| +|Apple| +|NintendoSwitchAccount| +|GooglePlayGames| +|XboxMobileStore| +|King| +|BattleNet| diff --git a/playfab-docs/api-references/events/data-types/monitoringoutputsavedeventpayload.md b/playfab-docs/api-references/events/data-types/monitoringoutputsavedeventpayload.md new file mode 100644 index 000000000..08c74dc0c --- /dev/null +++ b/playfab-docs/api-references/events/data-types/monitoringoutputsavedeventpayload.md @@ -0,0 +1,24 @@ +--- +title: MonitoringOutputSavedEventPayload +author: valexao +description: MonitoringOutputSavedEventPayload data type. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# MonitoringOutputSavedEventPayload + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|BuildId|String|The Guid string ID of the build.| +|Region|[AzureRegion](azureregion.md)|The build region.| +|ServerId|String|The multiplayer server ID.| +|SessionId|String|The Guid string ID of the session.| +|VmId|String|The virtual machine ID the multiplayer server is located on.| +|IsVmLevel|bool|True if the monitoring output was not associated with a running server.| diff --git a/playfab-docs/api-references/events/data-types/originatorobject.md b/playfab-docs/api-references/events/data-types/originatorobject.md new file mode 100644 index 000000000..40a3560c7 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/originatorobject.md @@ -0,0 +1,20 @@ +--- +title: OriginatorObject +author: valexao +description: OriginatorObject data type. +ms.author: vorelien +ms.date: 01/21/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# OriginatorObject + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Id|String|Source of the Playstream event - will be PlayFab if the event originated from us.| +|Type|String|The type of the source of this event. List of possible values found here: [SourceType](../data-types/sourcetype.md)| \ No newline at end of file diff --git a/playfab-docs/api-references/events/data-types/secretaddedeventpayload.md b/playfab-docs/api-references/events/data-types/secretaddedeventpayload.md new file mode 100644 index 000000000..07c3fa7c3 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/secretaddedeventpayload.md @@ -0,0 +1,19 @@ +--- +title: SecretAddedEventPayload +author: valexao +description: SecretAddedEventPayload data type. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# SecretAddedEventPayload + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|SecretName|String|The name of the secret that was added.| diff --git a/playfab-docs/api-references/events/data-types/secretdeletedeventpayload.md b/playfab-docs/api-references/events/data-types/secretdeletedeventpayload.md new file mode 100644 index 000000000..83aa53d1a --- /dev/null +++ b/playfab-docs/api-references/events/data-types/secretdeletedeventpayload.md @@ -0,0 +1,19 @@ +--- +title: SecretDeletedEventPayload +author: valexao +description: SecretDeletedEventPayload data type. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# SecretDeletedEventPayload + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|SecretName|String|The name of the secret that was deleted.| diff --git a/playfab-docs/api-references/events/data-types/multiplayerserverrequestedeventpayload.md b/playfab-docs/api-references/events/data-types/serverrequestedeventpayload.md similarity index 86% rename from playfab-docs/api-references/events/data-types/multiplayerserverrequestedeventpayload.md rename to playfab-docs/api-references/events/data-types/serverrequestedeventpayload.md index d0fbbf6d0..d710af185 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerserverrequestedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/serverrequestedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerRequestedEventPayload +title: ServerRequestedEventPayload author: joannaleecy -description: MultiplayerServerRequestedEventPayload data type. +description: ServerRequestedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerRequestedEventPayload +# ServerRequestedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/multiplayerserverstatechangedeventpayload.md b/playfab-docs/api-references/events/data-types/serverstatechangedeventpayload.md similarity index 80% rename from playfab-docs/api-references/events/data-types/multiplayerserverstatechangedeventpayload.md rename to playfab-docs/api-references/events/data-types/serverstatechangedeventpayload.md index ff1961a84..82840961c 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerserverstatechangedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/serverstatechangedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerStateChangedEventPayload +title: ServerStateChangedEventPayload author: joannaleecy -description: MultiplayerServerStateChangedEventPayload data type. +description: ServerStateChangedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerStateChangedEventPayload +# ServerStateChangedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/multiplayerservervmassignedeventpayload.md b/playfab-docs/api-references/events/data-types/vmassignedeventpayload.md similarity index 81% rename from playfab-docs/api-references/events/data-types/multiplayerservervmassignedeventpayload.md rename to playfab-docs/api-references/events/data-types/vmassignedeventpayload.md index 051ec25a4..71ed8541c 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerservervmassignedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/vmassignedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerVmAssignedEventPayload +title: VmAssignedEventPayload author: joannaleecy -description: MultiplayerServerVmAssignedEventPayload data type. +description: VmAssignedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerVmAssignedEventPayload +# VmAssignedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/vmgamecertificatesdeployedeventpayload.md b/playfab-docs/api-references/events/data-types/vmgamecertificatesdeployedeventpayload.md new file mode 100644 index 000000000..bf2559090 --- /dev/null +++ b/playfab-docs/api-references/events/data-types/vmgamecertificatesdeployedeventpayload.md @@ -0,0 +1,22 @@ +--- +title: VmGameCertificatesDeployedEventPayload +author: valexao +description: VmGameCertificatesDeployedEventPayload data type. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# VmGameCertificatesDeployedEventPayload + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|BuildId|String|The GUID string ID of the build.| +|Region|[AzureRegion](azureregion.md)|The build region.| +|VmId|String|The ID of the virtual machine that was assigned.| +|GameCertificates|[List\](gamecertificatedeployed.md)|The list of game certificates deployed.| diff --git a/playfab-docs/api-references/events/data-types/multiplayerservervmremoteusercreatedeventpayload.md b/playfab-docs/api-references/events/data-types/vmremoteusercreatedeventpayload.md similarity index 74% rename from playfab-docs/api-references/events/data-types/multiplayerservervmremoteusercreatedeventpayload.md rename to playfab-docs/api-references/events/data-types/vmremoteusercreatedeventpayload.md index 1b8cfcaad..e8b5f7a32 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerservervmremoteusercreatedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/vmremoteusercreatedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerVmRemoteUserCreatedEventPayload +title: VmRemoteUserCreatedEventPayload author: joannaleecy -description: MultiplayerServerVmRemoteUserCreatedEventPayload data type. +description: VmRemoteUserCreatedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerVmRemoteUserCreatedEventPayload +# VmRemoteUserCreatedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/multiplayerservervmremoteuserdeletedeventpayload.md b/playfab-docs/api-references/events/data-types/vmremoteuserdeletedeventpayload.md similarity index 76% rename from playfab-docs/api-references/events/data-types/multiplayerservervmremoteuserdeletedeventpayload.md rename to playfab-docs/api-references/events/data-types/vmremoteuserdeletedeventpayload.md index 23f32a80a..8f32e251a 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerservervmremoteuserdeletedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/vmremoteuserdeletedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerVmRemoteUserDeletedEventPayload +title: VmRemoteUserDeletedEventPayload author: joannaleecy -description: MultiplayerServerVmRemoteUserDeletedEventPayload data type. +description: VmRemoteUserDeletedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerVmRemoteUserDeletedEventPayload +# VmRemoteUserDeletedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/vmstatechangeeventpayload.md b/playfab-docs/api-references/events/data-types/vmstatechangeeventpayload.md new file mode 100644 index 000000000..76a303e7a --- /dev/null +++ b/playfab-docs/api-references/events/data-types/vmstatechangeeventpayload.md @@ -0,0 +1,23 @@ +--- +title: VmStateChangeEventPayload +author: valexao +description: VmStateChangeEventPayload data type. +ms.author: vorelien +ms.date: 12/10/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# VmStateChangeEventPayload + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|BuildId|String|The guid string ID of the multiplayer server build that regions were updated on.| +|Region|[AzureRegion](azureregion.md)|The build region.| +|VmId|String|The virtual machine ID of the multiplayer vm.| +|State|String|The multiplayer virtual machine's state to report on.| +|DurationSeconds|ulong|The amount of time spent getting to this state.| diff --git a/playfab-docs/api-references/events/data-types/multiplayerservervmunassignmentstartedeventpayload.md b/playfab-docs/api-references/events/data-types/vmunassignmentstartedeventpayload.md similarity index 81% rename from playfab-docs/api-references/events/data-types/multiplayerservervmunassignmentstartedeventpayload.md rename to playfab-docs/api-references/events/data-types/vmunassignmentstartedeventpayload.md index bc7181532..4c6ebc46e 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerservervmunassignmentstartedeventpayload.md +++ b/playfab-docs/api-references/events/data-types/vmunassignmentstartedeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerVmUnassignmentStartedEventPayload +title: VmUnassignmentStartedEventPayload author: joannaleecy -description: MultiplayerServerVmUnassignmentStartedEventPayload data type. +description: VmUnassignmentStartedEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerVmUnassignmentStartedEventPayload +# VmUnassignmentStartedEventPayload ## Properties diff --git a/playfab-docs/api-references/events/data-types/multiplayerservervmunhealthyeventpayload.md b/playfab-docs/api-references/events/data-types/vmunhealthyeventpayload.md similarity index 76% rename from playfab-docs/api-references/events/data-types/multiplayerservervmunhealthyeventpayload.md rename to playfab-docs/api-references/events/data-types/vmunhealthyeventpayload.md index a02a85421..c0c3f5898 100644 --- a/playfab-docs/api-references/events/data-types/multiplayerservervmunhealthyeventpayload.md +++ b/playfab-docs/api-references/events/data-types/vmunhealthyeventpayload.md @@ -1,7 +1,7 @@ --- -title: MultiplayerServerVmUnhealthyEventPayload +title: VmUnhealthyEventPayload author: joannaleecy -description: MultiplayerServerVmUnhealthyEventPayload data type. +description: VmUnhealthyEventPayload data type. ms.author: jenelleb ms.date: 02/19/2019 ms.topic: article @@ -10,7 +10,7 @@ keywords: playfab, playstream events ms.localizationpriority: medium --- -# MultiplayerServerVmUnhealthyEventPayload +# VmUnhealthyEventPayload ## Properties diff --git a/playfab-docs/api-references/events/display-name-filtered.md b/playfab-docs/api-references/events/display-name-filtered.md index 598a70cad..4bfc95247 100644 --- a/playfab-docs/api-references/events/display-name-filtered.md +++ b/playfab-docs/api-references/events/display-name-filtered.md @@ -23,18 +23,4 @@ This event is triggered when a display name is filtered by community sift. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/enabled-for-title.md b/playfab-docs/api-references/events/enabled-for-title.md new file mode 100644 index 000000000..5cd64b4aa --- /dev/null +++ b/playfab-docs/api-references/events/enabled-for-title.md @@ -0,0 +1,26 @@ +--- +title: enabled_for_title +author: valexao +description: enabled_for_title event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# enabled_for_title + +This event is triggered when a title enables PlayFab multiplayer servers. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/entity-created.md b/playfab-docs/api-references/events/entity-created.md index e31748aeb..9a0a3e057 100644 --- a/playfab-docs/api-references/events/entity-created.md +++ b/playfab-docs/api-references/events/entity-created.md @@ -23,18 +23,4 @@ This event is triggered when an entity is created. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/entity-executed-cloud-script.md b/playfab-docs/api-references/events/entity-executed-cloud-script.md deleted file mode 100644 index 7af06cdc4..000000000 --- a/playfab-docs/api-references/events/entity-executed-cloud-script.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: entity_executed_cloud_script -author: joannaleecy -description: entity_executed_cloud_script event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# entity_executed_cloud_script - -This event is optionally triggered when a CloudScript function is executed by calling the ExecuteEntityCloudScript API. If you want the Event logged, you can pass in GeneratePlayStreamEvent. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CloudScriptExecutionResult|[ExecuteCloudScriptResult](data-types/executecloudscriptresult.md)|Result of the CloudScript function, including diagnostic information that is useful for debugging.| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|FunctionName|String|Name of the CloudScript function that was called.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/entity-files-set.md b/playfab-docs/api-references/events/entity-files-set.md index 19fe45733..0301e68e0 100644 --- a/playfab-docs/api-references/events/entity-files-set.md +++ b/playfab-docs/api-references/events/entity-files-set.md @@ -24,18 +24,4 @@ This event is triggered when files are attached to an entity. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/entity-language-updated.md b/playfab-docs/api-references/events/entity-language-updated.md index 0cc84461b..0b985283b 100644 --- a/playfab-docs/api-references/events/entity-language-updated.md +++ b/playfab-docs/api-references/events/entity-language-updated.md @@ -24,19 +24,5 @@ This event is triggered when the language associated with an entity is changed. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/entity-logged-in.md b/playfab-docs/api-references/events/entity-logged-in.md index 3c702c600..ffee1d260 100644 --- a/playfab-docs/api-references/events/entity-logged-in.md +++ b/playfab-docs/api-references/events/entity-logged-in.md @@ -23,20 +23,6 @@ This event is triggered when an entity has logged in. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/entity-objects-set.md b/playfab-docs/api-references/events/entity-objects-set.md index a72ef17b4..d40e4b3a9 100644 --- a/playfab-docs/api-references/events/entity-objects-set.md +++ b/playfab-docs/api-references/events/entity-objects-set.md @@ -19,25 +19,9 @@ This event is triggered when objects are attached to an entity. |Name|Type|Description| | :--------------------|:-------------------|:----------------------| |EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md|Entities that this entity is a child of.| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| |Objects|[ObjectSet](data-types/objectset.md)|Objects that were updated| ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - - +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/entity-rank-on-leaderboard-version-ended.md b/playfab-docs/api-references/events/entity-rank-on-leaderboard-version-ended.md index c6f922269..367c5ff4a 100644 --- a/playfab-docs/api-references/events/entity-rank-on-leaderboard-version-ended.md +++ b/playfab-docs/api-references/events/entity-rank-on-leaderboard-version-ended.md @@ -26,18 +26,4 @@ This event is triggered when a leaderboard version is reset to a new version for ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"items_purchased"| -|EventNamespace|String|"playfab.inventory"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/entity-virtual-currency-balances-changed.md b/playfab-docs/api-references/events/entity-virtual-currency-balances-changed.md index d4260dfe8..039f7a733 100644 --- a/playfab-docs/api-references/events/entity-virtual-currency-balances-changed.md +++ b/playfab-docs/api-references/events/entity-virtual-currency-balances-changed.md @@ -27,18 +27,4 @@ This event is triggered when an entity's virtual currency balance changes. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| - +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/game-asset-deleted.md b/playfab-docs/api-references/events/game-asset-deleted.md new file mode 100644 index 000000000..09bd007f6 --- /dev/null +++ b/playfab-docs/api-references/events/game-asset-deleted.md @@ -0,0 +1,26 @@ +--- +title: game_asset_deleted +author: joannaleecy +description: game_asset_deleted event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# game_asset_deleted +This event is triggered when a multiplayer server game asset is deleted. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[GameAssetDeletedEventPayload](data-types/gameassetdeletedeventpayload.md)|The multiplayer server game asset deleted event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/gamesave-version-finalized.md b/playfab-docs/api-references/events/gamesave-version-finalized.md new file mode 100644 index 000000000..ef5e2e217 --- /dev/null +++ b/playfab-docs/api-references/events/gamesave-version-finalized.md @@ -0,0 +1,34 @@ +--- +title: gamesave_version_finalized +author: alzakrze +description: gamesave_version_finalized event. +ms.author: alzakrze +ms.date: 01/22/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events, gamesave +ms.localizationpriority: medium +--- + +# gamesave_version_finalized + +This event is triggered when a game save version is finalized with all the files fully uploaded. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|Version|Int64|The version of the game save that was finalized.| +|PlayerIdentityProvider|String|The login identity provider used by the player uploading the game save.| +|DeviceType|String|The type of device used for this game save version.| +|FinalizedAt|DateTime|The time at which the game save version was finalized.| +|NewFileCount|Int32|The number of new files that were added to the game save store for this version.| +|NewFilesSizeBytes|Int64|The size in bytes of the new files that were added to the game save store for this version.| +|TotalFileCount|Int32|The total number of files that were included in the finalized game save version.| +|TotalSizeBytes|Int64|The total size in bytes of the finalized game save version, including all files.| +|IsGeneratedByRollback|Boolean|Whether the version was generated and finalized by a rollback operation.| +|Conflict|[GameSaveConflict](data-types/gamesaveconflict.md)|Data about any conflict that occurred during the finalization of the game save version. This will usually be null if the version was not finalized during a conflict resolution operation.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/gamesave-version-marked-known-good.md b/playfab-docs/api-references/events/gamesave-version-marked-known-good.md new file mode 100644 index 000000000..f55a07650 --- /dev/null +++ b/playfab-docs/api-references/events/gamesave-version-marked-known-good.md @@ -0,0 +1,26 @@ +--- +title: gamesave_version_marked_known_good +author: alzakrze +description: gamesave_version_marked_known_good event. +ms.author: alzakrze +ms.date: 01/22/2026 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events, gamesave +ms.localizationpriority: medium +--- + +# gamesave_version_marked_known_good + +This event is triggered when a game save version is marked as known good. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|MarkedAt|DateTime|The time at which the game save version was marked as known good.| +|Version|Int64|The version of the game save that was marked as known good.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/group-created.md b/playfab-docs/api-references/events/group-created.md deleted file mode 100644 index 96ee40393..000000000 --- a/playfab-docs/api-references/events/group-created.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: group_created -author: joannaleecy -description: group_created event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# group_created - -This event is triggered when an entity group is created. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CreatorEntityId|String|The identifier for the entity that created the group to which this event applies.| -|CreatorEntityType|String|The type of entity that created the group to which this event applies.| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|GroupName|String|The name of the group to which this event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - diff --git a/playfab-docs/api-references/events/group-deleted.md b/playfab-docs/api-references/events/group-deleted.md deleted file mode 100644 index 1cace51e0..000000000 --- a/playfab-docs/api-references/events/group-deleted.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: group_deleted -author: joannaleecy -description: group_deleted event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# group_deleted - -This event is triggered when an entity group is deleted. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeleterEntityId|String|The identifier for the entity that deleted the group to which this event applies.| -|DeleterEntityType|String|The type of entity that deleted the group to which this event applies.| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|GroupName|String|The name of the group to which this event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - diff --git a/playfab-docs/api-references/events/group-members-added.md b/playfab-docs/api-references/events/group-members-added.md deleted file mode 100644 index 294ea9c04..000000000 --- a/playfab-docs/api-references/events/group-members-added.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: group_members_added -author: joannaleecy -description: group_members_added event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# group_members_added - -This event is triggered when a member is added to an entity group. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|GroupName|String|The name of the group to which this event applies.| -|Members|[Member](data-types/member.md)|The list of entities that were added to the group and role to which this event applies.| -|RoleId|String|The role ID of the role to which this event applies.| -|RoleName|String|The display name of the role to which this event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - diff --git a/playfab-docs/api-references/events/group-members-removed.md b/playfab-docs/api-references/events/group-members-removed.md deleted file mode 100644 index 8d1d8f6d9..000000000 --- a/playfab-docs/api-references/events/group-members-removed.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: group_members_removed -author: joannaleecy -description: group_members_removed event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# group_members_removed - -This event is triggered when a member is removed from an entity group - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|GroupName|String|The name of the group to which this event applies.| -|Members|[Member](data-types/member.md)|The list of entities that were removed from the group to which this event applies| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/group-role-created.md b/playfab-docs/api-references/events/group-role-created.md deleted file mode 100644 index b6f1ebf65..000000000 --- a/playfab-docs/api-references/events/group-role-created.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: group_role_created -author: joannaleecy -description: group_role_created event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# group_role_created - -This event is triggered when a role is created for a group. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CreatorEntityId|String|The identifier for that the entity that created the role to which this event applies.| -|CreatorEntityType|String|The type of entity that created the role to which this event applies.| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|GroupName|String|The name of the group to which this event applies.| -|RoleId|String|The role ID of the role to which this event applies.| -|RoleName|String|The display name of the role to which this event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - - - - diff --git a/playfab-docs/api-references/events/group-role-deleted.md b/playfab-docs/api-references/events/group-role-deleted.md deleted file mode 100644 index 4c3791c30..000000000 --- a/playfab-docs/api-references/events/group-role-deleted.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: group_role_deleted -author: joannaleecy -description: group_role_deleted event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# group_role_deleted - -This event is triggered when a role is deleted from a group. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeleterEntityId|String|The identifier for the entity that deleted the role to which this event applies.| -|DeleterEntityType|String|The type of entity that deleted the role to which this event applies.| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|GroupName|String|The name of the group to which this event applies.| -|RoleId|String|The role ID of the role to which this event applies.| -|RoleName|String|The display name of the role to which this event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - - - diff --git a/playfab-docs/api-references/events/group-role-members-added.md b/playfab-docs/api-references/events/group-role-members-added.md deleted file mode 100644 index 4b8347620..000000000 --- a/playfab-docs/api-references/events/group-role-members-added.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: group_role_members_added -author: joannaleecy -description: group_role_members_added event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# group_role_members_added - -This event is triggered when a list of entities are added to a role within a group. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|GroupName|String|The name of the group to which this event applies.| -|Members|[Member](data-types/member.md)|The list of entities that were added to the group and role to which this event applies| -|RoleId|String|The role ID of the role to which this event applies.| -|RoleName|String|The display name of the role to which this event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - - - diff --git a/playfab-docs/api-references/events/group-role-members-removed.md b/playfab-docs/api-references/events/group-role-members-removed.md deleted file mode 100644 index 6207f4561..000000000 --- a/playfab-docs/api-references/events/group-role-members-removed.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: group_role_members_removed -author: joannaleecy -description: group_role_members_removed event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# group_role_members_removed - -This event is triggered when a list of entities are removed from a role within a group. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|GroupName|String|The name of the group to which this event applies.| -|Members|[Member](data-types/member.md)|The list of entities that were removed from the group to which this event applies| -|RoleId|String|The role ID of the role to which this event applies.| -|RoleName|String|The display name of the role to which this event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - - - diff --git a/playfab-docs/api-references/events/group-role-updated.md b/playfab-docs/api-references/events/group-role-updated.md deleted file mode 100644 index bcc168f28..000000000 --- a/playfab-docs/api-references/events/group-role-updated.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: group_role_updated -author: joannaleecy -description: group_role_updated event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# group_role_updated - -This event is triggered when a role is updated within a group. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|GroupName|String|The name of the group to which this event applies.| -|NewValues|[RolePropertyValues](data-types/rolepropertyvalues.md)|The new values of the role's changed properties| -|OldValues|[RolePropertyValues](data-types/rolepropertyvalues.md)|The previous values of the role's changed properties| -|RoleId|String|The role ID of the role to which this event applies.| -|RoleName|String|The display name of the role to which this event applies.| -|UpdaterEntityId|String|The identifier for the entity that updated the container to which this event applies.| -|UpdaterEntityType|String|The type of entity that updated the container to which this event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - - diff --git a/playfab-docs/api-references/events/group-updated.md b/playfab-docs/api-references/events/group-updated.md deleted file mode 100644 index ac9b3ed90..000000000 --- a/playfab-docs/api-references/events/group-updated.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: group_updated -author: joannaleecy -description: group_updated event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# group_updated - -This event is triggered when an entity group is updated. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityChain|String|The chain of ownership for this entity.| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|GroupName|String|The name of the group to which this event applies.| -|NewValues|[GroupPropertyValues](data-types/grouppropertyvalues.md)|The new values of the group's changed properties| -|OldValues|[GroupPropertyValues](data-types/grouppropertyvalues.md)|The previous values of the group's changed properties| -|UpdaterEntityId|String|The identifier for the entity that updated the group to which this event applies.| -|UpdaterEntityType|String|The type of entity that updated the group to which this event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - - diff --git a/playfab-docs/api-references/events/index.md b/playfab-docs/api-references/events/index.md index 95c293b53..25b937ae7 100644 --- a/playfab-docs/api-references/events/index.md +++ b/playfab-docs/api-references/events/index.md @@ -16,59 +16,203 @@ These are the built-in PlayStream events which are automatically generated by Pl Each event type has a set of properties that are included as part of event's data wherever it is sent. You can view these properties and build rules for triggering actions based on their values in the PlayStream tab of the Game Manager. -## General +## AdPlacement -- [entity_created](entity-created.md) - This event is triggered when an entity is created. +- [player_ad_closed](player-ad-closed.md) + This event is triggered when a player closes an ad. + +- [player_ad_ended](player-ad-ended.md) + This event is triggered when a player finishes an ad. + +- [player_ad_opened](player-ad-opened.md) + This event is triggered when a player opens an ad. + +- [player_ad_rewarded](player-ad-rewarded.md) + This event is triggered when a player recieves an ad reward. -- [entity_executed_cloud_script](entity-executed-cloud-script.md) +- [player_ad_started](player-ad-started.md) + This event is triggered when a player starts an ad. + +## Addons + +- [title_addon_changed](Addons/title-addon-changed.md) + This event is triggered when a title addon is changed. + +## ApiAccessPolicy + +- [title_api_settings_changed](ApiAccessPolicy/title-api-settings-changed.md) + This event is triggered when an API Features setting is changed for the title. + +- [title_permission_policy_changed](ApiAccessPolicy/title-permission-policy-changed.md) + This event is triggered when an update occurs to a a title's permission policies. + +## CloudScript + +- [entity_executed_cloud_script](CloudScript/entity-executed-cloud-script.md) This event is optionally triggered when an Entity CloudScript function is executed, either by calling the ExecuteCloudScript API with the GeneratePlayStreamEvent option or triggered by a PlayStream event action with the 'Publish results as a PlayStream Event' box checked. -- [entity_files_set](entity-files-set.md) - This event is triggered when files are attached to an entity. +- [player_executed_cloudscript](CloudScript/player-executed-cloudscript.md) + This event is optionally triggered when a CloudScript function is executed, either by calling the ExecuteCloudScript API with the GeneratePlayStreamEvent option or triggered by a PlayStream event action with the 'Publish results as a PlayStream Event' box checked. -- [entity_language_updated](entity-language-updated.md) - This event is triggered when the language associated with an entity is changed. +- [player_triggered_action_executed_cloudscript](CloudScript/player-triggered-action-executed-cloudscript.md) + This event is triggered when a CloudScript function is run as the result of a PlayStream action, and the 'Publish results as a PlayStream Event' box was checked. -- [entity_logged_in](entity-logged-in.md) - This event is triggered when an entity has logged in. +- [title_added_cloudscript](CloudScript/title-added-cloudscript.md) + This event is triggered when new CloudScript is uploaded to PlayFab. -- [entity_objects_set](entity-objects-set.md) - This event is triggered when objects are attached to an entity. +- [title_published_cloudscript](CloudScript/title-published-cloudscript.md) + An inactive revision of CloudScript has been made into the active 'live' version. -- [entity_virtual_currency_balances_changed](entity-virtual-currency-balances-changed.md) - This event is triggered when an entity's virtual currency balance changes. +- [title_scheduled_cloudscript_executed](CloudScript/title-scheduled-cloudscript-executed.md) + This event is triggered when a CloudScript function is run by a scheduled task. -- [group_created](group-created.md) - This event is triggered when an entity group is created. +- [cloudscript_executed](CloudScript/cloudscript-executed.md) + This event is triggered when a CloudScript function is executed. -- [group_deleted](group-deleted.md) - This event is triggered when an entity group is deleted. +## Extension + +- [title_aborted_task](Extension/title-aborted-task.md) + This event is triggered when a task instance is aborted. + +- [title_completed_task](Extension/title-completed-task.md) + This event is triggered when a scheduled task has completed + +- [title_created_task](Extension/title-created-task.md) + This event is triggered when a task is created. + +- [title_deleted_task](Extension/title-deleted-task.md) + This event is triggered when a task is deleted. + +- [title_exceeded_limit](Extension/title-exceeded-limit.md) + This event is triggererd when a title exceeds a service limit and receives an error. -- [group_members_added](group-members-added.md) +- [title_limit_changed](Extension/title-limit-changed.md) + This event is triggered when a title changes a service limit. + +- [title_started_task](Extension/title-started-task.md) + This event is triggered when a task is scheduled to run. + +- [title_updated_task](Extension/title-updated-task.md) + This event is triggered when a task is updated. + +- [export_completed](Extension/export-completed.md) + This event is triggered when an export operation is completed. + +## Functions + +- [function_executed](Functions/function-executed.md) + This event is triggered when a function is executed. + +- [function_registered](Functions/function-registered.md) + This event is triggered when a function is registered. + +- [function_unregistered](Functions/function-unregistered.md) + This event is triggered when a function is unregistered. + +- [player_triggered_action_executed_function](Functions/player-triggered-action-executed-function.md) + This event is triggered when a function is run as the result of a PlayStream action. + +- [title_scheduled_function_executed](Functions/title-scheduled-function-executed.md) + This event is triggered when a function is run by a scheduled task. + +## Groups + +- [group_created](Groups/group-created.md) + This event is triggered when an entity group is created. + +- [group_members_added](Groups/group-members-added.md) This event is triggered when a member is added to an entity group. -- [group_members_removed](group-members-removed.md) +- [group_members_removed](Groups/group-members-removed.md) This event is triggered when a member is removed from an entity group. -- [group_role_created](group-role-created.md) +- [group_role_created](Groups/group-role-created.md) This event is triggered when a role is created for a group. -- [group_role_deleted](group-role-deleted.md) +- [group_role_deleted](Groups/group-role-deleted.md) This event is triggered when a role is deleted from a group. -- [group_role_members_added](group-role-members-added.md) +- [group_role_members_added](Groups/group-role-members-added.md) This event is triggered when a list of entities are added to a role within a group. -- [group_role_members_removed](group-role-members-removed.md) +- [group_role_members_removed](Groups/group-role-members-removed.md) This event is triggered when a list of entities are removed from a role within a group. -- [group_role_updated](group-role-updated.md) +- [group_role_updated](Groups/group-role-updated.md) This event is triggered when a role is updated within a group. -- [group_updated](group-updated.md) +- [group_updated](Groups/group-updated.md) This event is triggered when an entity group is updated. +- [members_added](Groups/members-added.md) + This event is triggered when members are added to a group. + +- [members_removed](Groups/members-removed.md) + This event is triggered when members are removed from a group. + +- [members_role_updated](Groups/members-role-updated.md) + This event is triggered when members' roles are updated in a group. + +- [player_updated_membership](Groups/player-updated-membership.md) + This event is triggered when a player's membership is updated. + +- [role_updated](Groups/role-updated.md) + This event is triggered when a role is updated. + +## Telemetry + +- [apikey_activated](Telemetry/apikey-activated.md) + This event is triggered when an API key is activated. + +- [apikey_created](Telemetry/apikey-created.md) + This event is triggered when an API key is created. + +- [apikey_deactivated](Telemetry/apikey-deactivated.md) + This event is triggered when an API key is deactivated. + +- [apikey_deleted](Telemetry/apikey-deleted.md) + This event is triggered when an API key is deleted. + +## TitleCommunications + +- [player_registered_push_notifications](TitleCommunications/player-registered-push-notifications.md) + This event is triggered when a player registers for push notifications. + +- [sent_email](TitleCommunications/sent-email.md) + This event is triggered when an email is sent or fails to send to a player. + +- [sent_push_notification](TitleCommunications/sent-push-notification.md) + This event is triggered when a push notification is sent or fails to be sent to a player. + +- [email_sent](TitleCommunications/email-sent.md) + This event is triggered when an email is sent. + +- [push_notification_sent](TitleCommunications/push-notification-sent.md) + This event is triggered when a push notification is sent. + +## General + +- [entity_created](entity-created.md) + This event is triggered when an entity is created. + +- [entity_files_set](entity-files-set.md) + This event is triggered when files are attached to an entity. + +- [entity_language_updated](entity-language-updated.md) + This event is triggered when the language associated with an entity is changed. + +- [entity_logged_in](entity-logged-in.md) + This event is triggered when an entity has logged in. + +- [entity_objects_set](entity-objects-set.md) + This event is triggered when objects are attached to an entity. + +- [entity_virtual_currency_balances_changed](entity-virtual-currency-balances-changed.md) + This event is triggered when an entity's virtual currency balance changes. + +- [group_deleted](group-deleted.md) + This event is triggered when an entity group is deleted. + - [matchmaking_match_found](matchmaking-match-found.md) This event is triggered when a group of tickets are matched together. @@ -81,66 +225,101 @@ Each event type has a set of properties that are included as part of event's dat - [matchmaking_user_ticket_invite](matchmaking-user-ticket-invite.md) This event is triggered when a ticket with an invited user is created. The event will be sent to the invited user. -- [multiplayer_server_build_deleted](multiplayer-server-build-deleted.md) +- [studio_created](studio-created.md) + This event is triggered when a studio is created. + +- [studio_user_added](studio-user-added.md) + This event is triggered when a user accepts a studio invitation. + +- [studio_user_invited](studio-user-invited.md) + This event is triggered when a user is invited to a studio. + +- [studio_user_removed](studio-user-removed.md) + This event is triggered when a user is removed from a studio. + +- [tenancy_connector_onboard](tenancy-connector-onboard.md) + This event is triggered when a tenancy connector is onboarded. + +- [studio_tier_updated](studio-tier-updated.md) + This event is triggered when a studio tier is updated. + +## Multiplayer Servers + +- [build_alias_created](build-alias-created.md) + This event is triggered when a multiplayer server build alias is created. + +- [build_alias_deleted](build-alias-deleted.md) + This event is triggered when a multiplayer server build alias is deleted. + +- [build_alias_updated](build-alias-updated.md) + This event is triggered when a multiplayer server build alias is updated. + +- [build_deleted](build-deleted.md) This event is triggered when a multiplayer server build is deleted. -- [multiplayer_server_build_region_status_changed](multiplayer-server-build-region-status-changed.md) +- [build_region_status_changed](build-region-status-changed.md) This event is triggered when a multiplayer server's build region status is changed. -- [multiplayer_server_build_region_updated](multiplayer-server-build-region-updated.md) +- [build_region_updated](build-region-updated.md) This event is triggered when a multiplayer server build region is updated. -- [multiplayer_server_certificate_deleted](multiplayer-server-certificate-deleted.md) +- [build_region_utilization](build-region-utilization.md) + This event is triggered to display the utilization of servers for a build in each region. + +- [certificate_deleted](certificate-deleted.md) This event is triggered when a multiplayer server certificate is deleted. -- [multiplayer_server_certificate_uploaded](multiplayer-server-certificate-uploaded.md) +- [certificate_uploaded](certificate-uploaded.md) This event is triggered when a multiplayer server certificate is uploaded. -- [multiplayer_server_create_build_initiated](multiplayer-server-create-build-initiated.md) +- [crash_detected](crash-detected.md) + This event triggered when a crash dump is found on a terminating server. + +- [create_build_initiated](create-build-initiated.md) This event is triggered when a multiplayer server build is initiated. -- [multiplayer_server_game_asset_deleted](multiplayer-server-game-asset-deleted.md) +- [enabled_for_title](enabled-for-title.md) + This event is triggered when a title enables PlayFab servers + +- [game_asset_deleted](game-asset-deleted.md) This event is triggered when a multiplayer server game asset is deleted. -- [multiplayer_server_requested](multiplayer-server-requested.md) - This event is triggered when a multiplayer server shutdown is requested. +- [monitoring_output_saved](monitoring-output-saved.md) + This event is triggered when the output of a monitoring application has been saved and can be downloaded. + +- [secret_added](secret-added.md) + This event is triggered when a multiplayer server secret is added. -- [multiplayer_server_state_changed](multiplayer-server-state-changed.md) +- [secret_deleted](secret-deleted.md) + This event is triggered when a multiplayer server secret is deleted. + +- [server_requested](server-requested.md) + This event is triggered when a multiplayer server is requested. + +- [server_state_changed](server-state-changed.md) This event is triggered when a multiplayer server's state is changed. -- [multiplayer_server_vm_assigned](multiplayer-server-vm-assigned.md) +- [vm_assigned](vm-assigned.md) This event is triggered when a virtual machine is assigned to a multiplayer server build. -- [multiplayer_server_vm_remote_user_created](multiplayer-server-vm-remote-user-created.md) +- [vm_game_certificates_deployed](vm-game-certificates-deployed.md) + This event is triggered when game certificates are deployed in a game virtual machine. + +- [vm_remote_user_created](vm-remote-user-created.md) This event is triggered when a multiplayer server virtual machine remote user is created. -- [multiplayer_server_vm_remote_user_deleted](multiplayer-server-vm-remote-user-deleted.md) +- [vm_remote_user_deleted](vm-remote-user-deleted.md) This event is triggered when a multiplayer server virtual machine remote user is deleted. -- [multiplayer_server_vm_unassignment_started](multiplayer-server-vm-unassignment-started.md) +- [vm_state_change](vm-state-change.md) + This event is triggered when a multiplayer virtual machine's state is changed. + +- [vm_unassignment_started](vm-unassignment-started.md) This event is triggered when a virtual machine is unassigned from a multiplayer server build. -- [multiplayer_server_vm_unhealthy](multiplayer-server-vm-unhealthy.md) +- [vm_unhealthy](vm-unhealthy.md) This event is triggered when a virtual machine is found to be unhealthy. -- [studio_created](studio-created.md) - This event is triggered when a studio is created. - -- [studio_user_added](studio-user-added.md) - This event is triggered when a user accepts a studio invitation. - -- [studio_user_invited](studio-user-invited.md) - This event is triggered when a user is invited to a studio. - -- [studio_user_removed](studio-user-removed.md) - This event is triggered when a user is removed from a studio. - -- [tenancy_connector_onboard](tenancy-connector-onboard.md) - This event is triggered when a tenancy connector is onboarded. - -- [studio_tier_updated](studio-tier-updated.md) - This event is triggered when a studio tier is updated. - ## Catalog - [item_created](item-created.md) @@ -213,6 +392,14 @@ Each event type has a set of properties that are included as part of event's dat - [items_updated](items-updated.md) Event raised when items have been updated in an inventory. +## GameSave + +- [gamesave_version_finalized](gamesave-version-finalized.md) + This event is triggered when a game save version is finalized with all the files fully uploaded. + +- [gamesave_version_marked_known_good](gamesave-version-marked-known-good.md) + This event is triggered when a game save version is marked as known good. + ## Partner - [display_name_filtered](display-name-filtered.md) @@ -238,26 +425,10 @@ Each event type has a set of properties that are included as part of event's dat - [player_ad_campaign_attribution](player-ad-campaign-attribution.md) This event is triggered by an attribution tracking Add-on when a player is matched to a paid acquisition campaign. -- [player_ad_closed](player-ad-closed.md) - This event is triggered when a player closes an ad. - - [player_added_title](player-added-title.md) This event is triggered when a player creates a new account for a title. Note: this event is triggered once per title rather than once per publisher. -- [player_ad_ended](player-ad-ended.md) - This event is triggered when a player finishes an ad. - -- [player_ad_opened](player-ad-opened.md) - This event is triggered when a player opens an ad. - -- [player_ad_rewarded](player-ad-rewarded.md) - This event is triggered when a player recieves an ad reward. -- [player_ad_activity_valued](player-ad-activity-valued.md) - Event triggered when reported value of ad view is recorded - -- [player_ad_started](player-ad-started.md) - This event is triggered when a player starts an ad. - [player_banned](player-banned.md) This event is triggered when a player is banned. @@ -283,9 +454,6 @@ Each event type has a set of properties that are included as part of event's dat - [player_displayname_changed](player-displayname-changed.md) This event is triggered when a player's display name is changed. -- [player_executed_cloudscript](player-executed-cloudscript.md) - This event is optionally triggered when a CloudScript function is executed, either by calling the ExecuteCloudScript API with the GeneratePlayStreamEvent option or triggered by a PlayStream event action with the 'Publish results as a PlayStream Event' box checked. - - [player_inventory_item_added](player-inventory-item-added.md) This event is triggered when an item is granted to a player. @@ -313,9 +481,6 @@ Each event type has a set of properties that are included as part of event's dat - [player_redeemed_coupon](player-redeemed-coupon.md) This event is triggered when a player redeems a coupon. -- [player_registered_push_notifications](player-registered-push-notifications.md) - This event is triggered when a player registers for push notifications. - - [player_removed_title](player-removed-title.md) This event is triggered when a player account for a title is removed. Note: this event is triggered once per title rather than once per publisher. @@ -340,9 +505,6 @@ Each event type has a set of properties that are included as part of event's dat - [player_tag_removed](player-tag-removed.md) This event is triggered when a tag is removed from a player profile. -- [player_triggered_action_executed_cloudscript](player-triggered-action-executed-cloudscript.md) - This event is triggered when a CloudScript function is run as the result of a PlayStream action, and the 'Publish results as a PlayStream Event' box was checked. - - [player_unlinked_account](player-unlinked-account.md) This event is triggered when an authentication method is unlinked from a player's account. @@ -358,12 +520,6 @@ Each event type has a set of properties that are included as part of event's dat - [player_virtual_currency_balance_changed](player-virtual-currency-balance-changed.md) This event is triggered when a player's virtual currency balance changes. -- [sent_push_notification](sent-push-notification.md) - This event is triggered when a push notification is sent or fails to be sent to a player. - -- [sent_email](sent-email.md) - This event is triggered when an email is sent or fails to send to a player. - ## Session - [client_focus_change](client-focus-change.md) @@ -374,57 +530,27 @@ Each event type has a set of properties that are included as part of event's dat ## Title -- [title_aborted_task](title-aborted-task.md) - This event is triggered when a task instance is aborted. - -- [title_added_cloudscript](title-added-cloudscript.md) - This event is triggered when new CloudScript is uploaded to PlayFab. - -- [title_api_settings_changed](title-api-settings-changed.md) - This event is triggered when an API Features setting is changed for the title. - - [title_catalog_updated](title-catalog-updated.md) This event is triggered when a catalog is changed. - [title_client_rate_limited_alert](title-client-rate-limited-alert.md) This event is triggered when a single IP address generates too many API calls to PlayFab and is throttled. -- [title_completed_task](title-completed-task.md) - This event is triggered when a scheduled task has completed - -- [title_created_task](title-created-task.md) - This event is triggered when a task is created. - - [title_deleted](title-deleted.md) This event is triggered when a game title is deleted. -- [title_deleted_task](title-deleted-task.md) - This event is triggered when a task is deleted. - -- [title_exceeded_limit](title-exceeded-limit.md) - This event is triggererd when a title exceeds a service limit and receives an error. - - [title_high_error_rate_alert](title-high-error-rate-alert.md) This event is triggered when a game title experiences a high rate of errors. - [title_initiated_player_password_reset](title-initiated-player-password-reset.md) This event is triggered when a title initiates the account recovery process for a player. -- [title_limit_changed](title-limit-changed.md) - This event is triggered when a title changes a service limit. - - [title_news_updated](title-news-updated.md) This event is triggered when a title news is created or updated. -- [title_permission_policy_changed](title-permission-policy-changed.md) - This event is triggered when an update occurs to a a title's permission policies. - - [title_profile_view_constraints_changed](title-profile-view-constraints-changed.md) This event is triggered when a profile view constraint is changed for the title. -- [title_published_cloudscript](title-published-cloudscript.md) - An inactive revision of CloudScript has been made into the active 'live' version. - - [title_queue_config_updated](title-queue-config-updated.md) This event is triggered when a queue config is changed. @@ -434,24 +560,15 @@ Each event type has a set of properties that are included as part of event's dat - [title_saved_survey](title-saved-survey.md) This event is triggered when a game's survey is saved. -- [title_scheduled_cloudscript_executed](title-scheduled-cloudscript-executed.md) - This event is triggered when a CloudScript function is run by a scheduled task. - - [title_secret_key_changed](title-secret-key-changed.md) This event is triggered when a title adds or updates a Secret Key -- [title_started_task](title-started-task.md) - This event is triggered when a task is scheduled to run. - - [title_statistic_version_changed](title-statistic-version-changed.md) This event is triggered when the version of a statistic changes, causing its leaderboard to reset. - [title_store_updated](title-store-updated.md) This event is triggered when a store is changed. -- [title_updated_task](title-updated-task.md) - This event is triggered when a task is updated. - ## Statistics - [statistic_updated](statistic-updated.md) diff --git a/playfab-docs/api-references/events/item-created.md b/playfab-docs/api-references/events/item-created.md index 8e4f50bf2..36ef0832f 100644 --- a/playfab-docs/api-references/events/item-created.md +++ b/playfab-docs/api-references/events/item-created.md @@ -23,18 +23,4 @@ This event is triggered when an item is created. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"item_created"| -|EventNamespace|String|"playfab.catalog"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/item-deleted.md b/playfab-docs/api-references/events/item-deleted.md index c41bfa6a2..a70f683bd 100644 --- a/playfab-docs/api-references/events/item-deleted.md +++ b/playfab-docs/api-references/events/item-deleted.md @@ -23,18 +23,4 @@ This event is triggered when an item is deleted. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"item_deleted"| -|EventNamespace|String|"playfab.catalog"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/item-moderation-state-changed.md b/playfab-docs/api-references/events/item-moderation-state-changed.md index 388a59382..8dd539561 100644 --- a/playfab-docs/api-references/events/item-moderation-state-changed.md +++ b/playfab-docs/api-references/events/item-moderation-state-changed.md @@ -24,18 +24,4 @@ This event is triggered when an item moderation state is changed. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"tem_moderation_state_changed"| -|EventNamespace|String|"playfab.catalog"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/item-publish-requested.md b/playfab-docs/api-references/events/item-publish-requested.md index ccbbbccda..1e4374fb3 100644 --- a/playfab-docs/api-references/events/item-publish-requested.md +++ b/playfab-docs/api-references/events/item-publish-requested.md @@ -23,18 +23,4 @@ This event is triggered when an publishing is started. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"item_publish_requested"| -|EventNamespace|String|"playfab.catalog"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/item-reported.md b/playfab-docs/api-references/events/item-reported.md index 5fc0b6fcc..74059702d 100644 --- a/playfab-docs/api-references/events/item-reported.md +++ b/playfab-docs/api-references/events/item-reported.md @@ -24,21 +24,6 @@ This event is triggered when an item is reported. |ConcernCategory|String|The category for which this item was reported.| |Reason|String|The reason for which this item was reported.| - ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"item_reported"| -|EventNamespace|String|"playfab.catalog"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/item-updated.md b/playfab-docs/api-references/events/item-updated.md index a4fe04de2..36f7bd178 100644 --- a/playfab-docs/api-references/events/item-updated.md +++ b/playfab-docs/api-references/events/item-updated.md @@ -23,18 +23,4 @@ This event is triggered when an item is updated. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"item_updated"| -|EventNamespace|String|"playfab.catalog"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/items-added.md b/playfab-docs/api-references/events/items-added.md index 9b943c2d9..de1ca1b1c 100644 --- a/playfab-docs/api-references/events/items-added.md +++ b/playfab-docs/api-references/events/items-added.md @@ -29,18 +29,4 @@ Event raised when items have been added to an inventory. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"items_added"| -|EventNamespace|String|"playfab.inventory"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/items-deleted.md b/playfab-docs/api-references/events/items-deleted.md index 2499d290a..37e93c148 100644 --- a/playfab-docs/api-references/events/items-deleted.md +++ b/playfab-docs/api-references/events/items-deleted.md @@ -26,18 +26,4 @@ Event raised when items have been deleted from an inventory. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"items_deleted"| -|EventNamespace|String|"playfab.inventory"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/items-purchased.md b/playfab-docs/api-references/events/items-purchased.md index 4cc777fd5..fa5a2e9e1 100644 --- a/playfab-docs/api-references/events/items-purchased.md +++ b/playfab-docs/api-references/events/items-purchased.md @@ -31,18 +31,4 @@ Event raised when items have been purchased from an inventory. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"items_purchased"| -|EventNamespace|String|"playfab.inventory"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/items-redeemed.md b/playfab-docs/api-references/events/items-redeemed.md index a0e446086..129d96071 100644 --- a/playfab-docs/api-references/events/items-redeemed.md +++ b/playfab-docs/api-references/events/items-redeemed.md @@ -31,18 +31,4 @@ Event raised when items have been redeemed to an inventory. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"items_redeemed"| -|EventNamespace|String|"playfab.inventory"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/items-subtracted.md b/playfab-docs/api-references/events/items-subtracted.md index 4413b7eb9..4527c8821 100644 --- a/playfab-docs/api-references/events/items-subtracted.md +++ b/playfab-docs/api-references/events/items-subtracted.md @@ -29,18 +29,4 @@ Event raised when items have been subtracted from an inventory. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"items_subtracted"| -|EventNamespace|String|"playfab.inventory"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/items-transferred.md b/playfab-docs/api-references/events/items-transferred.md index 886e05720..6ca8f8e5f 100644 --- a/playfab-docs/api-references/events/items-transferred.md +++ b/playfab-docs/api-references/events/items-transferred.md @@ -33,18 +33,4 @@ Event raised when items have been transferred to or from an inventory. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"items_transferred"| -|EventNamespace|String|"playfab.inventory"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/items-updated.md b/playfab-docs/api-references/events/items-updated.md index ea21edc3c..42d035b47 100644 --- a/playfab-docs/api-references/events/items-updated.md +++ b/playfab-docs/api-references/events/items-updated.md @@ -28,18 +28,4 @@ Event raised when items have been updated in an inventory. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"items_updated"| -|EventNamespace|String|"playfab.inventory"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/leaderboard-version-ended.md b/playfab-docs/api-references/events/leaderboard-version-ended.md index 5f6f6d3ac..e661453da 100644 --- a/playfab-docs/api-references/events/leaderboard-version-ended.md +++ b/playfab-docs/api-references/events/leaderboard-version-ended.md @@ -24,18 +24,4 @@ This event is triggered when a leaderboard version is reset to a new version for ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"items_purchased"| -|EventNamespace|String|"playfab.inventory"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/marketplace-transaction-redeemed.md b/playfab-docs/api-references/events/marketplace-transaction-redeemed.md index 5690fefc9..ae32bd1de 100644 --- a/playfab-docs/api-references/events/marketplace-transaction-redeemed.md +++ b/playfab-docs/api-references/events/marketplace-transaction-redeemed.md @@ -27,22 +27,6 @@ This event is triggered when a bundle or subscription has been redeemed to an in |ItemType|String|The type of the catalog item that was redeemed.| |RealMoneyPrices|Dictionary|The multi-currency unit price, in real money, of the item that was redeemed. The property is a dictionary where the key is the three-letter currency code as defined in ISO 4217, and the value is the currency amount in the smallest unit (for example, cents, pence) in accordance with ISO 4217. Only United States Dollar (USD) is currently supported. Example: If the product price in USD is $1.39, the dictionary entry would be: ["USD"] = 139;| -## Common properties - -All PlayStream events are formatted as JSON objects and share the following common properties. - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (such as title and player) to which this event applies.| -|EntityType|String|The type of entity (such as player and title) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like **com.mygame.guild**) as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: **com.myprogram.ads**| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - +## Common Properties +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/matchmaking-match-found.md b/playfab-docs/api-references/events/matchmaking-match-found.md index b4c560961..9f459cc97 100644 --- a/playfab-docs/api-references/events/matchmaking-match-found.md +++ b/playfab-docs/api-references/events/matchmaking-match-found.md @@ -24,20 +24,6 @@ This event is triggered when a group of tickets are matched together. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/matchmaking-ticket-completed.md b/playfab-docs/api-references/events/matchmaking-ticket-completed.md index 628961d66..fe09133df 100644 --- a/playfab-docs/api-references/events/matchmaking-ticket-completed.md +++ b/playfab-docs/api-references/events/matchmaking-ticket-completed.md @@ -24,18 +24,4 @@ This event is triggered when a matchmaking ticket reaches a completion state. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/matchmaking-user-ticket-completed.md b/playfab-docs/api-references/events/matchmaking-user-ticket-completed.md index 0a924fdb6..ed9ca6a95 100644 --- a/playfab-docs/api-references/events/matchmaking-user-ticket-completed.md +++ b/playfab-docs/api-references/events/matchmaking-user-ticket-completed.md @@ -24,20 +24,6 @@ This event is triggered when a matchmaking ticket reaches a completion state. Th ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/matchmaking-user-ticket-invite.md b/playfab-docs/api-references/events/matchmaking-user-ticket-invite.md index b1c10ebcc..bdade1cd4 100644 --- a/playfab-docs/api-references/events/matchmaking-user-ticket-invite.md +++ b/playfab-docs/api-references/events/matchmaking-user-ticket-invite.md @@ -24,20 +24,6 @@ This event is triggered when a ticket with an invited user is created. The event ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/monitoring-output-saved.md b/playfab-docs/api-references/events/monitoring-output-saved.md new file mode 100644 index 000000000..75c5680d2 --- /dev/null +++ b/playfab-docs/api-references/events/monitoring-output-saved.md @@ -0,0 +1,27 @@ +--- +title: monitoring_output_saved +author: valexao +description: monitoring_output_saved event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# monitoring_output_saved + +This event is triggered when the output of a monitoring application has been saved and can be downloaded. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[MonitoringOutputSavedEventPayload](data-types/monitoringoutputsavedeventpayload.md)|The multiplayer server monitoring output saved event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/multiplayer-server-build-deleted.md b/playfab-docs/api-references/events/multiplayer-server-build-deleted.md deleted file mode 100644 index 9871653e3..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-build-deleted.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: multiplayer_server_build_deleted -author: joannaleecy -description: multiplayer_server_build_deleted event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_build_deleted - -This event is triggered when a multiplayer server build is deleted. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerBuildDeletedEventPayload](data-types/multiplayerserverbuilddeletedeventpayload.md)|The multiplayer server build region deleted event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - - diff --git a/playfab-docs/api-references/events/multiplayer-server-build-region-status-changed.md b/playfab-docs/api-references/events/multiplayer-server-build-region-status-changed.md deleted file mode 100644 index ece9c11ce..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-build-region-status-changed.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: multiplayer_server_build_region_status_changed -author: joannaleecy -description: multiplayer_server_build_region_status_changed event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_build_region_status_changed - -This event is triggered when a multiplayer server's build region status is changed. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerBuildRegionStatusChangedEventPayload](data-types/multiplayerserverbuildregionstatuschangedeventpayload.md)|The multiplayer server build region status changed event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - - diff --git a/playfab-docs/api-references/events/multiplayer-server-build-region-updated.md b/playfab-docs/api-references/events/multiplayer-server-build-region-updated.md deleted file mode 100644 index 049fc51ec..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-build-region-updated.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: multiplayer_server_build_region_updated -author: joannaleecy -description: multiplayer_server_build_region_updated event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_build_region_updated - -This event is triggered when a multiplayer server build region is updated. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerBuildRegionUpdatedEventPayload](data-types/multiplayerserverbuildregionupdatedeventpayload.md)|The multiplayer server build region updated event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - diff --git a/playfab-docs/api-references/events/multiplayer-server-certificate-deleted.md b/playfab-docs/api-references/events/multiplayer-server-certificate-deleted.md deleted file mode 100644 index 3c3b36856..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-certificate-deleted.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: multiplayer_server_certificate_deleted -author: joannaleecy -description: multiplayer_server_certificate_deleted event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_certificate_deleted - -This event is triggered when a multiplayer server certificate is deleted. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerCertificateDeletedEventPayload](data-types/multiplayerservercertificatedeletedeventpayload.md)|The multiplayer server certificate deleted event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/multiplayer-server-certificate-uploaded.md b/playfab-docs/api-references/events/multiplayer-server-certificate-uploaded.md deleted file mode 100644 index f7a797151..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-certificate-uploaded.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: multiplayer_server_certificate_uploaded -author: joannaleecy -description: multiplayer_server_certificate_uploaded event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_certificate_uploaded - -This event is triggered when a multiplayer server certificate is uploaded. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerCertificateUploadedEventPayload](data-types/multiplayerservercertificateuploadedeventpayload.md)|The multiplayer server certificate uploaded event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - diff --git a/playfab-docs/api-references/events/multiplayer-server-create-build-initiated.md b/playfab-docs/api-references/events/multiplayer-server-create-build-initiated.md deleted file mode 100644 index c0065eeda..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-create-build-initiated.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: multiplayer_server_create_build_initiated -author: joannaleecy -description: multiplayer_server_create_build_initiated event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_create_build_initiated - -This event is triggered when a multiplayer server build is initiated. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerCreateBuildInitiatedEventPayload](data-types/multiplayerservercreatebuildinitiatedeventpayload.md)|The multiplayer server create build initiated event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - diff --git a/playfab-docs/api-references/events/multiplayer-server-game-asset-deleted.md b/playfab-docs/api-references/events/multiplayer-server-game-asset-deleted.md deleted file mode 100644 index dcbbecbdd..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-game-asset-deleted.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: multiplayer_server_game_asset_deleted -author: joannaleecy -description: multiplayer_server_game_asset_deleted event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_game_asset_deleted - -This event is triggered when a multiplayer server game asset is deleted. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerGameAssetDeletedEventPayload](data-types/multiplayerservergameassetdeletedeventpayload.md)|The multiplayer server game asset deleted event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - diff --git a/playfab-docs/api-references/events/multiplayer-server-requested.md b/playfab-docs/api-references/events/multiplayer-server-requested.md deleted file mode 100644 index 30a437724..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-requested.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: multiplayer_server_requested -author: joannaleecy -description: multiplayer_server_requested event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_requested - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerRequestedEventPayload](data-types/multiplayerserverrequestedeventpayload.md)|The multiplayer server requested event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| - - diff --git a/playfab-docs/api-references/events/multiplayer-server-state-changed.md b/playfab-docs/api-references/events/multiplayer-server-state-changed.md deleted file mode 100644 index 5750987f8..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-state-changed.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: multiplayer_server_state_changed -author: joannaleecy -description: multiplayer_server_state_changed event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_state_changed - -This event is triggered when a multiplayer server's state is changed. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerStateChangedEventPayload](data-types/multiplayerserverstatechangedeventpayload.md)|The multiplayer server state changed event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/multiplayer-server-vm-assigned.md b/playfab-docs/api-references/events/multiplayer-server-vm-assigned.md deleted file mode 100644 index 7f68abd32..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-vm-assigned.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: multiplayer_server_vm_assigned -author: joannaleecy -description: multiplayer_server_vm_assigned event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_vm_assigned - -This event is triggered when a virtual machine is assigned to a multiplayer server build. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerVmAssignedEventPayload](data-types/multiplayerservervmassignedeventpayload.md)|The multiplayer server virtual machine assigned event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/multiplayer-server-vm-remote-user-created.md b/playfab-docs/api-references/events/multiplayer-server-vm-remote-user-created.md deleted file mode 100644 index 032231d44..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-vm-remote-user-created.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: multiplayer_server_vm_remote_user_created -author: joannaleecy -description: multiplayer_server_vm_remote_user_created event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_vm_remote_user_created - -This event is triggered when a multiplayer server virtual machine remote user is created. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerVmRemoteUserCreatedEventPayload](data-types/multiplayerservervmremoteusercreatedeventpayload.md)|The multiplayer server virtual machine remote user created event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/multiplayer-server-vm-remote-user-deleted.md b/playfab-docs/api-references/events/multiplayer-server-vm-remote-user-deleted.md deleted file mode 100644 index 7040e3064..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-vm-remote-user-deleted.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: multiplayer_server_vm_remote_user_deleted -author: joannaleecy -description: multiplayer_server_vm_remote_user_deleted event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_vm_remote_user_deleted - -This event is triggered when a multiplayer server virtual machine remote user is deleted. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerVmRemoteUserDeletedEventPayload](data-types/multiplayerservervmremoteuserdeletedeventpayload.md)|The multiplayer server virtual machine remote user deleted event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/multiplayer-server-vm-unassignment-started.md b/playfab-docs/api-references/events/multiplayer-server-vm-unassignment-started.md deleted file mode 100644 index 415967b86..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-vm-unassignment-started.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: multiplayer_server_vm_unassignment_started -author: joannaleecy -description: multiplayer_server_vm_unassignment_started event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_vm_unassignment_started - -This event is triggered when a virtual machine is unassigned from a multiplayer server build. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerVmUnassignmentStartedEventPayload](data-types/multiplayerservervmunassignmentstartedeventpayload.md)|The multiplayer server virtual machine unassignment started event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/multiplayer-server-vm-unhealthy.md b/playfab-docs/api-references/events/multiplayer-server-vm-unhealthy.md deleted file mode 100644 index 4a0244945..000000000 --- a/playfab-docs/api-references/events/multiplayer-server-vm-unhealthy.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: multiplayer_server_vm_unhealthy -author: joannaleecy -description: multiplayer_server_vm_unhealthy event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# multiplayer_server_vm_unhealthy - -This event is triggered when a virtual machine is found to be unhealthy. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| -|OriginalEventId|String|The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from the EventId value, which is assigned when the event is received by the server.| -|OriginalTimestamp|DateTime|The original time (in UTC) associated with this event before it was posted to PlayFab. The value might differ from the Timestamp value, which is set at the time the event is received by the server.| -|Payload|[MultiplayerServerVmUnhealthyEventPayload](data-types/multiplayerservervmunhealthyeventpayload.md)|The multiplayer server virtual machine unassignment started event payload.| -|WriterEntity|[EntityKey](data-types/entitykey.md)|Entity that wrote this event, included only if different than the event's entity.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/player-action-executed.md b/playfab-docs/api-references/events/player-action-executed.md index bb22dc707..3f3b624b9 100644 --- a/playfab-docs/api-references/events/player-action-executed.md +++ b/playfab-docs/api-references/events/player-action-executed.md @@ -30,18 +30,4 @@ Properties ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-ad-activity-valued.md b/playfab-docs/api-references/events/player-ad-activity-valued.md deleted file mode 100644 index ce0e6d6e2..000000000 --- a/playfab-docs/api-references/events/player-ad-activity-valued.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: player_ad_activity_valued -author: joannaleecy -description: player_ad_activity_valued event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# player_ad_activity_valued - -Event triggered when reported value of ad view is recorded - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|AdPlacementId|String|Id of the placement| -|AdPlacementName|String|Name of the placement| -|AdUnit|String|Ad unit type| -|RevenueShare|double|Share of the revenue for this ad view (calculated as total revenue for placement divided by total views for that placement in that time window)| -|RewardId|String|Id of the reward| -|RewardName|String|Name of the reward| -|TitleId|String|The ID of the title to which this player event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/player-ad-campaign-attribution.md b/playfab-docs/api-references/events/player-ad-campaign-attribution.md index 46972b2c8..f65135bbc 100644 --- a/playfab-docs/api-references/events/player-ad-campaign-attribution.md +++ b/playfab-docs/api-references/events/player-ad-campaign-attribution.md @@ -23,18 +23,4 @@ This event is triggered by an attribution tracking Add-on when a player is match ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-ad-closed.md b/playfab-docs/api-references/events/player-ad-closed.md index 626aff6d9..11e092b58 100644 --- a/playfab-docs/api-references/events/player-ad-closed.md +++ b/playfab-docs/api-references/events/player-ad-closed.md @@ -27,18 +27,4 @@ This event is triggered when a player closes an ad. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-ad-ended.md b/playfab-docs/api-references/events/player-ad-ended.md index 75b605939..2a5954134 100644 --- a/playfab-docs/api-references/events/player-ad-ended.md +++ b/playfab-docs/api-references/events/player-ad-ended.md @@ -27,18 +27,4 @@ This event is triggered when a player finishes an ad. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-ad-opened.md b/playfab-docs/api-references/events/player-ad-opened.md index d7d920f63..4ee11dfb8 100644 --- a/playfab-docs/api-references/events/player-ad-opened.md +++ b/playfab-docs/api-references/events/player-ad-opened.md @@ -27,18 +27,4 @@ This event is triggered when a player opens an ad. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-ad-rewarded.md b/playfab-docs/api-references/events/player-ad-rewarded.md index 453325d00..9e707ebbd 100644 --- a/playfab-docs/api-references/events/player-ad-rewarded.md +++ b/playfab-docs/api-references/events/player-ad-rewarded.md @@ -29,18 +29,4 @@ This event is triggered when a player recieves an ad reward. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-ad-started.md b/playfab-docs/api-references/events/player-ad-started.md index add24300e..28b48f5a5 100644 --- a/playfab-docs/api-references/events/player-ad-started.md +++ b/playfab-docs/api-references/events/player-ad-started.md @@ -27,18 +27,4 @@ This event is triggered when a player starts an ad. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-added-title.md b/playfab-docs/api-references/events/player-added-title.md index f128034b1..6b97edbe1 100644 --- a/playfab-docs/api-references/events/player-added-title.md +++ b/playfab-docs/api-references/events/player-added-title.md @@ -25,18 +25,4 @@ This event is triggered when a player creates a new account for a title. Note: t ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-banned.md b/playfab-docs/api-references/events/player-banned.md index 40f8b69e1..45a0583a0 100644 --- a/playfab-docs/api-references/events/player-banned.md +++ b/playfab-docs/api-references/events/player-banned.md @@ -26,18 +26,4 @@ This event is triggered when a player is banned. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-changed-avatar.md b/playfab-docs/api-references/events/player-changed-avatar.md index 036e59076..3cea56e7a 100644 --- a/playfab-docs/api-references/events/player-changed-avatar.md +++ b/playfab-docs/api-references/events/player-changed-avatar.md @@ -24,18 +24,4 @@ This event is triggered when a player's avatar URL is changed. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-completed-password-reset.md b/playfab-docs/api-references/events/player-completed-password-reset.md index 83d212481..1146cdfbf 100644 --- a/playfab-docs/api-references/events/player-completed-password-reset.md +++ b/playfab-docs/api-references/events/player-completed-password-reset.md @@ -30,18 +30,4 @@ This event is triggered when a player completes the password reset process by vi ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-consumed-item.md b/playfab-docs/api-references/events/player-consumed-item.md index b3aa4fcda..9198c769e 100644 --- a/playfab-docs/api-references/events/player-consumed-item.md +++ b/playfab-docs/api-references/events/player-consumed-item.md @@ -27,18 +27,4 @@ This event is triggered when a player consumes an item from their inventory. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-created.md b/playfab-docs/api-references/events/player-created.md index 83d7d4197..286dbb347 100644 --- a/playfab-docs/api-references/events/player-created.md +++ b/playfab-docs/api-references/events/player-created.md @@ -24,18 +24,4 @@ This event is triggered when a player account is created for the first time. Not ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-data-exported.md b/playfab-docs/api-references/events/player-data-exported.md index 0250cc535..377a7733f 100644 --- a/playfab-docs/api-references/events/player-data-exported.md +++ b/playfab-docs/api-references/events/player-data-exported.md @@ -25,18 +25,4 @@ This event is triggered when a player's data is exported. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-device-info.md b/playfab-docs/api-references/events/player-device-info.md index ef5fc87b0..509c7ddb3 100644 --- a/playfab-docs/api-references/events/player-device-info.md +++ b/playfab-docs/api-references/events/player-device-info.md @@ -23,18 +23,4 @@ This event is triggered once after the player logs in based on the settings for ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-display-name-filtered.md b/playfab-docs/api-references/events/player-display-name-filtered.md index d31e81661..f8227fdaf 100644 --- a/playfab-docs/api-references/events/player-display-name-filtered.md +++ b/playfab-docs/api-references/events/player-display-name-filtered.md @@ -23,18 +23,4 @@ This event is triggered when a display name is filtered by community sift only i ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-displayname-changed.md b/playfab-docs/api-references/events/player-displayname-changed.md index 17bdbd85c..3074abf6f 100644 --- a/playfab-docs/api-references/events/player-displayname-changed.md +++ b/playfab-docs/api-references/events/player-displayname-changed.md @@ -24,18 +24,4 @@ This event is triggered when a player's display name is changed. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-executed-cloudscript.md b/playfab-docs/api-references/events/player-executed-cloudscript.md deleted file mode 100644 index 71e1778ce..000000000 --- a/playfab-docs/api-references/events/player-executed-cloudscript.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: player_executed_cloudscript -author: joannaleecy -description: player_executed_cloudscript event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# player_executed_cloudscript - -This event is optionally triggered when a CloudScript function is executed, either by calling the ExecuteCloudScript API with the GeneratePlayStreamEvent option or triggered by a PlayStream event action with the 'Publish results as a PlayStream Event' box checked. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CloudScriptExecutionResult|[ExecuteCloudScriptResult](data-types/executecloudscriptresult.md)|Result of the CloudScript function, including diagnostic information that is useful for debugging.| -|FunctionName|String|Name of the CloudScript function that was called.| -|TitleId|String|The ID of the title to which this player event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/player-inventory-item-added.md b/playfab-docs/api-references/events/player-inventory-item-added.md index c719d6049..d0a5e094a 100644 --- a/playfab-docs/api-references/events/player-inventory-item-added.md +++ b/playfab-docs/api-references/events/player-inventory-item-added.md @@ -32,18 +32,4 @@ This event is triggered when an item is granted to a player. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-linked-account.md b/playfab-docs/api-references/events/player-linked-account.md index 75147cb6b..1e0070203 100644 --- a/playfab-docs/api-references/events/player-linked-account.md +++ b/playfab-docs/api-references/events/player-linked-account.md @@ -26,18 +26,4 @@ This event is triggered when a new authentication method is linked to a player's ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-logged-in.md b/playfab-docs/api-references/events/player-logged-in.md index fa2b19cf9..96776ea58 100644 --- a/playfab-docs/api-references/events/player-logged-in.md +++ b/playfab-docs/api-references/events/player-logged-in.md @@ -26,18 +26,4 @@ This event is triggered when a player logs in. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-paid-for-purchase.md b/playfab-docs/api-references/events/player-paid-for-purchase.md index b6fd32bd3..d61370899 100644 --- a/playfab-docs/api-references/events/player-paid-for-purchase.md +++ b/playfab-docs/api-references/events/player-paid-for-purchase.md @@ -32,18 +32,4 @@ This event is triggered when the second step of the payment process completes, p ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-password-reset-link-sent.md b/playfab-docs/api-references/events/player-password-reset-link-sent.md index 162a629f8..4b5c9907a 100644 --- a/playfab-docs/api-references/events/player-password-reset-link-sent.md +++ b/playfab-docs/api-references/events/player-password-reset-link-sent.md @@ -27,18 +27,4 @@ This event is triggered when a player is sent a link to reset their password. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-photon-session-authenticated.md b/playfab-docs/api-references/events/player-photon-session-authenticated.md index 214ae0e69..874d5c28a 100644 --- a/playfab-docs/api-references/events/player-photon-session-authenticated.md +++ b/playfab-docs/api-references/events/player-photon-session-authenticated.md @@ -24,18 +24,4 @@ Properties ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-ranked-on-leaderboard-version.md b/playfab-docs/api-references/events/player-ranked-on-leaderboard-version.md index 879e3be6c..2b3cbfbac 100644 --- a/playfab-docs/api-references/events/player-ranked-on-leaderboard-version.md +++ b/playfab-docs/api-references/events/player-ranked-on-leaderboard-version.md @@ -27,18 +27,4 @@ This event is triggered for the top-ranked players on a leaderboard when the lea ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-realmoney-purchase.md b/playfab-docs/api-references/events/player-realmoney-purchase.md index b244930f6..bcd43b8ff 100644 --- a/playfab-docs/api-references/events/player-realmoney-purchase.md +++ b/playfab-docs/api-references/events/player-realmoney-purchase.md @@ -30,18 +30,4 @@ This event is triggered when a player makes a real money purchase, and generates ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-receipt-validation.md b/playfab-docs/api-references/events/player-receipt-validation.md index d7dfcab6f..e6863fcd3 100644 --- a/playfab-docs/api-references/events/player-receipt-validation.md +++ b/playfab-docs/api-references/events/player-receipt-validation.md @@ -27,18 +27,4 @@ This event is triggered when a player attempts to make a real money purchase and ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-redeemed-coupon.md b/playfab-docs/api-references/events/player-redeemed-coupon.md index 1dccbeb9c..bbd75a90c 100644 --- a/playfab-docs/api-references/events/player-redeemed-coupon.md +++ b/playfab-docs/api-references/events/player-redeemed-coupon.md @@ -24,18 +24,4 @@ This event is triggered when a player redeems a coupon. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-registered-push-notifications.md b/playfab-docs/api-references/events/player-registered-push-notifications.md deleted file mode 100644 index fc91dfa49..000000000 --- a/playfab-docs/api-references/events/player-registered-push-notifications.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: player_registered_push_notifications -author: joannaleecy -description: player_registered_push_notifications event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# player_registered_push_notifications - -This event is triggered when a player registers for push notifications. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeviceToken|String|Unique device token registered for push notifications.| -|Platform|[PushNotificationPlatform](data-types/pushnotificationplatform.md)|Platform on which the player is registering for push notifications.| -|TitleId|String|The ID of the title to which this player event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/player-removed-title.md b/playfab-docs/api-references/events/player-removed-title.md index 9f9880c55..4624f3fbb 100644 --- a/playfab-docs/api-references/events/player-removed-title.md +++ b/playfab-docs/api-references/events/player-removed-title.md @@ -22,18 +22,4 @@ This event is triggered when a player account for a title is removed. Note: this ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-reported-as-abusive.md b/playfab-docs/api-references/events/player-reported-as-abusive.md index 27ccae2fc..6adc548a6 100644 --- a/playfab-docs/api-references/events/player-reported-as-abusive.md +++ b/playfab-docs/api-references/events/player-reported-as-abusive.md @@ -24,18 +24,4 @@ This event is triggered when a player is reported by another player as abusive. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-set-profile-property.md b/playfab-docs/api-references/events/player-set-profile-property.md index c3af40086..6654394ec 100644 --- a/playfab-docs/api-references/events/player-set-profile-property.md +++ b/playfab-docs/api-references/events/player-set-profile-property.md @@ -24,18 +24,4 @@ This event is triggered when PlayFab makes an internal adjustment to a player pr ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-started-purchase.md b/playfab-docs/api-references/events/player-started-purchase.md index 5a724bc8e..2f34a3ef9 100644 --- a/playfab-docs/api-references/events/player-started-purchase.md +++ b/playfab-docs/api-references/events/player-started-purchase.md @@ -26,18 +26,4 @@ This event is triggered when a player starts a purchase. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-statistic-changed.md b/playfab-docs/api-references/events/player-statistic-changed.md index befbfdc9f..55a3c7c37 100644 --- a/playfab-docs/api-references/events/player-statistic-changed.md +++ b/playfab-docs/api-references/events/player-statistic-changed.md @@ -28,18 +28,4 @@ This event is triggered when a player statistic is changed. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-statistic-deleted.md b/playfab-docs/api-references/events/player-statistic-deleted.md index dae5187aa..b3ef4ce1d 100644 --- a/playfab-docs/api-references/events/player-statistic-deleted.md +++ b/playfab-docs/api-references/events/player-statistic-deleted.md @@ -26,18 +26,4 @@ This event is triggered when a player statistic is deleted. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-tag-added.md b/playfab-docs/api-references/events/player-tag-added.md index eb7d9f58f..353a81dbc 100644 --- a/playfab-docs/api-references/events/player-tag-added.md +++ b/playfab-docs/api-references/events/player-tag-added.md @@ -24,18 +24,4 @@ This event is triggered when a tag is added to a player profile. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-tag-removed.md b/playfab-docs/api-references/events/player-tag-removed.md index 377e3886a..fadc9c1ff 100644 --- a/playfab-docs/api-references/events/player-tag-removed.md +++ b/playfab-docs/api-references/events/player-tag-removed.md @@ -24,18 +24,4 @@ This event is triggered when a tag is removed from a player profile. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-triggered-action-executed-cloudscript.md b/playfab-docs/api-references/events/player-triggered-action-executed-cloudscript.md deleted file mode 100644 index a72dbe173..000000000 --- a/playfab-docs/api-references/events/player-triggered-action-executed-cloudscript.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: player_triggered_action_executed_cloudscript -author: joannaleecy -description: player_triggered_action_executed_cloudscript event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# player_triggered_action_executed_cloudscript - -This event is triggered when a CloudScript function is run as the result of a PlayStream action, and the 'Publish results as a PlayStream Event' box was checked. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CloudScriptExecutionResult|[ExecuteCloudScriptResult](data-types/executecloudscriptresult.md)|Result of the CloudScript function, including an error information. Useful for debugging.| -|FunctionName|String|Name of the CloudScript function that was called.| -|TitleId|String|The ID of the title to which this player event applies.| -|TriggeringEventData|object|The full JSON data of the event that triggered this CloudScript function to run. Useful for debugging.| -|TriggeringEventName|String|Name of the event that triggered this CloudScript function to run.| -|TriggeringPlayer|[PlayerProfile](data-types/playerprofile.md)|JSON data profile of the player that triggered this CloudScript function to run.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/player-unlinked-account.md b/playfab-docs/api-references/events/player-unlinked-account.md index 2341570f7..5bcb86db8 100644 --- a/playfab-docs/api-references/events/player-unlinked-account.md +++ b/playfab-docs/api-references/events/player-unlinked-account.md @@ -24,18 +24,4 @@ This event is triggered when an authentication method is unlinked from a player' ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-updated-contact-email.md b/playfab-docs/api-references/events/player-updated-contact-email.md index 9e0a48510..fdfa83a46 100644 --- a/playfab-docs/api-references/events/player-updated-contact-email.md +++ b/playfab-docs/api-references/events/player-updated-contact-email.md @@ -25,18 +25,4 @@ This event is triggered when a player updates a contact email on their profile. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-vc-item-purchased.md b/playfab-docs/api-references/events/player-vc-item-purchased.md index 0d6c0ad25..a6633a480 100644 --- a/playfab-docs/api-references/events/player-vc-item-purchased.md +++ b/playfab-docs/api-references/events/player-vc-item-purchased.md @@ -29,18 +29,4 @@ This event is triggered when the player makes a purchase using virtual currency. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-verified-contact-email.md b/playfab-docs/api-references/events/player-verified-contact-email.md index 6dc84d36f..14489ac0e 100644 --- a/playfab-docs/api-references/events/player-verified-contact-email.md +++ b/playfab-docs/api-references/events/player-verified-contact-email.md @@ -24,18 +24,4 @@ This event is triggered when a contact email is verified for a player. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/player-virtual-currency-balance-changed.md b/playfab-docs/api-references/events/player-virtual-currency-balance-changed.md index 040e347e0..98f0fc5b8 100644 --- a/playfab-docs/api-references/events/player-virtual-currency-balance-changed.md +++ b/playfab-docs/api-references/events/player-virtual-currency-balance-changed.md @@ -26,18 +26,4 @@ This event is triggered when a player's virtual currency balance changes. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/review-reported.md b/playfab-docs/api-references/events/review-reported.md index f381e5a28..40fd565dd 100644 --- a/playfab-docs/api-references/events/review-reported.md +++ b/playfab-docs/api-references/events/review-reported.md @@ -24,21 +24,6 @@ This event is triggered when a review is reported. |Reason|String|The string reason for this report.| |CreatorEntityKey|[EntityKey](data-types/entitykey.md)|The EntityKey of the creator of the review that was reported.| - ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"review_reported"| -|EventNamespace|String|"playfab.catalog"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/reviews-takedown-requested.md b/playfab-docs/api-references/events/reviews-takedown-requested.md index 62966a3a3..bf59b245f 100644 --- a/playfab-docs/api-references/events/reviews-takedown-requested.md +++ b/playfab-docs/api-references/events/reviews-takedown-requested.md @@ -22,18 +22,4 @@ Event trigged when a takedown of reviews is requested. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|"reviews_takedown_requested"| -|EventNamespace|String|"playfab.catalog"| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] \ No newline at end of file diff --git a/playfab-docs/api-references/events/secret-added.md b/playfab-docs/api-references/events/secret-added.md new file mode 100644 index 000000000..f8d08f1ff --- /dev/null +++ b/playfab-docs/api-references/events/secret-added.md @@ -0,0 +1,27 @@ +--- +title: secret_added +author: valexao +description: secret_added event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# secret_added + +This event is triggered when a multiplayer server secret is added. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[SecretAddedEventPayload](data-types/secretaddedeventpayload.md)|The multiplayer server secret added event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/secret-deleted.md b/playfab-docs/api-references/events/secret-deleted.md new file mode 100644 index 000000000..a32aee78f --- /dev/null +++ b/playfab-docs/api-references/events/secret-deleted.md @@ -0,0 +1,27 @@ +--- +title: secret_deleted +author: valexao +description: secret_deleted event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# secret_deleted + +This event is triggered when a multiplayer server secret is deleted. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[SecretDeletedEventPayload](data-types/secretdeletedeventpayload.md)|The multiplayer server secret deleted event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/sent-email.md b/playfab-docs/api-references/events/sent-email.md deleted file mode 100644 index ce0008772..000000000 --- a/playfab-docs/api-references/events/sent-email.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: sent_email -author: joannaleecy -description: sent_email event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# sent_email - -This event is triggered when an email is sent or fails to send to a player. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|Body|String|The content of the email body, truncated to 4096 characters.| -|EmailName|String|The name of the player's contact email the email was sent to.| -|EmailTemplateId|String|The email template id during a send email attempt.| -|EmailTemplateName|String|The email template name during a send email attempt.| -|EmailTemplateType|[EmailTemplateType](data-types/emailtemplatetype.md)|The email template type during a send email attempt.| -|ErrorMessage|String|The error that occurred if an email failed to send.| -|ErrorName|String|The name of the error that occurred if an email failed to send.| -|Language|String|The language the email was sent in| -|Subject|String|The content of the email subject, truncated to 1024 characters.| -|Success|Boolean|Indicates if the email was successfully sent.| -|TitleId|String|The ID of the title to which this player event applies.| -|Token|String|The auth token included in the sent email as part of a confirmation URL.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/sent-push-notification.md b/playfab-docs/api-references/events/sent-push-notification.md deleted file mode 100644 index a990fbd6f..000000000 --- a/playfab-docs/api-references/events/sent-push-notification.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: sent_push_notification -author: joannaleecy -description: sent_push_notification event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# sent_push_notification - -This event is triggered when a push notification is sent or fails to be sent to a player. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|Body|String|The content of the push notification body, truncated to 4096 characters.| -|ErrorMessage|String|The error that occurred if the push notification failed to be sent.| -|ErrorName|String|The name of the error that occurred if the push notification failed to be sent.| -|Language|String|The language the push notification was sent in if a matching localized template was used.| -|PushNotificationTemplateId|String|The push notification template id during a send push notification attempt.| -|PushNotificationTemplateName|String|The push notification template name during a send push notification attempt.| -|Subject|String|The content of the push notification subject, truncated to 1024 characters.| -|Success|Boolean|Indicates whether the push notification was successfully sent.| -|TitleId|String|The ID of the title to which this player event applies.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/server-requested.md b/playfab-docs/api-references/events/server-requested.md new file mode 100644 index 000000000..08f9b556a --- /dev/null +++ b/playfab-docs/api-references/events/server-requested.md @@ -0,0 +1,30 @@ +--- +title: server_requested +author: joannaleecy +description: server_requested event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# server_requested + +This event is triggered when a multiplayer server is requested. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| + +|Payload|[ServerRequestedEventPayload](data-types/serverrequestedeventpayload.md)|The multiplayer server requested event payload.| + + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + + diff --git a/playfab-docs/api-references/events/server-state-changed.md b/playfab-docs/api-references/events/server-state-changed.md new file mode 100644 index 000000000..a07a1b372 --- /dev/null +++ b/playfab-docs/api-references/events/server-state-changed.md @@ -0,0 +1,28 @@ +--- +title: server_state_changed +author: joannaleecy +description: server_state_changed event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# server_state_changed + +This event is triggered when a multiplayer server's state is changed. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| + +|Payload|[ServerStateChangedEventPayload](data-types/serverstatechangedeventpayload.md)|The multiplayer server state changed event payload.| + + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/statistic-updated.md b/playfab-docs/api-references/events/statistic-updated.md index c9b35dff4..c97dd19e0 100644 --- a/playfab-docs/api-references/events/statistic-updated.md +++ b/playfab-docs/api-references/events/statistic-updated.md @@ -28,18 +28,4 @@ This event is triggered when a statistic is updated for a given entity. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/studio-created.md b/playfab-docs/api-references/events/studio-created.md index 72a361834..23121f972 100644 --- a/playfab-docs/api-references/events/studio-created.md +++ b/playfab-docs/api-references/events/studio-created.md @@ -24,18 +24,4 @@ This event is triggered when a studio is created. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/studio-tier-updated.md b/playfab-docs/api-references/events/studio-tier-updated.md index 10cede10d..5de1d38f9 100644 --- a/playfab-docs/api-references/events/studio-tier-updated.md +++ b/playfab-docs/api-references/events/studio-tier-updated.md @@ -34,18 +34,4 @@ This event is triggered when a studio tier is updated. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/studio-user-added.md b/playfab-docs/api-references/events/studio-user-added.md index 5c58581a6..a8847b0fa 100644 --- a/playfab-docs/api-references/events/studio-user-added.md +++ b/playfab-docs/api-references/events/studio-user-added.md @@ -27,18 +27,4 @@ ms.localizationpriority: medium ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/studio-user-invited.md b/playfab-docs/api-references/events/studio-user-invited.md index 0133dc54a..f6052de64 100644 --- a/playfab-docs/api-references/events/studio-user-invited.md +++ b/playfab-docs/api-references/events/studio-user-invited.md @@ -30,18 +30,4 @@ This event is triggererd when a user is invited to a studio. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/studio-user-removed.md b/playfab-docs/api-references/events/studio-user-removed.md index 9bc47c94c..fa0853d5c 100644 --- a/playfab-docs/api-references/events/studio-user-removed.md +++ b/playfab-docs/api-references/events/studio-user-removed.md @@ -28,18 +28,4 @@ This event is triggered when a user is removed from a studio. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/tenancy-connector-onboard.md b/playfab-docs/api-references/events/tenancy-connector-onboard.md index eb347e6b4..4eb3a8897 100644 --- a/playfab-docs/api-references/events/tenancy-connector-onboard.md +++ b/playfab-docs/api-references/events/tenancy-connector-onboard.md @@ -23,18 +23,4 @@ This event is triggered when a tenancy connector is onboarded. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-aborted-task.md b/playfab-docs/api-references/events/title-aborted-task.md deleted file mode 100644 index 199247ca3..000000000 --- a/playfab-docs/api-references/events/title-aborted-task.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: title_aborted_task -author: joannaleecy -description: title_aborted_task event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_aborted_task - -This event is triggered when a task instance is aborted. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeveloperId|String|| -|TaskInstanceId|String|ID of the aborted task instance| -|UserId|String|| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-added-cloudscript.md b/playfab-docs/api-references/events/title-added-cloudscript.md deleted file mode 100644 index ae46e7de5..000000000 --- a/playfab-docs/api-references/events/title-added-cloudscript.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: title_added_cloudscript -author: joannaleecy -description: title_added_cloudscript event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_added_cloudscript - -This event is triggered when new CloudScript is uploaded to PlayFab. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeveloperId|String|| -|Published|Boolean|Whether the CloudScript that was uploaded is live.| -|Revision|int32|Revision number of the CloudScript file that was added.| -|ScriptNames|[]|Names of the individual script files modified. Currently this is just 'CloudScript.js' but later we will support multiple files.| -|UserId|String|| -|Version|int32|Version number of the CloudScript file that was added.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-api-settings-changed.md b/playfab-docs/api-references/events/title-api-settings-changed.md deleted file mode 100644 index d833ef143..000000000 --- a/playfab-docs/api-references/events/title-api-settings-changed.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: title_api_settings_changed -author: joannaleecy -description: title_api_settings_changed event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_api_settings_changed - -This event is triggered when an API Features setting is changed for the title. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeveloperId|String|| -|PreviousSettingsValues|[APISettings](data-types/apisettings.md)|Settings values before the change.| -|SettingsValues|[APISettings](data-types/apisettings.md)|Settings values after the change.| -|UserId|String|| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-catalog-updated.md b/playfab-docs/api-references/events/title-catalog-updated.md index 391eeb1ae..f6104f133 100644 --- a/playfab-docs/api-references/events/title-catalog-updated.md +++ b/playfab-docs/api-references/events/title-catalog-updated.md @@ -25,18 +25,4 @@ This event is triggered when a catalog is changed. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-client-rate-limited-alert.md b/playfab-docs/api-references/events/title-client-rate-limited-alert.md index ac556030a..7ce5e82b7 100644 --- a/playfab-docs/api-references/events/title-client-rate-limited-alert.md +++ b/playfab-docs/api-references/events/title-client-rate-limited-alert.md @@ -27,18 +27,4 @@ This event is triggered when a single IP address generates too many API calls to ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-completed-task.md b/playfab-docs/api-references/events/title-completed-task.md deleted file mode 100644 index 02b774b92..000000000 --- a/playfab-docs/api-references/events/title-completed-task.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: title_completed_task -author: joannaleecy -description: title_completed_task event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_completed_task - -This event is triggered when a scheduled task has completed - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|AbortedAt|DateTime|Timestamp on when the task was aborted. Null if task never was aborted.| -|IsAborted|Boolean|Whether the task was aborted.| -|Result|[TaskInstanceStatus](data-types/taskinstancestatus.md)|Result of the task run, whether it has succeeded, failed or aborted.| -|Summary|object|Summary of the task run. Different task types have different summary structure.| -|TaskInstanceId|String|ID of the running instance of the task| -|TaskType|String|Type of the scheduled task| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-created-task.md b/playfab-docs/api-references/events/title-created-task.md deleted file mode 100644 index c322a4363..000000000 --- a/playfab-docs/api-references/events/title-created-task.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: title_created_task -author: joannaleecy -description: title_created_task event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_created_task - -This event is triggered when a task is created. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeveloperId|String|| -|ScheduledTask|[NameIdentifier](data-types/nameidentifier.md)|Identity of the scheduled task| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-deleted-master-player.md b/playfab-docs/api-references/events/title-deleted-master-player.md index 8ea9bfcc1..10e686b6a 100644 --- a/playfab-docs/api-references/events/title-deleted-master-player.md +++ b/playfab-docs/api-references/events/title-deleted-master-player.md @@ -24,18 +24,4 @@ This event is triggered when a GDPR delete is finished. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-deleted-task.md b/playfab-docs/api-references/events/title-deleted-task.md deleted file mode 100644 index f35609a0c..000000000 --- a/playfab-docs/api-references/events/title-deleted-task.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: title_deleted_task -author: joannaleecy -description: title_deleted_task event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_deleted_task - -This event is triggered when a task is deleted. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeveloperId|String|| -|ScheduledTask|[NameIdentifier](data-types/nameidentifier.md)|Identity of the scheduled task| -|UserId|String|| - - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-deleted.md b/playfab-docs/api-references/events/title-deleted.md index 7dae3e639..39d5aba34 100644 --- a/playfab-docs/api-references/events/title-deleted.md +++ b/playfab-docs/api-references/events/title-deleted.md @@ -16,18 +16,4 @@ This event is triggered when a game title is deleted. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-exceeded-limit.md b/playfab-docs/api-references/events/title-exceeded-limit.md deleted file mode 100644 index e202620ef..000000000 --- a/playfab-docs/api-references/events/title-exceeded-limit.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: title_exceeded_limit -author: joannaleecy -description: title_exceeded_limit event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_exceeded_limit - -This event is triggererd when a title exceeds a service limit and receives an error. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|Details|Object|Additional details about the exceeded limit| -|LimitDisplayName|String|The display name of the limit that was exceeded.| -|LimitId|String|The unique identifier of the limit that was exceeded.| -|LimitValue|double|The limit value that was exceeded.| -|Unit|[MetricUnit](data-types/metricunit.md)|The unit of the limit that was exceeded.| -|Value|double|The value that exceeded the limit.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-high-error-rate-alert.md b/playfab-docs/api-references/events/title-high-error-rate-alert.md index 39e6c7cd5..258a46e21 100644 --- a/playfab-docs/api-references/events/title-high-error-rate-alert.md +++ b/playfab-docs/api-references/events/title-high-error-rate-alert.md @@ -27,18 +27,4 @@ This event is triggered when a game title experiences a high rate of errors. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-initiated-player-password-reset.md b/playfab-docs/api-references/events/title-initiated-player-password-reset.md index b350fff6b..40bf72bd1 100644 --- a/playfab-docs/api-references/events/title-initiated-player-password-reset.md +++ b/playfab-docs/api-references/events/title-initiated-player-password-reset.md @@ -26,18 +26,4 @@ This event is triggered when a title initiates the account recovery process for ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-limit-changed.md b/playfab-docs/api-references/events/title-limit-changed.md deleted file mode 100644 index aa58ef5bf..000000000 --- a/playfab-docs/api-references/events/title-limit-changed.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: title_limit_changed -author: joannaleecy -description: title_limit_changed event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_limit_changed - -This event is triggered when a title changes a service limit. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|LimitDisplayName|String|The display name of the limit that changed.| -|LimitId|String|The unique identifier of the limit that changed.| -|PreviousPriceUSD|double|The price of the limit level in US Dollars before the change, if any.| -|PreviousValue|double|The limit value before the change, if any.| -|PriceUSD|double|The price of the limit level in US Dollars, if any.| -|TransactionId|String|The unique identifier of the limit change transaction.| -|Unit|[MetricUnit](data-types/metricunit.md)|The unit of the limit that changed.| -|Value|double|The limit value after the change, if any.| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-news-updated.md b/playfab-docs/api-references/events/title-news-updated.md index e8a4d7c0d..71882bc84 100644 --- a/playfab-docs/api-references/events/title-news-updated.md +++ b/playfab-docs/api-references/events/title-news-updated.md @@ -25,18 +25,4 @@ This event is triggered when a title news is created or updated. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-permission-policy-changed.md b/playfab-docs/api-references/events/title-permission-policy-changed.md deleted file mode 100644 index 0e0addc01..000000000 --- a/playfab-docs/api-references/events/title-permission-policy-changed.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: title_permission_policy_changed -author: joannaleecy -description: title_permission_policy_changed event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_permission_policy_changed - -This event is triggered when an update occurs to a a title's permission policies. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeveloperId|String|| -|NewPolicy|String|The contents new policy.| -|PolicyName|String|The name of the policy that was changed| -|UserId|String|| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-profile-view-constraints-changed.md b/playfab-docs/api-references/events/title-profile-view-constraints-changed.md index e8ddc6ba7..f3dff05ec 100644 --- a/playfab-docs/api-references/events/title-profile-view-constraints-changed.md +++ b/playfab-docs/api-references/events/title-profile-view-constraints-changed.md @@ -26,18 +26,4 @@ This event is triggered when a profile view constraint is changed for the title. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-published-cloudscript.md b/playfab-docs/api-references/events/title-published-cloudscript.md deleted file mode 100644 index 8cd6c515f..000000000 --- a/playfab-docs/api-references/events/title-published-cloudscript.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: title_published_cloudscript -author: joannaleecy -description: title_published_cloudscript event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_published_cloudscript - -An inactive revision of CloudScript has been made into the active 'live' version. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeveloperId|String|| -|Revision|int32|Revision number of the CloudScript that was activated.| -|UserId|String|| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-queue-config-updated.md b/playfab-docs/api-references/events/title-queue-config-updated.md index 3f2e8a888..6a9394c68 100644 --- a/playfab-docs/api-references/events/title-queue-config-updated.md +++ b/playfab-docs/api-references/events/title-queue-config-updated.md @@ -25,18 +25,4 @@ This event is triggered when a queue config is changed. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/title-requested-limit-change.md b/playfab-docs/api-references/events/title-requested-limit-change.md index 0f35391fd..c4b52b7fd 100644 --- a/playfab-docs/api-references/events/title-requested-limit-change.md +++ b/playfab-docs/api-references/events/title-requested-limit-change.md @@ -33,18 +33,4 @@ This event is triggered when a title requests a service limit change. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-saved-survey.md b/playfab-docs/api-references/events/title-saved-survey.md index f5aae4c76..0291fac07 100644 --- a/playfab-docs/api-references/events/title-saved-survey.md +++ b/playfab-docs/api-references/events/title-saved-survey.md @@ -27,18 +27,4 @@ This event is triggered when a game's survey is saved. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-scheduled-cloudscript-executed.md b/playfab-docs/api-references/events/title-scheduled-cloudscript-executed.md deleted file mode 100644 index 58dd5bc5f..000000000 --- a/playfab-docs/api-references/events/title-scheduled-cloudscript-executed.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: title_scheduled_cloudscript_executed -author: joannaleecy -description: title_scheduled_cloudscript_executed event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_scheduled_cloudscript_executed - -This event is triggered when a CloudScript function is run by a scheduled task. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CloudScriptExecutionResult|[ExecuteCloudScriptResult](data-types/executecloudscriptresult.md)|Result of the CloudScript function, including an error information. Useful for debugging.| -|FunctionName|String|Name of the CloudScript function that was called.| -|ScheduledTask|[NameId](data-types/nameid.md)|Scheduled task that called the CloudScript| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-secret-key-changed.md b/playfab-docs/api-references/events/title-secret-key-changed.md index c7c9d7831..77e5001ad 100644 --- a/playfab-docs/api-references/events/title-secret-key-changed.md +++ b/playfab-docs/api-references/events/title-secret-key-changed.md @@ -28,18 +28,4 @@ This event is triggered when a title adds or updates a Secret Key ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-started-task.md b/playfab-docs/api-references/events/title-started-task.md deleted file mode 100644 index 16f5a3bf5..000000000 --- a/playfab-docs/api-references/events/title-started-task.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: title_started_task -author: joannaleecy -description: title_started_task event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_started_task - -This event is triggered when a task is scheduled to run. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeveloperId|String|| -|Parameter|object|Parameter of the scheduled task| -|ScheduledByUserId|String|ID of user who manually scheduled the task, null if scheduled automatically| -|ScheduledTask|[NameIdentifier](data-types/nameidentifier.md)|Identity of the scheduled task| -|TaskInstanceId|String|ID of the running instance of the task| -|TaskType|String|Type of the scheduled task| -|UserId|String|| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/title-statistic-version-changed.md b/playfab-docs/api-references/events/title-statistic-version-changed.md index 8f0706151..370825e4f 100644 --- a/playfab-docs/api-references/events/title-statistic-version-changed.md +++ b/playfab-docs/api-references/events/title-statistic-version-changed.md @@ -25,18 +25,4 @@ This event is triggered when the version of a statistic changes, causing its lea ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-store-updated.md b/playfab-docs/api-references/events/title-store-updated.md index d872b8d6b..1a5261799 100644 --- a/playfab-docs/api-references/events/title-store-updated.md +++ b/playfab-docs/api-references/events/title-store-updated.md @@ -26,18 +26,4 @@ This event is triggered when a store is changed. ## Common Properties -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv1.md)] diff --git a/playfab-docs/api-references/events/title-updated-task.md b/playfab-docs/api-references/events/title-updated-task.md deleted file mode 100644 index 39a2b55a2..000000000 --- a/playfab-docs/api-references/events/title-updated-task.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: title_updated_task -author: joannaleecy -description: title_updated_task event. -ms.author: jenelleb -ms.date: 02/19/2019 -ms.topic: article -ms.service: azure-playfab -keywords: playfab, playstream events -ms.localizationpriority: medium ---- - -# title_updated_task - -This event is triggered when a task is updated. - -## Properties - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|DeveloperId|String|| -|HasRenamed|Boolean|| -|ScheduledTask|[NameIdentifier](data-types/nameidentifier.md)|Identity of the scheduled task| -|UserId|String|| - -## Common Properties - -All PlayStream events are formatted as JSON objects and share the following common properties: - -|Name|Type|Description| -| :--------------------|:-------------------|:----------------------| -|CustomTags|Object|Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.| -|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| -|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| -|EventId|String|PlayFab-assigned unique identifier for this event.| -|EventName|String|The name of this event.| -|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| -|History|[PlayStreamEventHistory](data-types/playstreameventhistory.md)|The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.| -|Reserved|object|Reserved exclusively for PlayFab internal use.| -|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| -|SourceType|[SourceType](data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| -|Timestamp|DateTime|The time (in UTC) associated with this event.| diff --git a/playfab-docs/api-references/events/vm-assigned.md b/playfab-docs/api-references/events/vm-assigned.md new file mode 100644 index 000000000..050f9d82b --- /dev/null +++ b/playfab-docs/api-references/events/vm-assigned.md @@ -0,0 +1,26 @@ +--- +title: vm_assigned +author: joannaleecy +description: vm_assigned event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# vm_assigned + +This event is triggered when a virtual machine is assigned to a multiplayer server build. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[VmAssignedEventPayload](data-types/vmassignedeventpayload.md)|The multiplayer server virtual machine assigned event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/vm-game-certificates-deployed.md b/playfab-docs/api-references/events/vm-game-certificates-deployed.md new file mode 100644 index 000000000..a6862f31b --- /dev/null +++ b/playfab-docs/api-references/events/vm-game-certificates-deployed.md @@ -0,0 +1,26 @@ +--- +title: vm_game_certificates_deployed +author: valexao +description: vm_game_certificates_deployed event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# vm_game_certificates_deployed + +This event is triggered when game certificates are deployed in a game virtual machine. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[VmGameCertificatesDeployedEventPayload](data-types/vmgamecertificatesdeployedeventpayload.md)|The multiplayer server vm game certificates deployed event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/vm-remote-user-created.md b/playfab-docs/api-references/events/vm-remote-user-created.md new file mode 100644 index 000000000..c2a19609a --- /dev/null +++ b/playfab-docs/api-references/events/vm-remote-user-created.md @@ -0,0 +1,26 @@ +--- +title: vm_remote_user_created +author: joannaleecy +description: vm_remote_user_created event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# vm_remote_user_created + +This event is triggered when a multiplayer server virtual machine remote user is created. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[VmRemoteUserCreatedEventPayload](data-types/vmremoteusercreatedeventpayload.md)|The multiplayer server virtual machine remote user created event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/vm-remote-user-deleted.md b/playfab-docs/api-references/events/vm-remote-user-deleted.md new file mode 100644 index 000000000..d3fb0b72c --- /dev/null +++ b/playfab-docs/api-references/events/vm-remote-user-deleted.md @@ -0,0 +1,26 @@ +--- +title: vm_remote_user_deleted +author: joannaleecy +description: vm_remote_user_deleted event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# vm_remote_user_deleted + +This event is triggered when a multiplayer server virtual machine remote user is deleted. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[VmRemoteUserDeletedEventPayload](data-types/vmremoteuserdeletedeventpayload.md)|The multiplayer server virtual machine remote user deleted event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/vm-state-change.md b/playfab-docs/api-references/events/vm-state-change.md new file mode 100644 index 000000000..f26bd9350 --- /dev/null +++ b/playfab-docs/api-references/events/vm-state-change.md @@ -0,0 +1,27 @@ +--- +title: vm_state_change +author: valexao +description: vm_state_change event. +ms.author: vorelien +ms.date: 12/30/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# vm_state_change + +This event is triggered when a multiplayer virtual machine's state is changed. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[VmStateChangeEventPayload](data-types/vmstatechangeeventpayload.md)|The multiplayer server vm state change event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] + diff --git a/playfab-docs/api-references/events/vm-unassignment-started.md b/playfab-docs/api-references/events/vm-unassignment-started.md new file mode 100644 index 000000000..17ef1a416 --- /dev/null +++ b/playfab-docs/api-references/events/vm-unassignment-started.md @@ -0,0 +1,25 @@ +--- +title: vm_unassignment_started +author: joannaleecy +description: vm_unassignment_started event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# vm_unassignment_started +This event is triggered when a virtual machine is unassigned from a multiplayer server build. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[VmUnassignmentStartedEventPayload](data-types/vmunassignmentstartedeventpayload.md)|The multiplayer server virtual machine unassignment started event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/events/vm-unhealthy.md b/playfab-docs/api-references/events/vm-unhealthy.md new file mode 100644 index 000000000..28a2269aa --- /dev/null +++ b/playfab-docs/api-references/events/vm-unhealthy.md @@ -0,0 +1,25 @@ +--- +title: vm_unhealthy +author: joannaleecy +description: vm_unhealthy event. +ms.author: jenelleb +ms.date: 02/19/2019 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, playstream events +ms.localizationpriority: medium +--- + +# vm_unhealthy +This event is triggered when a virtual machine is found to be unhealthy. + +## Properties + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityLineage|[EntityLineage](data-types/entitylineage.md)|Entities that this entity is a child of.| +|Payload|[VmUnhealthyEventPayload](data-types/vmunhealthyeventpayload.md)|The multiplayer server virtual machine unhealthy event payload.| + +## Common Properties + +[!INCLUDE [common-properties](../../includes/_common-properties-eventsv2.md)] diff --git a/playfab-docs/api-references/toc.yml b/playfab-docs/api-references/toc.yml index b1afb264f..3bad324b8 100644 --- a/playfab-docs/api-references/toc.yml +++ b/playfab-docs/api-references/toc.yml @@ -111,32 +111,54 @@ href: events/matchmaking-user-ticket-completed.md - name: matchmaking_user_ticket_invite href: events/matchmaking-user-ticket-invite.md - - name: multiplayer_server_build_deleted - href: events/multiplayer-server-build-deleted.md - - name: multiplayer_server_build_region_status_changed - href: events/multiplayer-server-build-region-status-changed.md - - name: multiplayer_server_build_region_updated - href: events/multiplayer-server-build-region-updated.md - - name: multiplayer_server_certificate_deleted - href: events/multiplayer-server-certificate-deleted.md - - name: multiplayer_server_certificate_uploaded - href: events/multiplayer-server-certificate-uploaded.md - - name: multiplayer_server_create_build_initiated - href: events/multiplayer-server-create-build-initiated.md - - name: multiplayer_server_game_asset_deleted - href: events/multiplayer-server-game-asset-deleted.md - - name: multiplayer_server_requested - href: events/multiplayer-server-requested.md - - name: multiplayer_server_state_changed - href: events/multiplayer-server-state-changed.md - - name: multiplayer_server_vm_assigned - href: events/multiplayer-server-vm-assigned.md - - name: multiplayer_server_vm_remote_user_created - href: events/multiplayer-server-vm-remote-user-created.md - - name: multiplayer_server_vm_remote_user_deleted - href: events/multiplayer-server-vm-remote-user-deleted.md - - name: multiplayer_server_vm_unassignment_started - href: events/multiplayer-server-vm-unassignment-started.md + - name: build_alias_created + href: events/build-alias-created.md + - name: build_alias_deleted + href: events/build-alias-deleted.md + - name: build_alias_updated + href: events/build-alias-updated.md + - name: build_deleted + href: events/build-deleted.md + - name: build_region_status_changed + href: events/build-region-status-changed.md + - name: build_region_updated + href: events/build-region-updated.md + - name: build_region_utilization + href: events/build-region-utilization.md + - name: certificate_deleted + href: events/certificate-deleted.md + - name: certificate_uploaded + href: events/certificate-uploaded.md + - name: crash_detected + href: events/crash-detected.md + - name: create_build_initiated + href: events/create-build-initiated.md + - name: enabled_for_title + href: events/enabled-for-title.md + - name: game_asset_deleted + href: events/game-asset-deleted.md + - name: monitoring_output_saved + href: events/monitoring-output-saved.md + - name: secret_added + href: events/secret-added.md + - name: secret_deleted + href: events/secret-deleted.md + - name: server_requested + href: events/server-requested.md + - name: server_state_changed + href: events/server-state-changed.md + - name: vm_assigned + href: events/vm-assigned.md + - name: vm_game_certificates_deployed + href: events/vm-game-certificates-deployed.md + - name: vm_remote_user_created + href: events/vm-remote-user-created.md + - name: vm_remote_user_deleted + href: events/vm-remote-user-deleted.md + - name: vm_unassignment_started + href: events/vm-unassignment-started.md + - name: vm_unhealthy + href: events/vm-unhealthy.md - name: player_action_executed href: events/player-action-executed.md - name: player_ad_activity_valued diff --git a/playfab-docs/community/leaderboards/index.md b/playfab-docs/community/leaderboards/index.md index c17cf486b..684107747 100644 --- a/playfab-docs/community/leaderboards/index.md +++ b/playfab-docs/community/leaderboards/index.md @@ -72,4 +72,5 @@ has a Statistics engine doing the aggregation. - [API reference](api-reference.md) - [Quota](quota-leaderboards.md) - [Leaderboard meters](../../pricing/Meters/leaderboard-meters.md) +- [Leaderboards and Cloudscript](leaderboards-cloudscript.md). - [Leaderboards With PlayStream and Telemetry](./leaderboards-with-playstream-and-telemetry.md) diff --git a/playfab-docs/community/leaderboards/toc.yml b/playfab-docs/community/leaderboards/toc.yml index fddb12bd9..f5b84daaa 100644 --- a/playfab-docs/community/leaderboards/toc.yml +++ b/playfab-docs/community/leaderboards/toc.yml @@ -25,6 +25,8 @@ items: href: manual-tiers.md - name: Leaderboards with PlayStream and Telemetry href: leaderboards-with-playstream-and-telemetry.md + - name: Leaderboards with Cloud Script + href: leaderboards-cloudscript.md - name: API reference href: api-reference.md - name: Tournaments & Leaderboards (Deprecated) diff --git a/playfab-docs/data-analytics/export-data/data-connection-azure-blob.md b/playfab-docs/data-analytics/export-data/data-connection-azure-blob.md index 6e2945b81..74233d2cf 100644 --- a/playfab-docs/data-analytics/export-data/data-connection-azure-blob.md +++ b/playfab-docs/data-analytics/export-data/data-connection-azure-blob.md @@ -11,7 +11,7 @@ ms.localizationpriority: medium --- # Configuring your Azure Storage Data Connection -First, you need an Azure subscription and a storage account. +First, you need an Azure subscription and a storage account. For existing PlayFab and Azure customers, you can create a storage container on the [Azure portal](https://ms.portal.azure.com/#allservices) and get started with Data Connections on [Azure PlayFab](https://developer.playfab.com/en-US/sign-up). @@ -36,13 +36,13 @@ For PlayFab to ingest data in your storage account, container details along with - Go to the right of the main window and select the three ellipses associated with your chosen container. - Select **Generate SAS** from the dropdown menu to open the **Generate SAS** window. -![Screenshot of SAS token on the container level - Option 1](media/SAS-token-on-the-container-level-1.png "SAS token on the container level - Option 1") +![Screenshot of SAS token on the container level - Option 1](media/SAS-token-on-the-container-level-1.png "SAS token on the container level - Option 1") - Define **Permissions** by selecting or clearing the appropriate checkbox. Make sure the **Create** and **Write** permissions are selected. -![Screenshot of Generate SAS token - Option 1](media/Generate-SAS-token-level.png "Generate SAS token - Option 1") +![Screenshot of Generate SAS token - Option 1](media/Generate-SAS-token-level.png "Generate SAS token - Option 1") -- Specify the signed key **Start** and **Expiry** times. +- Specify the signed key **Start** and **Expiry** times. - Select **Generate SAS token and URL**. - The **Blob SAS token** query string appears in the lower area of the window. - Copy and paste the **Blob SAS token** values into a **secure location for use in the Azure PlayFab Data Connections**. It's displayed only once and can't be retrieved after the window is closed. @@ -51,23 +51,23 @@ For PlayFab to ingest data in your storage account, container details along with > [!Important] > Generate and retrieve the shared access signature for your storage account itself. -- In the [Azure portal](https://ms.portal.azure.com/#allservices), select **Your storage account** +- In the [Azure portal](https://ms.portal.azure.com/#allservices), select **Your storage account** - Select a **Shared access signature** from the list under **Security + Networking**. -- Define **Services** by selecting **blob** and clearing other checkboxes. -- Define **Resource Type** by selecting **Object** and clearing other checkboxes. -- Make sure the **Create** and **Write** permissions are selected. -- Specify the signed key **Start** and **Expiry** times. +- Define **Services** by selecting **blob** and clearing other checkboxes. +- Define **Resource Type** by selecting **Container** and **Object** (clear other checkboxes). +- Make sure the **Create**, **Write**, and **List** are selected. +- Specify the signed key **Start** and **Expiry** times. - Select **Generate SAS token and URL**. - The Blob SAS token query string appears in the lower area of the window. - Copy and paste the **Blob SAS token** values into a **secure location for use in the Azure PlayFab Data Connections**. It's displayed only once and can't be retrieved after the window is closed. -![Screenshot of SAS token on the account level - Option 2](media/SAS-token-on-the-account-level.png "SAS token on the account level - Option 2") +![Screenshot of SAS token on the account level - Option 2](media/SAS-token-on-the-account-level.png "SAS token on the account level - Option 2") ## Create an Azure Blob Data Connection in PlayFab ### Step 1: Navigate to the data connections tab -![Screenshot of PlayFab data connections tab](media/navigate-to-data-connections-tab.png "PlayFab data connections tab") +![Screenshot of PlayFab data connections tab](media/navigate-to-data-connections-tab.png "PlayFab data connections tab") - Login to PlayFab and navigate to your title. - Click on the “Data” section in the left-hand menu @@ -81,12 +81,12 @@ For PlayFab to ingest data in your storage account, container details along with | Value | Details | |:-----------|:-----------| -|Name | The friendly name of your data connection. This name will allow you to find the data connection later to edit it. Put a descriptive name here. +|Name | The friendly name of your data connection. This name will allow you to find the data connection later to edit it. Put a descriptive name here. | Account name | The Azure Storage Account. | | Container name | The Azure Storage Account Container. | | Sas token | Either the SAS token generated by the container, or the Blob SAS token query string. | -![Screenshot of configuring and ADX data connection](media/configure-new-data-connection-blob.PNG "ADX data connection configuration") +![Screenshot of configuring and ADX data connection](media/configure-new-data-connection-blob.PNG "ADX data connection configuration") > [!Note] -> We recommend using a table name that does not exist. If you use an existing table and the schema is not what PlayFab is expecting, then the schema will be modified. +> We recommend using a table name that does not exist. If you use an existing table and the schema is not what PlayFab is expecting, then the schema will be modified. diff --git a/playfab-docs/economy-monetization/economy-v2/limits.md b/playfab-docs/economy-monetization/economy-v2/limits.md index 51025a9be..cc9e76e92 100644 --- a/playfab-docs/economy-monetization/economy-v2/limits.md +++ b/playfab-docs/economy-monetization/economy-v2/limits.md @@ -69,8 +69,8 @@ The purpose of this guide is to detail the limits that are enforced when creatin | **API** | **Limit (Player)** | **Limit (Title)** | |---------|--------------------|-------------------| -| **GetInventoryItems** | 1.67 rps (100 in 60 seconds) | - | -| **GetInventoryCollectionIds** | 1.67 rps (100 in 60 seconds) | - | +| **GetInventoryItems** | 0.67 rps (40 in 60 seconds) | - | +| **GetInventoryCollectionIds** | 0.08 rps (5 in 60 seconds) | - | ### Read Transaction History @@ -82,25 +82,25 @@ The purpose of this guide is to detail the limits that are enforced when creatin | **API** | **Limit (Player)** | **Limit (Title)** | |---------|--------------------|-------------------| -| **AddInventoryItems** | 0.66 rps (60 in 90 seconds) | - | -| **SubtractInventoryItems** | 0.66 rps (60 in 90 seconds) | - | -| **UpdateInventoryItems** | 0.66 rps (60 in 90 seconds) | - | -| **PurchaseInventoryItems** | 0.66 rps (60 in 90 seconds) | - | -| **TransferInventoryItems** | 0.66 rps (60 in 90 seconds) | - | -| **DeleteInventoryItems** | 0.66 rps (60 in 90 seconds) | - | -| **ExecuteInventoryOperations** | 0.66 rps (60 in 90 seconds) | - | -| **DeleteInventoryCollection** | 0.16 rps (15 in 90 seconds) | - | +| **AddInventoryItems** | 0.33 rps (20 in 60 seconds) | - | +| **SubtractInventoryItems** | 0.33 rps (20 in 60 seconds) | - | +| **UpdateInventoryItems** | 0.33 rps (20 in 60 seconds) | - | +| **PurchaseInventoryItems** | 0.33 rps (20 in 60 seconds) | - | +| **TransferInventoryItems** | 0.33 rps (20 in 60 seconds) | - | +| **DeleteInventoryItems** | 0.33 rps (20 in 60 seconds) | - | +| **ExecuteInventoryOperations** | 0.33 rps (20 in 60 seconds) | - | +| **DeleteInventoryCollection** | 0.08 rps (5 in 60 seconds) | - | ### Redeem | **API** | **Limit (Player)** | **Limit (Title)** | |---------|--------------------|-------------------| -| **RedeemAppleAppStoreInventoryItems** | 0.66 rps (60 in 90 seconds) | - | -| **RedeemGooglePlayInventoryItems** | 0.66 rps (60 in 90 seconds) | - | -| **RedeemMicrosoftStoreInventorItems** | 0.66 rps (60 in 90 seconds) | - | -| **RedeemNintendoEShopInventoryItems** | 0.66 rps (60 in 90 seconds) | - | -| **RedeemPlayStationStoreInventoryItems** | 0.66 rps (60 in 90 seconds) | - | -| **RedeemSteamInventoryItems** | 0.66 rps (60 in 90 seconds) | - | +| **RedeemAppleAppStoreInventoryItems** | 0.16 rps (10 in 60 seconds) | - | +| **RedeemGooglePlayInventoryItems** | 0.16 rps (10 in 60 seconds) | - | +| **RedeemMicrosoftStoreInventorItems** | 0.16 rps (10 in 60 seconds) | - | +| **RedeemNintendoEShopInventoryItems** | 0.16 rps (10 in 60 seconds) | - | +| **RedeemPlayStationStoreInventoryItems** | 0.16 rps (10 in 60 seconds) | - | +| **RedeemSteamInventoryItems** | 0.16 rps (10 in 60 seconds) | - | ## API Limits diff --git a/playfab-docs/identity/index.yml b/playfab-docs/identity/index.yml index 871e72c9f..9f390886d 100644 --- a/playfab-docs/identity/index.yml +++ b/playfab-docs/identity/index.yml @@ -52,6 +52,8 @@ landingContent: url: player-identity/platform-specific-authentication/google-sign-in-unity.md - text: Setup Sign In with Apple for PlayFab url: player-identity/platform-specific-authentication/apple-open-id.md + - text: Setting up Xbox Live title association in PlayFab + url: player-identity/platform-specific-authentication/xbox-live-add-on.md - text: Running an HTTP server for testing url: player-identity/platform-specific-authentication/running-an-http-server-for-testing.md diff --git a/playfab-docs/identity/player-identity/platform-specific-authentication/index.md b/playfab-docs/identity/player-identity/platform-specific-authentication/index.md index 1fdcb122a..d8763996c 100644 --- a/playfab-docs/identity/player-identity/platform-specific-authentication/index.md +++ b/playfab-docs/identity/player-identity/platform-specific-authentication/index.md @@ -16,7 +16,7 @@ PlayFab supports a wide variety of authentication providers. This allows your ti What this means is that your players can choose how they prefer to verify their identity and sign in using a method that's most natural to them. -Select authentication providers based on what is most meaningful for the players on your target platforms and distribution methods. For example, if your title is released on Xbox, it will make sense to offer Xbox Live sign-in as a way to authenticate their identity. +Select authentication providers based on what is most meaningful for the players on your target platforms and distribution methods. For example, if your title is released on Xbox, it makes sense to offer Xbox Live sign-in as a way to authenticate their identity. ### Apple @@ -41,11 +41,11 @@ Select authentication providers based on what is most meaningful for the players - [Setting up PlayFab authentication using Kongregate and HTML5](kongregate-html5.md) - [Setting up PlayFab authentication using Kongregate and Unity](kongregate-unity.md) -### PlayStation® +### PlayStation®5 / PlayStation®4 - [Setting up PlayFab authentication using PlayStation (secure link)](https://dev.azure.com/PlayFabPrivate/PS5/_git/XPlatCppSdk-Private-PS5?path=%2FGuideToLoginWithPSN.md&_a=preview) -If you're unable to access the above secure link, see [Request access](https://aka.ms/pf-partner-request-access). +If you're unable to access the secure link, see [Request access](https://aka.ms/pf-partner-request-access). "PlayStation" is a registered trademark or trademark of Sony Interactive Entertainment Inc. @@ -59,6 +59,7 @@ If you're unable to access the above secure link, see [Request access](https://a ### Windows and Xbox +- [Setting up Xbox Live title association in PlayFab](xbox-live-add-on.md) - [Authenticate Xbox Live users using PlayFab's Xbox Live Helper Library (recommended)](../../../multiplayer/networking/party-xbox-live-guide.md#mapping-between-xbox-live-user-ids-and-playfab-entity-ids) - [Setting up PlayFab authentication using Universal Windows Platform](uwp.md) - [Integrating the Universal Windows Platform with PlayFab](uwp-integration.md) diff --git a/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/Xbox-live-add-on-page.png b/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/Xbox-live-add-on-page.png new file mode 100644 index 000000000..602cb5192 Binary files /dev/null and b/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/Xbox-live-add-on-page.png differ diff --git a/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/partner-center-configuration-page.png b/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/partner-center-configuration-page.png new file mode 100644 index 000000000..d6dc11678 Binary files /dev/null and b/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/partner-center-configuration-page.png differ diff --git a/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/partner-center-product-id.png b/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/partner-center-product-id.png new file mode 100644 index 000000000..d86f54f60 Binary files /dev/null and b/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/partner-center-product-id.png differ diff --git a/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/xbox-add-on-installation-validation.png b/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/xbox-add-on-installation-validation.png new file mode 100644 index 000000000..9bb590e03 Binary files /dev/null and b/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/xbox-add-on-installation-validation.png differ diff --git a/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/xbox-add-on-installation.png b/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/xbox-add-on-installation.png new file mode 100644 index 000000000..e4679e959 Binary files /dev/null and b/playfab-docs/identity/player-identity/platform-specific-authentication/media/tutorials/xbox-add-on/xbox-add-on-installation.png differ diff --git a/playfab-docs/identity/player-identity/platform-specific-authentication/toc.yml b/playfab-docs/identity/player-identity/platform-specific-authentication/toc.yml index c5dc286b5..d5c88b4e4 100644 --- a/playfab-docs/identity/player-identity/platform-specific-authentication/toc.yml +++ b/playfab-docs/identity/player-identity/platform-specific-authentication/toc.yml @@ -33,6 +33,8 @@ href: uwp.md - name: Setup Sign In with Apple for PlayFab href: apple-open-id.md + - name: Setting up Xbox Live title association in PlayFab + href: xbox-live-add-on.md - name: Integrating the Universal Windows Platform with PlayFab href: uwp-integration.md - name: Setting up Playfab Authentication using Anonymous Login diff --git a/playfab-docs/identity/player-identity/platform-specific-authentication/xbox-live-add-on.md b/playfab-docs/identity/player-identity/platform-specific-authentication/xbox-live-add-on.md new file mode 100644 index 000000000..596edabee --- /dev/null +++ b/playfab-docs/identity/player-identity/platform-specific-authentication/xbox-live-add-on.md @@ -0,0 +1,64 @@ +--- +title: Xbox Live Title Association +author: antnguyen +description: Learn how to set up and configure scoped token validation by linking Partner Center product ID to PlayFab title ID. +ms.author: antnguyen +ms.date: 10/09/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, authentication, server, partner center, xbox, xbox live +ms.localizationpriority: medium +--- + +# Setting up Xbox Live title association in PlayFab + +Learn how to configure scoped token validation by linking your Partner Center product ID to a PlayFab title ID. + +## Overview + +In this tutorial, you'll learn how to configure token validation by specifying which Xbox Live title tokens that PlayFab APIs accept when they use Xbox Live token parameters—giving you more control over integration behavior and enabling scoped token acceptance. These APIs include `Client/loginwithxbox`, `Client/LinkXboxAccount`, `Client/UnlinkXboxAccount`, `Client/ConsumeXboxEntitlement`, `Client/GetFriendLeaderboard`, `Client/GetFriendLeaderboardAroundCurrentUser`, `Client/GetFriendLeaderboardAroundPlayer`, `Client/ConsumeMicrosoftStoreEntitlements`, `Server/loginwithxbox`, `Server/LinkXboxAccount`, `Server/UnlinkXboxAccount`, `Server/GetFriendLeaderboard`, `Server/GetFriendsList`, `Server/GetFriendLeaderboardForEntity`, `Lobby/GetFriendLobbies`, `Server/GetFriendLeaderboardAroundPlayer`, `Inventory/RedeemMicrosoftStoreInventoryItems`, and `Inventory/Redeem`. + +## Requirements + +- A registered [PlayFab](https://playfab.com/) title. +- [Partner Center](https://partner.microsoft.com/) account with an Xbox Live enabled title. + +## Partner Center Product ID and Xbox Live Title ID + +Start by navigating to the product page for your Partner Center title. + +1. In the Partner Center dashboard, navigate to [Apps and Games](https://partner.microsoft.com/dashboard/apps-and-games/overview). +2. Locate and select the Xbox Live enabled Partner Center title you wish to associate with PlayFab. +3. Find and copy the Product ID from the URL of your game. + +![Parter Center product ID](media/tutorials/xbox-add-on/partner-center-product-id.png) + +4. Next find and copy the Xbox Live Title ID. Navigate to **Xbox services > Xbox Settings** and copy the **Title ID (decimal)** value. + +![Parter Center title ID](media/tutorials/xbox-add-on/partner-center-configuration-page.png) + +## Install Xbox Live Add-on + +Go to [PlayFab Game Manager](https://developer.playfab.com/) page for your title. + +1. Navigate to **Add-ons** in the menu. +2. Locate and select the **Xbox Live** Add-on icon/link. + +![Xbox live Add-on](media/tutorials/xbox-add-on/xbox-live-add-on-page.png) + +3. Use the **Seller ID** dropdown to select the correct Seller ID from Partner Center. If you don't see the correct Seller ID, select **Sign in with a different partner center account** and sign in with the correct user. + +4. Use the **Product ID** dropdown to find the Partner Center Product ID that will be linked to the PlayFab title. Confirm that the Xbox Live Title ID matches the expected Xbox Live Title ID from Partner Center. + +![PlayFab Parter Center product ID](media/tutorials/xbox-add-on/xbox-add-on-installation.png) + +5. Select **Install Xbox Network** to save the setting and restrict API calls to the selected Xbox Live Title ID. + +![Install Xbox Add-On](media/tutorials/xbox-add-on/xbox-add-on-installation-validation.png) + +By following these steps, you can confidently configure scoped Xbox Live token validation within PlayFab, ensuring that only tokens from designated Partner Center title are accepted. This setup streamlines cross-platform authentication, reinforces title-specific security, and empowers developers to deliver seamless, trusted player experiences across Xbox-enabled services. + +## Further Reading + +- [PlayFab Authentication Overview](../authentication/index.md) +- [Login Basics and Best Practices](../login/login-basics-best-practices.md) \ No newline at end of file diff --git a/playfab-docs/includes/_common-properties-eventsv1.md b/playfab-docs/includes/_common-properties-eventsv1.md new file mode 100644 index 000000000..8b89af9c4 --- /dev/null +++ b/playfab-docs/includes/_common-properties-eventsv1.md @@ -0,0 +1,12 @@ +All V1 PlayStream events are formatted as JSON objects and share the following common properties: + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|EntityId|String|The identifier for the entity (title, player, etc) to which this event applies.| +|EntityType|String|The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.| +|EventId|String|PlayFab-assigned unique identifier for this event.| +|EventName|String|The name of this event.| +|EventNamespace|String|The assigned namespacing for this event. For example: 'com.myprogram.ads'| +|Source|String|The name of the source of this PlayStream event; will be PlayFab if the event originated from us.| +|SourceType|[SourceType](../api-references/events/data-types/sourcetype.md)|The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).| +|Timestamp|DateTime|The time (in UTC) associated with this event.| \ No newline at end of file diff --git a/playfab-docs/includes/_common-properties-eventsv2.md b/playfab-docs/includes/_common-properties-eventsv2.md new file mode 100644 index 000000000..572862134 --- /dev/null +++ b/playfab-docs/includes/_common-properties-eventsv2.md @@ -0,0 +1,12 @@ +All V2 PlayStream events are formatted as JSON objects and most share the following common properties: + +|Name|Type|Description| +| :--------------------|:-------------------|:----------------------| +|SchemaVersion|String|PlayStream event format version, following a semantic versioning scheme.| +|FullName|[Object](../api-references/events/data-types/fullnameobject.md)|Combination of the event name and event namespace to fully specify the event type.| +|Id|String|PlayFab-assigned unique identifier for this event.| +|Timestamp|DateTime|The time (in UTC) associated with this event.| +|Entity|[Object](../api-references/events/data-types/entityobject.md)|Details about the entity to which this event applies including Entity Id and Entity type.| +|Originator|[Object](../api-references/events/data-types/originatorobject.md)|Object describing the source and source type that initiated this event.| +|PayloadContentType|String|Specifies the content of the event payload. Default is "JSON".| +|Origin Info|Object|Optional field containing info about events originating outside of PlayFab.| \ No newline at end of file diff --git a/playfab-docs/live-service-management/game-configuration/entities/available-built-in-entity-types.md b/playfab-docs/live-service-management/game-configuration/entities/available-built-in-entity-types.md index da010037f..ea220e468 100644 --- a/playfab-docs/live-service-management/game-configuration/entities/available-built-in-entity-types.md +++ b/playfab-docs/live-service-management/game-configuration/entities/available-built-in-entity-types.md @@ -53,7 +53,7 @@ Set the `ID` field to your game's **Title ID**. To retrieve the **Title ID**: ## master_player_account -The `master_player_account` is a player entity that is shared by all titles within your studio. +The `master_player_account` is a player entity that is shared by all titles associated to a given namespace. Set the `ID` field to the `LoginResult.PlayFabId` from the classic API. To retrieve the `LoginResult`, call one of the login methods in [Client Authentication](xref:titleid.playfabapi.com.client.authentication). diff --git a/playfab-docs/live-service-management/game-configuration/title-communications/emails/using-a-rule-to-verify-a-contact-email-address.md b/playfab-docs/live-service-management/game-configuration/title-communications/emails/using-a-rule-to-verify-a-contact-email-address.md index a1e8d7706..ea1692fc2 100644 --- a/playfab-docs/live-service-management/game-configuration/title-communications/emails/using-a-rule-to-verify-a-contact-email-address.md +++ b/playfab-docs/live-service-management/game-configuration/title-communications/emails/using-a-rule-to-verify-a-contact-email-address.md @@ -141,6 +141,8 @@ void FailureCallback(PlayFabError error) } ``` +After 'AddOrUpdateContactEmail' succeeds, the com.playfab.player_updated_contact_email event triggers the rule and PlayFab sends the verification email automatically. There is no separate step to send the email. + ## Step 4 - Confirm that the contact email was added to the player's profile Next, confirm that the contact email was added to the player's profile. Log into the **Game Manager**, and visit the **Players Profile** page. @@ -219,5 +221,4 @@ When the player selects that URL, three things happen: So that's it for this tutorial. You've seen how to set up your SMTP server, create an email template, and create a rule that sends an email to a player verifying their email address. -If you have any questions or feedback on this tutorial, please let us know in our [community forums](https://community.playfab.com/). - +If you have any questions or feedback on this tutorial, please let us know in our [community Discord](https://developer.microsoft.com/en-us/games/articles/2024/05/playfab-dev-forums-move-to-discord/). \ No newline at end of file diff --git a/playfab-docs/live-service-management/service-gateway/automation/cloudscript-af/quickstart.md b/playfab-docs/live-service-management/service-gateway/automation/cloudscript-af/quickstart.md index 336735799..777cfeddd 100644 --- a/playfab-docs/live-service-management/service-gateway/automation/cloudscript-af/quickstart.md +++ b/playfab-docs/live-service-management/service-gateway/automation/cloudscript-af/quickstart.md @@ -19,7 +19,7 @@ In this quickstart, you write a CloudScript using Azure Functions with Visual St There are a couple of steps needed to get started with PlayFab C# CloudScript. - Visit the Visual Studio Code [QuickStart: Create an Azure Functions project using Visual Studio Code](/azure/azure-functions/create-first-function-vs-code-csharp?pivots=programming-language-csharp) and return here once you're set up. The following prerequisites are covered in their quickstart guide: - - An [Azure account](https://azure.microsoft.com/free). Signing up for an Azure Account is free + - An [Azure account](https://azure.microsoft.com/free). Signing up for an Azure Account is free - An [Azure Subscription](/azure/cost-management-billing/manage/create-subscription) - A Functions App resource configured in the Azure portal - To minimize latency of your CloudScript using Azure Functions place them in the *US-West*, *US-West 2*, or *US-West 3* Azure regions. @@ -32,7 +32,7 @@ There are a couple of steps needed to get started with PlayFab C# CloudScript. ## Create an Azure Function -1. Create a basic "HelloWorld" example function. You can see how to do this by following the [Create your first function using Visual Studio Code guide](/azure/azure-functions/functions-create-first-function-vs-code). For a code example using PlayFab variables, see the section below [PlayFab Function Context, Variables and using the Server SDKs](#playfabfunctioncontext). +1. Create a basic "HelloWorld" example function. You can see how to do this by following the [Create your first function using Visual Studio Code guide](/azure/azure-functions/functions-create-first-function-vs-code). For a code example using PlayFab variables, see the section [PlayFab Function Context, Variables, and using the Server SDKs](#playfabfunctioncontext). > [!IMPORTANT] > The "Create your first function using Visual Studio Code" guide instructs you to set the Authorization Level of your Azure Function to `Anonymous`. This is done to simplify testing. @@ -46,7 +46,7 @@ There are a couple of steps needed to get started with PlayFab C# CloudScript. 3. For **Name**, enter a human-friendly name for your function. For **Function URL**, enter the HTTP Trigger URL of the function. The URL can be found in the context menu of the Azure function resource as shown in "Run the function in Azure" section of [Quickstart: Create a function in Azure using Visual Studio Code](/azure/azure-functions/create-first-function-vs-code-csharp?pivots=programming-language-csharp#run-the-function-in-azure). If your Azure Function uses `Function` level authorization, the URL contains the Authorization key. -For more information about deploying Azure functions, see [Deploy Azure Functions from Visual Studio Code](https://code.visualstudio.com/tutorials/functions-extension/deploy-app). +For more information about deploying Azure functions, see [Deploy Azure Functions by using Visual Studio Code](https://learn.microsoft.com/azure/azure-functions/functions-develop-vs-code). ## Using and Calling CloudScript using Azure Functions from your PlayFab Title @@ -144,15 +144,15 @@ private void CallCSharpExecuteFunction() ``` -### PlayFab CloudScript Context, Variables and Server SDKs +### PlayFab CloudScript Context, Variables, and Server SDKs -One advantage of using CloudScript using Azure Functions is that the PlayStream Event and Player Profile context is automatically passed to the Azure Function. On invocation of the CloudScript, you receive the context according to the function's invocation scenario. For example, the context is different depending on whether it was triggered by a PlayStream Action or called directly from the client. This includes information such as the entity profile on whose behalf the CloudScripts was invoked, and potentially the PlayStream events used to invoke the CloudScript. +One advantage of using CloudScript using Azure Functions is that the PlayStream Event and Player Profile context is automatically passed to the Azure Function. On invocation of the CloudScript, you receive the context according to the function's invocation scenario. For example, the context varies depending on whether it's triggered by a PlayStream Action or called directly from the client. This includes information such as the entity profile on whose behalf the CloudScripts was invoked, and potentially the PlayStream events used to invoke the CloudScript. 1. You'll need to install the PlayFab SDK via Package Manager. To do this open Terminal or CMD Console in Visual Studio Code and type: `dotnet add package PlayFabAllSDK` 2. You need to include the [CS2AFHelperClasses.cs](https://github.com/PlayFab/PlayFab-Samples/blob/master/Samples/CSharp/AzureFunctions/CS2AFHelperClasses.cs) file that contains the implementation of `PlayFab.Samples` 3. Execution of a script can occur through several methods (APIs, Scheduled Tasks, PlayStream Event, Segment Entering and Exit method). The context of the execution is important to implement your CloudScript. See the [Using CloudScript context models tutorial](CloudScript-af-context.md) for details on how to use the context of the script. -You can use the HelloWorld example below as your first Azure Function. It invokes an entity API and returns a greeting to the authenticated player. Classic server APIs can be invoked in a similar fashion; however, one would need to specify the title secret key in order to make the call. The secret key can be stored in [application settings](/azure/azure-functions/functions-how-to-use-azure-function-app-settings?tabs=portal#settings) and retrieved using `Environment.GetEnvironmentVariable()` method. +You can use the HelloWorld example as your first Azure Function. It invokes an entity API and returns a greeting to the authenticated player. Classic server APIs can be invoked in a similar fashion; however, one would need to specify the title secret key in order to make the call. The secret key can be stored in [application settings](/azure/azure-functions/functions-how-to-use-azure-function-app-settings?tabs=portal#settings) and retrieved using `Environment.GetEnvironmentVariable()` method. ```c# using PlayFab; @@ -233,7 +233,7 @@ To call the HelloWorld Azure Function from a PlayFab SDK use `ExecuteFunction`. ## Azure Functions in Automation Rules -Azure Functions can also be called by creating rules and scheduled tasks. This works in the same way as our standard CloudScript. To create a rule or scheduled task, go to **Automation** > **Rules** or **Automation** > **Scheduled Tasks**. +Azure Functions can also be called by creating rules and scheduled tasks. This works in the same way as our standard CloudScript. To create a rule or scheduled task, go to **Automation** > **Rules** or **Automation** > **Scheduled Tasks**. - Select **New Rule** - Enter a name for your rule @@ -241,7 +241,7 @@ Azure Functions can also be called by creating rules and scheduled tasks. This - Add an action - From the action dropdown, select **Execute Azure Function** -A list of available Azure Functions that you've registered will be available in the drop-down list. +A list of available Azure Functions that you've registered are available in the drop-down list. ![Configure Rule for Azure Functions](media/azure_function_rules.png) @@ -251,7 +251,7 @@ With Azure functions, you now have the option to debug your CloudScript locally ## Execution limits -CloudScript calls to Azure Functions have timeout limits. If your webhook takes too long to execute, the request will time out in PlayFab. Make sure your code can execute fast enough to stay under the timeout limits. +CloudScript calls to Azure Functions have timeout limits. If your webhook takes too long to execute, the request times out in PlayFab. Make sure your code can execute fast enough to stay under the timeout limits. | Source | Action type | Limit (seconds) | | -------------- | ------------- | --------------: | diff --git a/playfab-docs/live-service-management/service-gateway/automation/cloudscript/making-webhook-calls-from-cloudscript.md b/playfab-docs/live-service-management/service-gateway/automation/cloudscript/making-webhook-calls-from-cloudscript.md index 2b45c7de9..27c1c1e13 100644 --- a/playfab-docs/live-service-management/service-gateway/automation/cloudscript/making-webhook-calls-from-cloudscript.md +++ b/playfab-docs/live-service-management/service-gateway/automation/cloudscript/making-webhook-calls-from-cloudscript.md @@ -22,6 +22,9 @@ This allows titles to make calls to basic informational services, but it *also* This tutorial discusses making Webhook calls from CloudScript, for both *nonsecure* and *secure* scenarios. +> [!NOTE] +> You can refer to the 'PlayFab static IP prefixes and addresses' section of the API Features page in the Developer Portal if you need to allowlist IP addresses used for outbound CloudScript calls. + As a REST call, the structure of a Webhook call from CloudScript is simple. The elements to be specified are: - The URL endpoint. diff --git a/playfab-docs/multiplayer/lobby/join-lobbies.md b/playfab-docs/multiplayer/lobby/join-lobbies.md index 9f5aba747..fdb06af0c 100644 --- a/playfab-docs/multiplayer/lobby/join-lobbies.md +++ b/playfab-docs/multiplayer/lobby/join-lobbies.md @@ -22,7 +22,8 @@ Players can discover connection strings and join lobbies in the following ways. 1. By searching for available lobbies with [FindLobbies](find-lobbies.md) and joining an available lobby 1. By sharing the lobby's connection string via any out-of-band, custom discovery mechanism -> NOTE: Only players (i.e. title_player_account PlayFab entities) can join lobbies as members. Game servers (i.e. game_server PlayFab entities) cannot join lobbies as members. For more information on the how game servers interact with lobbies, see [Game Servers and Lobbies](lobby-server-overview.md). +> [!NOTE] +> Only players (i.e. title_player_account PlayFab entities) can join lobbies as members. Game servers (i.e. game_server PlayFab entities) cannot join lobbies as members. For more information on the how game servers interact with lobbies, see [Game Servers and Lobbies](lobby-server-overview.md). ## Connection strings and Lobby IDs diff --git a/playfab-docs/multiplayer/lobby/lobby-invites.md b/playfab-docs/multiplayer/lobby/lobby-invites.md index 80fa45b20..b98f90312 100644 --- a/playfab-docs/multiplayer/lobby/lobby-invites.md +++ b/playfab-docs/multiplayer/lobby/lobby-invites.md @@ -15,7 +15,8 @@ ms.localizationpriority: medium This article provides an overview of Lobby invites and how to use them in the Lobby and Matchmaking SDK. -> NOTE: Only players (i.e. title_player_account PlayFab entities) can send or receive invites. Game servers (i.e. game_server PlayFab entities) cannot. For more information on the how game servers interact with lobbies, see [Game Servers and Lobbies](lobby-server-overview.md). +> [!NOTE] +> Only players (i.e. title_player_account PlayFab entities) can send or receive invites. Game servers (i.e. game_server PlayFab entities) cannot. For more information on the how game servers interact with lobbies, see [Game Servers and Lobbies](lobby-server-overview.md). ## Invite types @@ -27,6 +28,7 @@ There are two types of invites your game is likely to make use of. ### Joining a lobby by in-game invites * A member of a lobby may invite another player to that lobby directly via the lobby service. +* The lobby owner can choose to restrict sending invites to only the owner via the lobby property __RestrictInvitesToLobbyOwner__ * This invite shares the lobby's connection string with the invited player. * The invited player receives the invitation via __PFLobbyInviteReceivedStateChange__ and can use the attached connection string to join the lobby. * These invites work cross-platform but only work in-game. diff --git a/playfab-docs/multiplayer/lobby/lobby-properties.md b/playfab-docs/multiplayer/lobby/lobby-properties.md index a95c413a5..5fd575953 100644 --- a/playfab-docs/multiplayer/lobby/lobby-properties.md +++ b/playfab-docs/multiplayer/lobby/lobby-properties.md @@ -28,6 +28,7 @@ Each lobby has a set of pre-defined properties commonly needed for most game sce | ownerMigrationPolicy | Policy determines how a new owner will be chosen. To learn more, see [Ownership changes](ownership-changes.md). | | accessPolicy | Policy indicates who can discover the lobby's connection string. This property can only be changed by the owner. | | membershipLock | This value indicates whether new members may join the lobby or not. When __Locked__, new members may not join. When __Unlocked__ new members may join. This property can only be changed by the owner. | +| RestrictInvitesToLobbyOwner | A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner can send invites. When false or not specified, any member can send invites. Defaults to false if not specified. Restricted to client owned lobbies.| ## Custom Properties diff --git a/playfab-docs/multiplayer/lobby/owner-requirements-and-privileges.md b/playfab-docs/multiplayer/lobby/owner-requirements-and-privileges.md index 301e80a53..751d8bfd5 100644 --- a/playfab-docs/multiplayer/lobby/owner-requirements-and-privileges.md +++ b/playfab-docs/multiplayer/lobby/owner-requirements-and-privileges.md @@ -44,6 +44,19 @@ The owner of a lobby has privileges that non-owning members of the lobby don't h * In server-owned lobbies, the owner can only assign another server as the new owner. * In client-owned lobbies, the owner can only assign another member as the new owner. +## Client-owned lobby access from a game_server + +When using a client-owned lobby, you might have the need to securely put data into the lobby from a server. APIs have been added or modified to allow this scenario, so that you can use a 'game_server' entity to join and update the lobby for this purpose. 'ServerData' is similar to 'LobbyData' but it can only be added by a 'game_server' entity. This allows you store important information for other clients to read, such as server connection data, where you can trust the source of the data and even the client lobby owner can't modify it. + +| REST API | C++ SDK | Description | +|-----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|-------------------------------------| +| [JoinLobbyAsServer](../../../../rest/api/playfab/multiplayer/lobby/join-lobby-as-server) | [PFMultiplayerJoinLobbyAsServer](playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerjoinlobbyasserver) | Join a client-owned lobby from a 'game_server'. A lobby owner cannot remove a connected 'game_server', and only one 'game_server' can be joined at a time | +| [UpdateLobbyAsServer](../../../../rest/api/playfab/multiplayer/lobby/update-lobby-as-server) | [PFLobbyServerPostUpdateAsServer](playfabmultiplayerreference-cpp/pflobby/functions/pflobbyserverpostupdateasserver) | Update a lobby's ServerData object from a connected 'game_server' | +| [LeaveLobbyAsServer](../../../../rest/api/playfab/multiplayer/lobby/leave-lobby-as-server) | [PFLobbyServerLeaveServer](playfabmultiplayerreference-cpp/pflobby/functions/pflobbyserverleaveasserver) | Leave a client owned lobby from a 'game_server' gracefully, ServerData contents remain | +| [GetLobby](../../../../rest/api/playfab/multiplayer/lobby/get-lobby) | Not necessary, happens on Join | Get a lobby when a 'game_server' is joined to it | +| [FindLobbies](../../../../rest/api/playfab/multiplayer/lobby/find-lobbies) | [PFMultiplayerFindLobbies](playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfindlobbies) | Find lobbies that the 'game_server' is associated with | + + ## See also * [Lobby properties](lobby-properties.md) diff --git a/playfab-docs/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayererrors.md b/playfab-docs/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayererrors.md index 88accee13..1e2a7982e 100644 --- a/playfab-docs/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayererrors.md +++ b/playfab-docs/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayererrors.md @@ -1,11 +1,11 @@ --- author: ScottMunroMS title: "PlayFab Multiplayer C++ SDK Error Codes" -description: "Error codes used by the PlayFab Multiplayer, Lobby and Matchmaking APIs" +description: "Error codes used by the PlayFab Multiplayer, Lobby, and Matchmaking APIs" ms.author: scmunro ms.topic: reference ms.service: azure-playfab -ms.date: 08/19/2022 +ms.date: 01/23/2026 --- # PlayFab Multiplayer C++ SDK Error Codes @@ -15,110 +15,161 @@ The following error codes are used by the PlayFab Multiplayer, Lobby and Matchma For additional guidance on handling these errors, check out [Handling Lobby and Matchmaking C++ SDK errors](../lobby-and-matchmaking-client-sdk-errors.md) ### Multiplayer + | Hex | Dec | Description | | ------ | ------ | ------ | -| 0x89236400 | -1994169344 | The PlayFabMultiplayer library must be initialized. | -| 0x89236401 | -1994169343 | Only one PlayFabMultiplayer instance can exist at a time. | -| 0x89236402 | -1994169342 | No PlayFab entity token was associated with the provided entity key. Use PFMultiplayerSetEntityToken to associate a PlayFab entity token with a PlayFab entity key before passing that entity key to the API. | -| 0x89236403 | -1994169341 | The provided multiplayer thread ID is invalid/unknown. | -| 0x89236404 | -1994169340 | The provided PlayFab entity key is malformed or otherwise invalid. | -| 0x89236405 | -1994169339 | The Microsoft Game Core XNetworking feature is unavailable | -| 0x89236406 | -1994169338 | The PlayFab Multiplayer library couldn't be initialized because the Game Core Network stack wasn't initialized. Use the Microsoft Game Core XNetworkingGetConnectivityHint API to determine when the network stack is initialized. | -| 0x89236408 | -1994169336 | The operation was canceled due to the title suspending. | -| 0x89236409 | -1994169335 | The PlayFab service returned an unexpected error with a 4XX status code. | -| 0x8923640A | -1994169334 | The PlayFab service returned an unexpected error with a 5XX status code. | -| 0x8923640B | -1994169333 | The Entity ID is invalid. | -| 0x8923640C | -1994169332 | The Entity Type is invalid or unsupported. | -| 0x8923640D | -1994169331 | A request rate limit was exceeded. The request wasn't automatically retried again because retries are disabled or the retry-after period was too long. | +| 0x89236400 | -1994169344 | The PlayFabMultiplayer library must be initialized. | +| 0x89236401 | -1994169343 | Only one PlayFabMultiplayer instance can exist at a time. | +| 0x89236402 | -1994169342 | No PlayFab entity token was associated with the provided entity key. Use PFMultiplayerSetEntityToken to associate a PlayFab entity token with a PlayFab entity key before passing that entity key to the API. | +| 0x89236403 | -1994169341 | The provided multiplayer thread ID is invalid/unknown. | +| 0x89236404 | -1994169340 | The provided PlayFab entity key is malformed or otherwise invalid. | +| 0x89236405 | -1994169339 | The Microsoft Game Core XNetworking feature is unavailable. | +| 0x89236406 | -1994169338 | The PlayFab Multiplayer library couldn't be initialized because the Game Core Network stack wasn't initialized. Use the Microsoft Game Core XNetworkingGetConnectivityHint API to determine when the network stack is initialized. | +| 0x89236408 | -1994169336 | The operation was canceled due to the title suspending. | +| 0x89236409 | -1994169335 | The PlayFab service returned an unexpected error with a 4XX status code. | +| 0x8923640A | -1994169334 | The PlayFab service returned an unexpected error with a 5XX status code. | +| 0x8923640B | -1994169333 | The Entity ID is invalid. | +| 0x8923640C | -1994169332 | The Entity Type is invalid or unsupported. | +| 0x8923640D | -1994169331 | A request rate limit was exceeded. The request wasn't automatically retried again because retries are disabled or the retry-after period was too long. | ### Lobby + | Hex | Dec | Description | | ------ | ------ | ------ | -| 0x89236200 | -1994169856 | Can't create local user; local user limit reached. | -| 0x89236202 | -1994169854 | A user with the provided entity ID already exists. | -| 0x89236203 | -1994169853 | Requested, provided, or configured Lobby owner migration policy is invalid. | -| 0x89236204 | -1994169852 | Requested, provided, or configured Lobby access policy is invalid. | -| 0x89236205 | -1994169851 | Requested object is still pending asynchronous creation. | -| 0x89236206 | -1994169850 | The provided max member count value is outside of the allowed range of values. | -| 0x89236207 | -1994169849 | Provided lobby property count exceeds maximum allowed. | -| 0x89236208 | -1994169848 | Encountered an unexpected error. | -| 0x89236209 | -1994169847 | Failed to parse json data. | -| 0x8923620B | -1994169845 | A parameter or value provided to the PlayFab service was invalid. | -| 0x8923620C | -1994169844 | An unexpected error code was returned by the PlayFab service. | -| 0x8923620D | -1994169843 | The provided entity token has expired. | -| 0x8923620E | -1994169842 | The user isn't authorized to execute the operation. | -| 0x89236212 | -1994169838 | An unknown error code was returned by the PlayFab service. | -| 0x89236213 | -1994169837 | The PlayFab entity token is malformed or otherwise invalid. | -| 0x89236214 | -1994169836 | The specified Lobby entity ID is invalid. | -| 0x89236215 | -1994169835 | The provided property bag contains duplicate property keys. | -| 0x89236216 | -1994169834 | A Lobby request rate limit was exceeded. The request wasn't automatically retried again because retries are disabled or the retry-after period was too long. | -| 0x89236217 | -1994169833 | The owner of the lobby isn't a member of the lobby. | -| 0x8923621A | -1994169830 | The operation couldn't be completed because the entity provided wasn't locally authenticated. Log in the entity first and provide the library a token using SetEntityToken. | -| 0x8923621B | -1994169829 | The provided Lobby state change type is invalid/unknown. | -| 0x8923621C | -1994169828 | The provided Lobby state change result is invalid/unknown. | -| 0x8923621D | -1994169827 | The provided Lobby disconnect reason is invalid/unknown. | -| 0x8923621E | -1994169826 | The PlayFab service returned unexpected 'bad request' error. | -| 0x8923621F | -1994169825 | The provided Lobby thread ID is invalid/unknown. | -| 0x89236220 | -1994169824 | The operation couldn't be completed because the entity provided wasn't a member of the lobby. | -| 0x89236221 | -1994169823 | The PlayFab service returned an invalid/malformed response. | -| 0x89236222 | -1994169822 | Either a lobby update or a member update must be provided. | -| 0x89236223 | -1994169821 | Updates can't be queued after disconnecting from the lobby. | -| 0x89236224 | -1994169820 | The provided lobby join request contained an invalid property deletion. | -| 0x89236225 | -1994169819 | The requested user was already a member of the lobby. | -| 0x89236226 | -1994169818 | The requested lobby doesn't exist. | -| 0x89236227 | -1994169817 | The requested lobby wasn't in a joinable state. | -| 0x89236228 | -1994169816 | The provided Lobby member removed reason is invalid/unknown. | -| 0x89236229 | -1994169815 | The operation couldn't be completed because the acting member wasn't the owner. | -| 0x8923622A | -1994169814 | Lobby member can't self-promote to owner while owner is still connected using current owner migration policy. | -| 0x8923622B | -1994169813 | The arrangement string version isn't supported. | -| 0x8923622C | -1994169812 | An arrangement string for the specified entity key wasn't found in the packed arrangement string. | -| 0x8923622D | -1994169811 | The arrangement string is an invalid format and couldn't be parsed. | -| 0x8923622E | -1994169810 | Requested, provided, or configured Lobby invite listener status is invalid. | -| 0x8923622F | -1994169809 | The invite listener is already set and must be stopped before resetting. | -| 0x89236230 | -1994169808 | The invite listener isn't set and so can't be stopped. | -| 0x89236231 | -1994169807 | Requested, provided, or configured Lobby membership lock is invalid. | -| 0x89236232 | -1994169806 | The member can't rejoin the lobby because they have been banned. | -| 0x89236233 | -1994169805 | The member can't join the lobby because they are already concurrently a member of the maximum number of allowed lobbies. | -| 0x89236234 | -1994169804 | The owner can't promote disconnected member to owner if owner migration policy is Automatic. | -| 0x89236235 | -1994169803 | The connection status is invalid. | +| 0x89236200 | -1994169856 | Can't create local user; local user limit reached. | +| 0x89236202 | -1994169854 | A user with the provided entity ID already exists. | +| 0x89236203 | -1994169853 | Requested, provided, or configured Lobby owner migration policy is invalid. | +| 0x89236204 | -1994169852 | Requested, provided, or configured Lobby access policy is invalid. | +| 0x89236205 | -1994169851 | Requested object is still pending asynchronous creation. | +| 0x89236206 | -1994169850 | The provided max member count value is outside of the allowed range of values. | +| 0x89236207 | -1994169849 | Provided lobby property count exceeds maximum allowed. | +| 0x89236208 | -1994169848 | Encountered an unexpected error. | +| 0x89236209 | -1994169847 | Failed to parse json data. | +| 0x8923620B | -1994169845 | A parameter or value provided to the PlayFab service was invalid. | +| 0x8923620C | -1994169844 | The PlayFab service returned an unexpected error. | +| 0x8923620D | -1994169843 | The provided entity token has expired. | +| 0x8923620E | -1994169842 | The user isn't authorized to execute the operation. | +| 0x89236212 | -1994169838 | The PlayFab Service returned an unknown error. | +| 0x89236213 | -1994169837 | The PlayFab entity token is malformed or otherwise invalid. | +| 0x89236214 | -1994169836 | The specified Lobby entity ID is invalid. | +| 0x89236215 | -1994169835 | The provided property bag contains duplicate property keys. | +| 0x89236216 | -1994169834 | A Lobby request rate limit was exceeded. The request wasn't automatically retried again because retries are disabled or the retry-after period was too long. | +| 0x89236217 | -1994169833 | The owner of the lobby isn't a member of the lobby. | +| 0x8923621A | -1994169830 | The operation couldn't be completed because the entity provided wasn't locally authenticated. Log in the entity first, and provide the library a token using SetEntityToken. | +| 0x8923621B | -1994169829 | The provided Lobby state change type is invalid/unknown. | +| 0x8923621C | -1994169828 | The provided Lobby state change result is invalid/unknown. | +| 0x8923621D | -1994169827 | The provided Lobby disconnect reason is invalid/unknown. | +| 0x8923621E | -1994169826 | The PlayFab service returned unexpected 'bad request' error. | +| 0x8923621F | -1994169825 | The provided Lobby thread ID is invalid/unknown. | +| 0x89236220 | -1994169824 | The operation couldn't be completed because the entity provided wasn't a member of the lobby. | +| 0x89236221 | -1994169823 | The PlayFab service returned an invalid/malformed response. | +| 0x89236222 | -1994169822 | Either a lobby update or a member update must be provided. | +| 0x89236223 | -1994169821 | Updates can't be queued after disconnecting from the lobby. | +| 0x89236224 | -1994169820 | The provided lobby join request contained an invalid property deletion. | +| 0x89236225 | -1994169819 | The requested user was already a member of the lobby. | +| 0x89236226 | -1994169818 | The requested lobby doesn't exist. | +| 0x89236227 | -1994169817 | The requested lobby wasn't in a joinable state. | +| 0x89236228 | -1994169816 | The provided Lobby member removed reason is invalid/unknown. | +| 0x89236229 | -1994169815 | The operation couldn't be completed because the acting member wasn't the owner. | +| 0x8923622A | -1994169814 | Lobby member can't self-promote to owner while owner is still connected using current owner migration policy. | +| 0x8923622B | -1994169813 | The arrangement string version isn't supported. | +| 0x8923622C | -1994169812 | An arrangement string for the specified entity key wasn't found in the packed arrangement string. | +| 0x8923622D | -1994169811 | The arrangement string is an invalid format and couldn't be parsed. | +| 0x8923622E | -1994169810 | Requested, provided, or configured Lobby invite listener status is invalid. | +| 0x8923622F | -1994169809 | The invite listener is already set and must be stopped before resetting. | +| 0x89236230 | -1994169808 | The invite listener isn't set and so can't be stopped. | +| 0x89236231 | -1994169807 | Requested, provided, or configured Lobby membership lock is invalid. | +| 0x89236232 | -1994169806 | The member can't rejoin the lobby because they have been banned. | +| 0x89236233 | -1994169805 | The member can't join the lobby because they are already concurrently a member of the maximum number of allowed lobbies. | +| 0x89236234 | -1994169804 | The owner can't promote disconnected member to owner if owner migration policy is Automatic. | +| 0x89236235 | -1994169803 | The connection status is invalid. | +| 0x89236236 | -1994169802 | Operation can only be performed by the lobby's server-owner. | +| 0x89236237 | -1994169801 | The specified calling server hasn't joined the lobby. The lobby has a different server joined. | +| 0x89236238 | -1994169800 | The lobby doesn't have a joined server. | +| 0x89236239 | -1994169799 | The lobby already has a joined server. | +| 0x8923623A | -1994169798 | The server has already joined the lobby. | +| 0x8923623B | -1994169797 | The server can't join a lobby which isn't client-owned. | +| 0x8923623C | -1994169796 | The server can't join a lobby which doesn't use connections. | +| 0x8923623D | -1994169795 | Operation can only be performed by the non-owning server associated with the lobby. | +| 0x8923623E | -1994169794 | The connection status is invalid. | ### Matchmaking + +| Hex | Dec | Description | +| ------ | ------ | ------ | +| 0x89236300 | -1994169600 | The provided matchmaking ticket status is invalid/unknown. | +| 0x89236301 | -1994169599 | The provided matchmaking ticket result is invalid/unknown. | +| 0x89236302 | -1994169598 | The provided matchmaking ticket cancel reason is invalid/unknown. | +| 0x89236303 | -1994169597 | The provided matchmaking state change type is invalid/unknown. | +| 0x89236304 | -1994169596 | The ticket was canceled due to a cancelation request. | +| 0x89236305 | -1994169595 | The ticket was canceled due to a service error. | +| 0x89236306 | -1994169594 | The ticket was canceled because the timeout elapsed before a match could be found. | +| 0x89236307 | -1994169593 | The ticket was canceled for an unknown reason. | +| 0x89236308 | -1994169592 | Duplicate users aren't allowed in the ticket parameters. | +| 0x89236309 | -1994169591 | At least one local user must be specified in the ticket parameters. | +| 0x8923630A | -1994169590 | There were too many users in the ticket for the queue. | +| 0x8923630B | -1994169589 | The ticket is already completed. | +| 0x8923630C | -1994169588 | Encountered an unrecoverable failure when attempting to cancel the ticket. | +| 0x8923630D | -1994169587 | One of the users is a member of too many tickets. | +| 0x8923630F | -1994169585 | A matchmaking request rate limit was exceeded. The request wasn't automatically retried again because retries are disabled or the retry-after period was too long. | +| 0x89236310 | -1994169584 | The timeout elapsed without the service completing the ticket. | +| 0x89236311 | -1994169583 | The calling entity is invalid. | +| 0x89236312 | -1994169582 | One of the users in the ticket has invalid attributes. | +| 0x89236313 | -1994169581 | The queue wasn't found. | +| 0x89236314 | -1994169580 | The match wasn't found. | +| 0x89236315 | -1994169579 | The ticket wasn't found. | +| 0x89236316 | -1994169578 | The user already joined the ticket. | +| 0x89236317 | -1994169577 | The queue config is invalid. | +| 0x89236318 | -1994169576 | One of the users in the ticket has an invalid entity profile. | +| 0x89236319 | -1994169575 | Matchmaking isn't enabled for this title. | +| 0x8923631A | -1994169574 | One of the users in the ticket has attributes that are too large. | +| 0x8923631B | -1994169573 | One of the ticket attributes is invalid. | +| 0x8923631C | -1994169572 | The user hasn't joined the ticket. | +| 0x8923631D | -1994169571 | The number of queues has exceeded the limit for this title. | +| 0x8923631E | -1994169570 | The API called doesn't match the type of ticket requested. | +| 0x8923631F | -1994169569 | The request was malformed. | +| 0x89236320 | -1994169568 | Match details can only be provided when the ticket is in the matched state. | +| 0x89236321 | -1994169567 | The provided multiplayer protocol type is invalid. | +| 0x89236322 | -1994169566 | The ticket was canceled by the service. | + +### PubSub + | Hex | Dec | Description | | ------ | ------ | ------ | -| 0x89236300 | -1994169600 | The provided matchmaking ticket status is invalid/unknown. | -| 0x89236301 | -1994169599 | The provided matchmaking ticket result is invalid/unknown. | -| 0x89236302 | -1994169598 | The provided matchmaking ticket cancel reason is invalid/unknown. | -| 0x89236303 | -1994169597 | The provided matchmaking state change type is invalid/unknown. | -| 0x89236304 | -1994169596 | The ticket was canceled due to a cancelation request. | -| 0x89236305 | -1994169595 | The ticket was canceled due to a service error. | -| 0x89236306 | -1994169594 | The ticket was canceled because the timeout elapsed before a match could be found. | -| 0x89236307 | -1994169593 | The ticket was canceled for an unknown reason. | -| 0x89236308 | -1994169592 | Duplicate users aren't allowed in the ticket parameters. | -| 0x89236309 | -1994169591 | At least one local user must be specified in the ticket parameters. | -| 0x8923630A | -1994169590 | There were too many users in the ticket for the queue. | -| 0x8923630B | -1994169589 | The ticket is already completed. | -| 0x8923630C | -1994169588 | Encountered an unrecoverable failure when attempting to cancel the ticket. | -| 0x8923630D | -1994169587 | One of the users is a member of too many tickets. | -| 0x8923630F | -1994169585 | A matchmaking request rate limit was exceeded. The request wasn't automatically retried again because retries are disabled or the retry-after period was too long. | -| 0x89236310 | -1994169584 | The timeout elapsed without the service completing the ticket. | -| 0x89236311 | -1994169583 | The calling entity is invalid. | -| 0x89236312 | -1994169582 | One of the users in the ticket has invalid attributes. | -| 0x89236313 | -1994169581 | The queue wasn't found. | -| 0x89236314 | -1994169580 | The match wasn't found. | -| 0x89236315 | -1994169579 | The ticket wasn't found. | -| 0x89236316 | -1994169578 | The user already joined the ticket. | -| 0x89236317 | -1994169577 | The queue config is invalid. | -| 0x89236318 | -1994169576 | One of the users in the ticket has an invalid entity profile. | -| 0x89236319 | -1994169575 | Matchmaking isn't enabled for this title. | -| 0x8923631A | -1994169574 | One of the users in the ticket has attributes that are too large. | -| 0x8923631B | -1994169573 | One of the ticket attributes is invalid. | -| 0x8923631C | -1994169572 | The user hasn't joined the ticket. | -| 0x8923631D | -1994169571 | The number of queues has exceeded the limit for this title. | -| 0x8923631E | -1994169570 | The API called doesn't match the type of ticket requested. | -| 0x8923631F | -1994169569 | The request was malformed. | -| 0x89236320 | -1994169568 | Match details can only be provided when the ticket is in the matched state. | -| 0x89236321 | -1994169567 | The provided multiplayer protocol type is invalid. | -| 0x89236322 | -1994169566 | The ticket was canceled by the service. | +| 0x89236600 | -1994168832 | The PubSub library must be initialized. | +| 0x89236601 | -1994168831 | Only one PubSubManager instance can exist at a time. | +| 0x09236602 | 153314818 | The requested operation failed because the PubSub API is still in use. | +| 0x89236603 | -1994168829 | The specified PubSub entity ID is invalid. | +| 0x89236604 | -1994168828 | The requested operation failed because the PubSub entity is still in use. | +| 0x89236605 | -1994168827 | Encountered an exception while parsing and adding the PubSub connection ID to a PlayFab message body. | +| 0x89236606 | -1994168826 | Failed to parse json data. | +| 0x89236607 | -1994168825 | The PubSub library is already unsubscribed from the provided PubSub subscription. | +| 0x89236608 | -1994168824 | Failed to create a PubSub connection string. | +| 0x89236609 | -1994168823 | The PubSub service encountered an error while creating or maintaining the connection. | +| 0x8923660A | -1994168822 | Encountered an exception while parsing connection identifier. | +| 0x8923660B | -1994168821 | The requested entity wasn't found. | +| 0x8923660C | -1994168820 | The provided connection exists but is in an invalid/unknown state. | +| 0x8923660D | -1994168819 | Encountered an unexpected exception when attempting to establish PubSub connection. | +| 0x8923660E | -1994168818 | Encountered an unexpected exception when parsing a subscription event. | +| 0x8923660F | -1994168817 | Encountered an unexpected exception when parsing a subscription notification payload. | +| 0x89236610 | -1994168816 | Attempted to establish a PubSub subscription without any available PubSub connections. | +| 0x89236611 | -1994168815 | The PubSub service declined the attempt to subscribe to the specified resource. | +| 0x89236612 | -1994168814 | Failed to end the PubSub session while attempting to disconnect. | +| 0x89236613 | -1994168813 | The Microsoft Game Core XNetworking feature is unavailable. | +| 0x89236614 | -1994168812 | The PubSub library couldn't be initialized because the Game Core Network stack wasn't initialized. Use the Microsoft Game Core XNetworkingGetConnectivityHint API to determine when the network stack is initialized. | +| 0x89236616 | -1994168810 | Unable to set up signalr websocket connection. | +| 0x89236617 | -1994168809 | The PubSub library has hit its max websocket connections limit. | +| 0x89236618 | -1994168808 | The PubSub connection has hit its max entity limit. | +| 0x89236619 | -1994168807 | The PubSub service doesn't recognize the entity type. | +| 0x8923661A | -1994168806 | The PubSub service doesn't recognize the request type. | +| 0x8923661B | -1994168805 | The PubSub service was unavailable via SignalR. | +| 0x8923661C | -1994168804 | The PubSub service returned an unexpected response. | +| 0x8923661D | -1994168803 | The PubSub service is throttling the client over signalr due to exceeding the rate limit. | +| 0x8923661E | -1994168802 | The PlayFab service returned an unexpected error with a 4XX status code. | +| 0x8923661F | -1994168801 | The PlayFab service returned an unexpected error with a 5XX status code. | +| 0x89236620 | -1994168800 | The PubSub service failed to deliver a subscription confirmation within a reasonable timeout. | +| 0x89236621 | -1994168799 | The PubSub service failed due to lack of authentication credentials to a specific resource. | +| 0x89236622 | -1994168798 | Failed to access PubSub services; check credentials. | ## Global HRESULT error codes diff --git a/playfab-docs/multiplayer/matchmaking/config-queues.md b/playfab-docs/multiplayer/matchmaking/config-queues.md index 3dc88c658..1d71c9192 100644 --- a/playfab-docs/multiplayer/matchmaking/config-queues.md +++ b/playfab-docs/multiplayer/matchmaking/config-queues.md @@ -65,7 +65,7 @@ The elements below are often used by all rules. + **Attribute Source** - Rules often act upon information that is provided to them. This field describes two options for the source of this information: 1. **User** - Attributes are submitted alongside players in the create or join ticket request. - 2. **Player Entity** - Attributes are retrieved from the player's associated Player Entity. These can be set via the [SetObjects API](xref:titleid.playfabapi.com.data.object.setobjects) + 2. **Player Entity** - Attributes are retrieved from the player's associated Player Entity. These can be set via the [SetObjects API](xref:titleid.playfabapi.com.data.object.setobjects). DO NOT use this source when using external entity types. + **Attribute Path** - The path to reach the attribute. When using a User Attribute Source, it is simply the name of the attribute. When using a Player Entity Attribute Source, it is a [JSONPath](https://github.com/json-path/JsonPath) that retrieves a particular item from the entity, such as `$.playerSkill.Mean`. + **Behavior when attribute is not specified** - If a rule requires an attribute, but none is specified, the rule may be configured with one of two behaviors: diff --git a/playfab-docs/multiplayer/networking/party-unreal-engine-oss-overview.md b/playfab-docs/multiplayer/networking/party-unreal-engine-oss-overview.md index 31fb0880f..1cbab8d83 100644 --- a/playfab-docs/multiplayer/networking/party-unreal-engine-oss-overview.md +++ b/playfab-docs/multiplayer/networking/party-unreal-engine-oss-overview.md @@ -52,10 +52,11 @@ PlayFab OSS works alongside the PlayFab SDK marketplace plugin, which provides o | 5.3 | Supported* | Supported* | Supported* | Supported* | Supported* | Supported* | | 5.4 | Supported* | Supported* | Supported* | Supported* | Supported* | Supported* | | 5.5 | Supported* | Supported* | Supported* | Supported* | Supported* | Supported* | -| 5.6 | Supported | Supported | Supported | Supported | Supported | Supported | +| 5.6 | Supported* | Supported* | Supported* | Supported* | Supported* | Supported* | +| 5.7 | Supported | Supported | Supported | Supported | Supported | Supported | -*For users on previous versions of Unreal Engine (UE4.27, 5.0, 5.1, 5.2, 5.3, and 5.4) who wish to use PlayFab Online Subsystem, here are two options: -- Upgrade your local Unreal Engine version to 5.6. +*For users on previous versions of Unreal Engine (UE4.27, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5 and 5.6) who wish to use PlayFab Online Subsystem, here are two options: +- Upgrade your local Unreal Engine version to 5.7. - Pull the latest release and backport it to your game. For UE4, 4.27 is the recommended version since crossplay between different platforms doesn't work on 4.26, but it does on 4.27. If you're on an earlier version of Unreal Engine 4, the OSS can be backported with minimal work. See [Using older versions of Unreal Engine 4](party-unreal-engine-using-older-versions.md) for more details. @@ -81,7 +82,7 @@ The supported Nintendo Switch SDK versions can be found at [Switch SDK Updates P - UE5.0: \Engine\Platforms\Switch\Source\Programs\UnrealBuildTool\SwitchPlatformSDK.cs - UE5.1, UE5.2 and UE5.3: \Engine\Platforms\Switch\Source\Programs\UnrealBuildTool\SwitchPlatformSDK.Versions.cs - UE5.4: \Engine\Platforms\Switch\Config\Switch_SDK.json -- UE5.5 and UE5.6: \Engine\Platforms\Nintendo\Config\Nintendo_SDK.json +- UE5.5, UE5.6 and UE5.7: \Engine\Platforms\Nintendo\Config\Nintendo_SDK.json ## Which version of the PS5™ and PS4™ SDKs are supported? @@ -89,7 +90,7 @@ The supported Sony PlayStation SDK versions can be found at [PS4 SDK Compatibili - UE4: \Engine\Platforms\[PS4|PS5]\Source\Programs\UnrealBuildTool\UEBuild[PS4|PS5].cs - UE5.0: \Engine\Platforms\[PS4|PS5]\Source\Programs\UnrealBuildTool\[PS4|PS5]PlatformSDK.cs - UE5.1, UE5.2 and UE5.3: \Engine\Platforms\[PS4|PS5]\Source\Programs\UnrealBuildTool\[PS4|PS5]PlatformSDK.Versions.cs -- UE5.4, UE5.5 and UE5.6: \Engine\Platforms\[PS4|PS5]\Config\[PS4|PS5]_SDK.json +- UE5.4, UE5.5, UE5.6 and UE5.7: \Engine\Platforms\[PS4|PS5]\Config\[PS4|PS5]_SDK.json >[!NOTE] > In order to access Unreal’s documentation and UDN forum links above, you must be a registered Unreal Developer and tented for the specific platform. diff --git a/playfab-docs/multiplayer/networking/party-unreal-engine-oss-quickstart.md b/playfab-docs/multiplayer/networking/party-unreal-engine-oss-quickstart.md index 4f491b96b..1776e3198 100644 --- a/playfab-docs/multiplayer/networking/party-unreal-engine-oss-quickstart.md +++ b/playfab-docs/multiplayer/networking/party-unreal-engine-oss-quickstart.md @@ -232,7 +232,7 @@ Ways to help you troubleshoot issues. Users might face issues when trying to create an Unreal Engine Installed Build with the OnlineSubsystemPlayFab on GDK build flavors. We provide the following guidance to successfully overcome this issue until there's a more complete solution. -**If you're using Unreal Engine 5.4, 5.5 or 5.6:** +**If you're using Unreal Engine 5.4, 5.5, 5.6 or 5.7:** * You might encounter the following runtime error: `Runtime dependency Party.dll is configured to be staged from C:\Program Files (x86)\Microsoft GDK\\Party.dll and Engine\Plugins\Online\OnlineSubsystemPlayFab\Platforms\GDK\Redist\Party.dll` * Navigate to Engine\Platforms\GDK\Plugins\Online\OnlineSubsystemGDK\ diff --git a/playfab-docs/multiplayer/networking/reference/partyerrors.md b/playfab-docs/multiplayer/networking/reference/partyerrors.md index 55351e44a..400a2a3cd 100644 --- a/playfab-docs/multiplayer/networking/reference/partyerrors.md +++ b/playfab-docs/multiplayer/networking/reference/partyerrors.md @@ -5,7 +5,7 @@ description: Error codes used by PlayFab Party APIs ms.author: scmunro ms.topic: reference ms.service: azure-playfab -ms.date: 08/11/2022 +ms.date: 01/25/2026 --- # PlayFab Party Error Codes @@ -153,8 +153,6 @@ The following error codes are used by the PlayFab Party APIs: | 0x1058 | 4184 | The provided target chat control list contained at least one duplicate chat control. | | 0x1059 | 4185 | The provided target endpoint list contained at least one duplicate endpoint. | | 0x105A | 4186 | A platform error resulted in failure to determine the preferred UI language. | -| 0x105B | 4187 | XAudio 2.7 debug version not installed on system (install the DirectX SDK Developer Runtime). | -| 0x105C | 4188 | XAudio 2.7 not installed on system (install the DirectX End-user Runtimes (June 2010)). | | 0x105E | 4190 | Authentication was attempted for a user that is already authenticated. | | 0x1062 | 4194 | The text-to-speech synthesis request was rejected by the service for being too large. | | 0x1063 | 4195 | The text-to-speech synthesis request was throttled. | @@ -264,6 +262,7 @@ The following error codes are used by the PlayFab Party APIs: | 0x112C | 4396 | The region quality measurement minimum required successful responses value is invalid. | | 0x112D | 4397 | The region quality measurement ideal number of successful responses value is invalid. | | 0x1136 | 4406 | The network is being destroyed because it is idle. | +| 0x113C | 4412 | The user default platform audio device monitor is uninitialized; it may have failed or be unsupported on this platform. | ## Platform-specific errors | Hex | Dec | Description | @@ -293,7 +292,6 @@ The following error codes are used by the PlayFab Party APIs: | 0x301C | 12316 | A user matching the ID wasn't found in the Microsoft gaming runtime. | | 0x301D | 12317 | There isn't a default user for the Microsoft gaming runtime. | | 0x301E | 12318 | The Microsoft gaming runtime failed to resolve a required user privilege. | -| 0x301F | 12319 | The Microsoft gaming XNetworking feature is unavailable. | | 0x3020 | 12320 | The network stack must be initialized before calling PartyManager::Initialize(); use the Microsoft Game Core XNetworkingGetConnectivityHint API to determine when the network stack is initialized. | | 0x3021 | 12321 | Callers must pass a port value of 0 when the PartyLocalUdpSocketBindAddressOptions::ExcludeGameCorePreferredUdpMultiplayerPort option is set. | | 0x3022 | 12322 | It's invalid to pass PartyLocalUdpSocketBindAddressOptions::ExcludeGameCorePreferredUdpMultiplayerPort in all versions of PlayFab Party except for the Microsoft Game Core version. | diff --git a/playfab-docs/multiplayer/networking/release-notes.md b/playfab-docs/multiplayer/networking/release-notes.md index bb4ea91ce..f18730d59 100644 --- a/playfab-docs/multiplayer/networking/release-notes.md +++ b/playfab-docs/multiplayer/networking/release-notes.md @@ -14,12 +14,42 @@ ms.localizationpriority: medium > [!NOTE] > Support for the XDK and Windows 7 platforms ended on August 1, 2023. No new PlayFab Party library updates will be released for those platforms. The PlayFab Party networking and voice services will continue to operate with no impact to any titles currently using Windows 7 or XDK versions of the PlayFab Party library. -> ->For more information, please see our [forum post](https://community.playfab.com/articles/141546/playfab-party-ending-support-for-the-xdk-and-windo.html). > [!NOTE] > Support for 32-bit Android platforms (arm7 and x86) ended on October 19th, 2023. No new PlayFab Party library updates will be released for those platforms. The PlayFab Party networking and voice services will continue to operate with no impact to any titles currently using the PlayFab Party library on 32-bit Android platforms. +## 1.10.16 + +February 2, 2026 + +- GDK: Added support for environments that use in-proc GRTS. +- GDK: Added support for [`PartyAudioDeviceSelectionType::SystemDefault`](reference/enums/partyaudiodeviceselectiontype.md). + +### Bug fixes + +- Fixed possible crash in multinetwork transition scenarios. + +## 1.10.15 + +December 17, 2025 + +- Nintendo Switch 2: Added 10 second timeout for webrequests. + +## 1.10.14 + +December 9, 2025 + +- Changed the [`PartyNetwork::CreateEndpoint`](reference/classes/PartyNetwork/methods/partynetwork_createendpoint.md) PartyStatusChangeResult behavior to return `PartyServiceError` for transient errors that occur before the token expires, and to return `UserNotAuthorized` only when the token has actually expired. +- Android: Added support for 16 KB page sizes to satisfy the new [Android page size requirements](https://developer.android.com/guide/practices/page-sizes). + + +## 1.10.13 + +October 14, 2025 + +- Fixed an issue that caused the microphone to not function properly on iOS 26. +- Apple: Added support for Arm64 .xcframework on iOS. + ## 1.10.12 October 6, 2025 diff --git a/playfab-docs/multiplayer/networking/unreal-release-notes.md b/playfab-docs/multiplayer/networking/unreal-release-notes.md index 04d16dc12..3e5c86045 100644 --- a/playfab-docs/multiplayer/networking/unreal-release-notes.md +++ b/playfab-docs/multiplayer/networking/unreal-release-notes.md @@ -14,20 +14,31 @@ ms.localizationpriority: medium Refer to [QuickStart: PlayFab Online Subsystem (OSS)](party-unreal-engine-oss-quickstart.md) for download and install instructions. -## 2.3.7 -**Release 2.3.7 is ready to use with Unreal Engine 5.6.** +## 2.3.8 +**Release 2.3.8 is ready to use with Unreal Engine 5.7.** + +UE5.7 Upgrade Fixes: + +* Removed the unused `SEARCH_PRESENCE` key from the lobby search key mapping and related query filter logic, simplifying lobby search parameter handling. +* Removed dead code related to session search on Win64, as the new join logic no longer relies on this path. + +Bug fixes: -**Library Updates:** +* Added a new `CleanupFailedJoinSession` method to `FOnlineSessionPlayFab` to ensure proper cleanup of PlayFab and Party sessions, removal of local session references, and delegate notification when a native session join fails. This method is now called in all relevant failure paths. -Multiplayer SDK C++ library (Windows/GDK) : From 1.7.9 to 1.8.0. +* Changed logic to cache the desired session (`CachedDesiredSession`) instead of searching for it on every join, simplifying and improving the reliability of native session joins. -Party SDK C++ library (Windows/GDK) : From 1.10.5 to 1.10.12. +## 2.3.7 +**Release 2.3.7 is ready to use with Unreal Engine 5.6.** + +Library Updates: -**UE5.6 Upgrade Fixes:** +- Multiplayer SDK C++ library (Windows/GDK) : From 1.7.9 to 1.8.0. +- Party SDK C++ library (Windows/GDK) : From 1.10.5 to 1.10.12. -### Plugin Configuration Updates +UE5.6 Upgrade Fixes: -* Updated `OnlineSubsystemPlayFab.uplugin` to use `PlatformAllowList` instead of `WhitelistPlatforms`, and renamed `OnlineSubsystemSwitch` to `OnlineSubsystemNintendo` for consistency. Also incremented the plugin version. [[1]](diffhunk://#diff-5e89106b2fe67da11c76d335b2c0f6c597035a66aa80dc7021dfc24cb8ef24cfL4-R5) [[2]](diffhunk://#diff-5e89106b2fe67da11c76d335b2c0f6c597035a66aa80dc7021dfc24cb8ef24cfL27-R27) [[3]](diffhunk://#diff-5e89106b2fe67da11c76d335b2c0f6c597035a66aa80dc7021dfc24cb8ef24cfL57-R87) +* Updated `OnlineSubsystemPlayFab.uplugin` to use `PlatformAllowList` instead of `WhitelistPlatforms`, and renamed `OnlineSubsystemSwitch` to `OnlineSubsystemNintendo` for consistency. Also incremented the plugin version. * On UE 5.6 and later the `DriverClassName` parameter requires the "/Script/" prefix. For example, use `"/Script/OnlineSubsystemPlayFab.PlayFabNetDriver"` instead of `"OnlineSubsystemPlayFab.PlayFabNetDriver"`. Example usage: ``` diff --git a/playfab-docs/multiplayer/networking/xblreference/partyxblerrors.md b/playfab-docs/multiplayer/networking/xblreference/partyxblerrors.md index 02212f651..958f9c251 100644 --- a/playfab-docs/multiplayer/networking/xblreference/partyxblerrors.md +++ b/playfab-docs/multiplayer/networking/xblreference/partyxblerrors.md @@ -5,13 +5,13 @@ description: List of error codes used by the PlayFab Party's Xbox Live Helper Li ms.author: scmunro ms.topic: reference ms.service: azure-playfab -ms.date: 08/11/2022 +ms.date: 01/25/2026 --- # PlayFab Party Xbox Live Helper Library Error Codes The following error codes are used by the PlayFab Party Xbox Live Helper Library: -## Xbox Live Helper Library Errors +## Xbox Live Helper Library errors | Hex | Dec | Description | | --- | --- | ----------- | | 0x5000 | 20480 | Only one instance of PartyXblManager can exist at a time. | @@ -30,4 +30,4 @@ The following error codes are used by the PlayFab Party Xbox Live Helper Library | 0x500F | 20495 | The specified correlation ID didn't match any outstanding requests. | | 0x5014 | 20500 | Setting profiling callbacks after PartyXblManager initialization is forbidden. | | 0x5015 | 20501 | The request failed because the Xbox Live token was invalid. | -| 0x5016 | 20502 | The request failed because the Xbox Live token was expired. | \ No newline at end of file +| 0x5016 | 20502 | The request failed because the Xbox Live token was expired. | diff --git a/playfab-docs/player-progression/game-saves/conflicts.md b/playfab-docs/player-progression/game-saves/conflicts.md index 327424dcc..f152d206d 100644 --- a/playfab-docs/player-progression/game-saves/conflicts.md +++ b/playfab-docs/player-progression/game-saves/conflicts.md @@ -3,32 +3,204 @@ title: Game Saves conflicts author: jasonsandlin description: Game Saves conflicts ms.author: jasonsa -ms.date: 07/01/2025 +ms.date: 01/06/2026 ms.topic: article ms.service: azure-playfab keywords: playfab, game saves ms.localizationpriority: medium --- -## Game Saves conflicts +# Game Saves Conflicts and Atomic Units -Save conflicts occur when the same game data has been modified on multiple devices, and the system needs to determine which version to keep. +## Overview + +Save conflicts occur when the same game data has been modified on multiple devices, and the system needs to determine which version to keep. Understanding how conflicts are detected and resolved is crucial for game developers designing their save data structure. + +## When Conflicts Happen + +Conflicts only occur during the sync operation (`PFGameSaveFilesAddUserWithUiAsync`) when **all** of the following conditions are true: -### When Conflicts Happen -Conflicts only occur during the sync operation (`PFGameSaveFilesAddUserWithUiAsync`) when **both** conditions are true: 1. **Local changes exist**: Files have been modified locally since the last sync 2. **Cloud changes exist**: Another device has uploaded newer data since the last sync +3. **Same atomic unit**: Both changes are in the same root-level folder + +### Conflict Detection Matrix + +| Local Device Changes | Cloud Has Changes in Same Atomic Unit | Result | +|---------------------|--------------------------------------|--------| +| Modified files | Yes | **CONFLICT** | +| Deleted files | Yes | **CONFLICT** | +| No changes | Yes | Download proceeds | +| Modified files | No | Upload proceeds | +| Deleted files | No | Delete proceeds | + +## What is an Atomic Unit? + +Some file sync systems treat conflicts on a file-by-file basis – if the same file needs to be uploaded and also needs to be downloaded, then there's a conflict. In Game Saves, each root-level subfolder is instead treated as an **atomic unit**. + +> **Each root-level subfolder is treated as one atomic unit.** + +If there are any files or subfolders inside a root-level subfolder that need to be downloaded **and** any files or folders in that same root subfolder that need to be uploaded, then the entire atomic unit is in conflict. + +This approach allows you to: +- **Maintain data integrity**: Interdependent files stay consistent together +- **Provide isolation**: Independent data in separate folders can sync without conflicts +- **Minimize conflicts**: Changes to different atomic units on different devices merge automatically + +### Example Save Structure + +``` +SaveRoot/ +├── save.dat ← Atomic unit: root +├── player.dat ← Atomic unit: root +├── Save1/ +│ ├── stats.json ← Atomic unit: Save1 +│ └── inventory.json ← Atomic unit: Save1 +├── Save2/ +│ ├── stats.json ← Atomic unit: Save2 +│ └── inventory.json ← Atomic unit: Save2 +└── WorldState/ + ├── map.dat ← Atomic unit: WorldState + └── npcs/ + └── positions.dat ← Atomic unit: WorldState +``` + +### Conflict Scenarios + +| Device A Changes | Device B Changes | Conflict? | Why | +|-----------------|------------------|-----------|-----| +| `Save1/stats.json` | `Save1/inventory.json` | **YES** | Same atomic unit: Save1 | +| `Save1/stats.json` | `Save2/stats.json` | No | Different units: Save1 vs Save2 | +| `WorldState/map.dat` | `WorldState/npcs/positions.dat` | **YES** | Same atomic unit: WorldState | +| `save.dat` | `Save1/stats.json` | No | Different units: root vs Save1 | +| `player.dat` | `save.dat` | **YES** | Same atomic unit: root | + +## Root-Level Files: Special Case + +**All files at the save root share ONE atomic unit.** + +Files placed directly in the save root (not in any subfolder) are all grouped together as a single atomic unit. If you modify one root-level file locally and another device modifies a different root-level file, this will trigger a conflict. + +| Device A (local) | Device B (cloud) | Same Atomic Unit? | Result | +|-----------------|------------------|-------------------|--------| +| Modifies `rootfile1.txt` | Modifies `rootfile2.txt` | ✅ YES | **CONFLICT** | +| Modifies `rootfile1.txt` | Modifies `save1/config.ini` | ❌ NO | No conflict, both sync | +| Deletes `save.dat` | Modifies `progress.dat` | ✅ YES | **CONFLICT** | + +## User Choice Options -### Conflict Resolution Approach -Some file sync systems treat conflicts on a file-by-file basis – if the same file needs to be uploaded and also needs to be downloaded, then there's a conflict. In Game Saves, each root level subfolder is instead treated as an atomic unit. If there are any files or subfolders inside a root level subfolder that need to be downloaded and any files or folders in that same root subfolder that need to be uploaded, then the entire atomic unit is in conflict. This approach allows you to organize save data so that interdependent data integrity is maintained, while providing isolation between root subfolders for independent data that can be safely merged with changes to other atomic units. By using top level subfolders to structure your game save layout, you can minimize the likelihood of creating a conflict when changes to different atomic units happen on different devices. A slot-based game save system where each slot is a root level subfolder is a very simple example of how these atomic units can be used. -### User Choice Options When conflicts occur, players choose between: -- **Use Local Data**: Keep the device's current save data (overwrites cloud data on next upload) -- **Use Cloud Data**: Download and use the cloud save data (overwrites local data) -A conflict resolution decision applies to all atomic units that are in conflict at the time of sync. If the player chooses cloud, all the conflicting atomic units will be downloaded, and conversely, choosing local leads to all being uploaded. +- **Use Local Data (Keep Local)**: Keep the device's current save data +- **Use Cloud Data (Keep Cloud)**: Download and use the cloud save data + +### Critical: Resolution is All-or-Nothing + +> ⚠️ **Important**: While atomic units determine *when* a conflict is detected, the user's conflict resolution choice applies to the **entire save**, not per-atomic-unit. + +### Example: Mixed Conflict Scenario + +``` +SaveRoot/ +├── SlotA/ ← Local: modified, Cloud: modified → CONFLICT +├── SlotB/ ← Local: modified, Cloud: unchanged → Local-only change +├── SlotC/ ← Local: unchanged, Cloud: modified → Cloud-only change +└── SlotD/ ← Local: modified, Cloud: unchanged → Local-only change +``` + +**User sees conflict prompt** (due to SlotA). + +| User Choice | SlotA | SlotB | SlotC | SlotD | +|-------------|-------|-------|----------|--------------| +| **Keep Local** | ✅ Local kept | ✅ Local uploaded | ❌ Cloud change **LOST** | ✅ Local uploaded | +| **Keep Cloud** | ✅ Cloud downloaded | ❌ Local change **overwritten** | ✅ Cloud downloaded | ❌ Local change **overwritten** | + +### Why This Matters + +1. **Keep Local loses cloud-only changes**: If you choose "Keep Local" because of a conflict in SlotA, you will NOT receive the cloud update to SlotC that another device made. + +2. **Keep Cloud loses local-only changes**: If you choose "Keep Cloud", your local changes to SlotB and SlotD are overwritten by the cloud state. + +3. **Rollback available**: Both choices preserve the discarded branch for future rollback capability. + +### Design Summary + +| Aspect | Granularity | +|--------|-------------| +| Conflict **detection** | Per atomic unit (root subfolder) | +| Conflict **resolution** | Entire save (all-or-nothing) | + +This all-or-nothing approach simplifies the player experience. While per-atomic-unit resolution would technically maintain data consistency (since atomic units define consistency boundaries), it would create user experience challenges: + +- Players would need to understand the concept of atomic units and folder boundaries +- Mixed results (some folders from local, others from cloud) could leave players confused about the final state +- Prompting for each conflicting atomic unit separately would make conflict resolution overwhelming + +By presenting a single "Keep Local" vs "Keep Cloud" choice, players make one clear decision without needing to understand the underlying save structure. + +## When Conflicts Do NOT Occur + +### Delete on Both Sides + +If both devices delete the same file (or files in the same atomic unit), **no conflict occurs**. The system recognizes that both devices agree the file should be removed. + +### Changes in Different Atomic Units + +If Device A modifies files in `SlotA/` and Device B modifies files in `SlotB/`, no conflict occurs. Both changes merge automatically during sync. + +## Best Practices + +### 1. Design Folder Structure Carefully + +Use subfolders for independent save units: + +``` +SaveRoot/ +├── Slot1/ ← Each slot is independent +│ └── save.dat +├── Slot2/ +│ └── save.dat +``` + +A slot-based game save system where each slot is a root-level subfolder is a simple example of how atomic units can be used effectively. + +Other examples include: +- **Shared reference data**: Data that any save slot might use (e.g., unlocked content, achievements) can be stored in its own subfolder, syncing independently from individual save slots +- **Large asset collections**: If your game stores large sets of files that update independently (e.g., downloaded content packs, user-created levels), consider splitting them into multiple root subfolders so updates to one collection don't conflict with updates to another + +### 2. Avoid Root-Level Files for Frequently Modified Data + +Since all root-level files share one atomic unit, avoid placing frequently modified files at the root if they should be independently syncable. + +**Instead of:** +``` +SaveRoot/ +├── autosave.dat ← All root files = 1 atomic unit +└── save1.dat +└── save2.dat +``` + +**Consider:** +``` +SaveRoot/ +├── AutoSave/ +│ └── autosave.dat ← Independent unit +└── Save1/ + └── gamesave.dat ← Independent unit +``` + +### 3. Group Related Data Together + +Files that must stay consistent together should be in the same folder: + +``` +SaveRoot/ +├── Save1/ +│ ├── stats.json ← These files are interdependent +│ ├── inventory.json ← and should conflict together +│ └── quests.json +``` + +### 4. Minimize Conflicts -### Best Practices -- **Design folder structure carefully**: Group related save files into logical folders -- **Minimize conflicts**: Upload frequently to reduce the chance of conflicts -- **Clear conflict UI**: Help players understand what data they might lose with each choice +Upload frequently to reduce the chance of conflicts. The more often you sync, the less likely two devices will have divergent changes. diff --git a/playfab-docs/pricing/account-upgrades.md b/playfab-docs/pricing/account-upgrades.md index 3bd95dd57..c52312f0a 100644 --- a/playfab-docs/pricing/account-upgrades.md +++ b/playfab-docs/pricing/account-upgrades.md @@ -38,6 +38,7 @@ You can change your account's plan via Game Manager using the **Plan Recommendat ### Upgrading from Free to Start You can upgrade your account plan at any time on the **My Studios and Titles** page. Use the following steps to upgrade your account from Free to Start. Upgrading an account will upgrade all studios owned by the account. +1. Log in to [http://developer.playfab.com/](http://developer.playfab.com/). 1. Log in to [http://developer.playfab.com/](http://developer.playfab.com/). 2. On the **My Studios and Titles** page, locate the header of a Studio whose linked account should be upgraded. Select **Upgrade Account**. diff --git a/playfab-docs/pricing/support.md b/playfab-docs/pricing/support.md index a0e42048a..47f9373fe 100644 --- a/playfab-docs/pricing/support.md +++ b/playfab-docs/pricing/support.md @@ -73,6 +73,8 @@ Support availability is based on your account plan, with higher tiers offering e 3. To access the help menu, select the **?** in the top right navigation bar. 4. Select **Contact Us** and fill out the support form. +If you recently requested an upgrade, support ticket submission becomes available when the plan change takes effect. Plan changes are scheduled for the beginning of the next billing period. To confirm your current plan and effective date, see [Account upgrades](account-upgrades.md). + ### EMERGENCY ESCALATIONS **Purpose:** Provides 24/7 access to PlayFab's on-call engineering team in the event of critical service-impacting issues. This provides fastest incident response time to customers during emergencies. diff --git a/playfab-docs/sdks/c/index.md b/playfab-docs/sdks/c/index.md index baef72845..7611116bb 100644 --- a/playfab-docs/sdks/c/index.md +++ b/playfab-docs/sdks/c/index.md @@ -12,7 +12,7 @@ ms.localizationpriority: medium # PlayFab Services SDK for C/C++ -The new PlayFab Services SDK for C/C++ is currently available for the following platforms: Win32 (x64 only), Nintendo Switch, Sony PlayStation®, iOS, macOS, Android, Linux, and the Microsoft GDK. Depending on the platform you're targeting, the way you acquire the SDK differs. +The new PlayFab Services SDK for C/C++ is currently available for the following platforms: Win32 (x64 only), Nintendo Switch, PlayStation®5, PlayStation®4, iOS, macOS, Android, Linux, and the Microsoft GDK. Depending on the platform you're targeting, the way you acquire the SDK differs. ## Win32, iOS, macOS, Android, Linux @@ -26,24 +26,24 @@ To learn more about the GDK, see the public documentation: [GDK documentation ho ## Nintendo Switch -Before you can access the PlayFab Services SDK for Nintendo Switch, you need to confirm your registered developer status via the PlayFab page in Nintendo's middleware directory. See more information here: [Request access](../request-access-for-sdks-samples.md). +Before you can access the PlayFab Services SDK for Nintendo Switch, you need to confirm your registered developer status via the PlayFab page in Nintendo's middleware directory. For more information, see [Request access](../request-access-for-sdks-samples.md). Once you've been granted access to the Switch SDK, you can download it from the git repo here: [PlayFabCSdk.Switch](https://dev.azure.com/PlayFabPrivate/Switch/_git/PlayFabCSdk.Switch). -## Sony PlayStation +## PlayStation 5 / PlayStation 4 -Before you can access the PlayFab Services SDK for PlayStation, you need to confirm your registered developer status via the PlayFab page in Sony's middleware directory. See more information here: [Request access](../request-access-for-sdks-samples.md). +Confirm your developer status on the PlayFab page in the middleware directory of the developer portal before accessing the PlayFab Services SDK for PlayStation. For more information, see [Request access](../request-access-for-sdks-samples.md). Once you've been granted access to the PlayStation SDK, you can download it from the git repo here: [PlayFabCSdk.PS4](https://dev.azure.com/PlayFabPrivate/PS4/_git/PlayFabCSdk.PS4) and [PlayFabCSdk.PS5](https://dev.azure.com/PlayFabPrivate/PS5/_git/PlayFabCSdk.PS5). ## What this SDK includes -The PlayFab Services SDK for C/C++ is for use by a game's runtime components (clients and servers) on Win32 (x64 only), Nintendo Switch, Sony PlayStation®, iOS, macOS, Android, Linux, and the Microsoft GDK. It includes only the subset of feature areas and service calls appropriate for games running on those platforms. +The PlayFab Services SDK for C/C++ is for use by a game's runtime components (clients and servers) on Win32 (x64 only), Nintendo Switch, PlayStation®5, PlayStation®4, iOS, macOS, Android, Linux, and the Microsoft GDK. It includes only the subset of feature areas and service calls appropriate for games running on those platforms. Here are some notable differences when compared to other, more general purpose, PlayFab SDKs: -- The PlayFab Admin API is not included. This SDK is intended to be part of the game runtime (or dedicated server), not for tools or generic services. +- The PlayFab Admin API isn't included. This SDK is intended to be part of the game runtime (or dedicated server), not for tools or generic services. - The PlayFab Server API is only available for select platforms that are used for hosting game servers, specifically Windows, Linux, and macOS. -- The available login methods depend on the platform. For instance, LoginWithApple is only available on Apple devices. +- The available sign in methods depends on the platform. For instance, LoginWithApple is only available on Apple devices. - This SDK removes some older or underutilized feature areas to reduce overall complexity. These areas include economy v1, player stats and leaderboards, and characters. ## Benefits of this SDK @@ -55,11 +55,11 @@ Here are some notable differences when compared to other, more general purpose, ## Platforms supported by this SDK -This SDK is appropriate for x64 Win32 games and game servers, Nintendo Switch games, Sony PlayStation games, iOS games, Android games, macOS games, Linux games, and games utilizing the GDK on Windows and Xbox. +This SDK is appropriate for x64 Win32 games and game servers, Nintendo Switch games, PlayStation games, iOS games, Android games, macOS games, Linux games, and games utilizing the GDK on Windows and Xbox. ## When not to use this SDK -There are scenarios where this SDK is not appropriate: +There are scenarios where this SDK isn't appropriate: - If your game utilizes a game engine for which there's already an engine-specific PlayFab SDK, that SDK is a better fit: [Unreal Engine](../unreal/index.md), [Unity3D](../unity3d/index.md). @@ -77,8 +77,8 @@ There are scenarios where this SDK is not appropriate: - The macOS version of this SDK is available via GitHub. Follow the instructions here to start making basic calls to PlayFab: [Quickstart for macOS](quickstart-macos.md). - Linux - The Linux version of this SDK is available via GitHub. Follow the instructions here to start making basic calls to PlayFab: [Quickstart for Linux](./quickstart-linux.md). -- Sony Playstation - - See [Sony Playstation](#sony-playstation) +- Playstation + - See [PlayStation 5 / PlayStation 4](#playstation-5--playstation-4) - Nintendo Switch - See [Nintendo Switch](#nintendo-switch) @@ -87,7 +87,8 @@ There are scenarios where this SDK is not appropriate: [API reference documentation](../../api-references/c/pfauthentication/pfauthentication_members.md) "PlayStation" is a registered trademark or trademark of Sony Interactive Entertainment Inc. - + \ No newline at end of file diff --git a/playfab-docs/sdks/platforms/playstation.md b/playfab-docs/sdks/platforms/playstation.md index 8d1a7a948..769a8fa3a 100644 --- a/playfab-docs/sdks/platforms/playstation.md +++ b/playfab-docs/sdks/platforms/playstation.md @@ -1,7 +1,7 @@ --- -title: PlayFab Services for Sony PlayStation +title: PlayFab Services for PlayStation author: amccalib -description: PlayFab Services SDK options for Sony PlayStation +description: PlayFab Services SDK options for PlayStation ms.author: andmcc ms.date: 06/23/2023 ms.topic: article @@ -12,7 +12,7 @@ ms.localizationpriority: medium # PlayFab Services SDKs for PlayStation®4 and PlayStation®5 -The following SDKs are available for game client development on PS4™ and PS5®. The right SDK depends mostly on your choice of game engine. +The following SDKs are available for game client development on PS4™ and PS5™. The right SDK depends mostly on your choice of game engine. | PlayFab SDK | Description | Learn More | |----------------|-------------|------------| @@ -21,14 +21,10 @@ The following SDKs are available for game client development on PS4™ and PS5® | Unity | Both an editor extension and stand-alone SDK for Unity3d. | [Unity SDK Overview](../unity3d/index.md) | | Legacy C++ | Our older cross-platform C++ SDK supports a simple REST-like interface with PlayFab across multiple platforms. | [Request Access](../request-access-for-sdks-samples.md) | -## Getting Access to SDKs for PS4™ and PS5® +## Getting Access to SDKs for PS4 and PS5 Our PlayFab Services SDKs for Unreal and Unity are platform-agnostic. As such, they require no special access or permissions from PlayFab to utilize on any platform. -To utilize our C/C++ or Legacy C++ SDKs on PS4™ and PS5®, you must confirm your developer status via DevNet. Once you have approval, we can grant access to the SDK. Learn more about this process here: [Request Access](../request-access-for-sdks-samples.md). +To utilize our C/C++ or Legacy C++ SDKs on PS4 and PS5, you must confirm your developer status via DevNet. Once you have approval, we can grant access to the SDK. Learn more about this process here: [Request Access](../request-access-for-sdks-samples.md). -"PlayStation" is a registered trademark or trademark of Sony Interactive Entertainment Inc. - -"PS4" is a registered trademark or trademark of Sony Interactive Entertainment Inc. - -"PS5" is a registered trademark or trademark of Sony Interactive Entertainment Inc. +"PlayStation", "PS5", and "PS4" are registered trademarks or trademarks of Sony Interactive Entertainment Inc. diff --git a/playfab-docs/sdks/toc.yml b/playfab-docs/sdks/toc.yml index fc4ee4cd1..60e41850c 100644 --- a/playfab-docs/sdks/toc.yml +++ b/playfab-docs/sdks/toc.yml @@ -109,7 +109,7 @@ items: href: platforms/gdk.md - name: Nintendo Switch href: platforms/switch.md - - name: PlayStation + - name: PS5 | PS4 href: platforms/playstation.md - name: Windows href: platforms/windows.md @@ -144,7 +144,7 @@ items: - name: Overview href: ../multiplayer/servers/server-sdks.md - name: Unreal Server SDK - href: ../multiplayer/servers/server-sdks/toc.yml + href: ../multiplayer/servers/server-sdks/unreal-gsdk/toc.yml - name: Tools and utilities href: tools/index.yml items: diff --git a/playfab-docs/sdks/unity3d/installing-unity3d-sdk.md b/playfab-docs/sdks/unity3d/installing-unity3d-sdk.md index c88b9c77b..c0bd060e1 100644 --- a/playfab-docs/sdks/unity3d/installing-unity3d-sdk.md +++ b/playfab-docs/sdks/unity3d/installing-unity3d-sdk.md @@ -1,7 +1,7 @@ --- title: Installing the PlayFab SDK Without Editor Extensions for Unity author: DanBehrendt -description: This guide will help you install the PlayFab Unity 3D SDK and configure your project. +description: This guide helps you install the PlayFab Unity 3D SDK and configure your project. ms.author: jenelleb ms.date: 1/25/2020 ms.topic: article @@ -10,17 +10,17 @@ keywords: playfab, unity3d, playfab unity sdk, csharp, unity ms.localizationpriority: medium --- -# Installing the PlayFab SDK Without Editor Extensions for Unity +# Installing the PlayFab SDK without Editor Extensions for Unity You have two options when installing the PlayFab Unity 3D SDK: -- Install the PlayFab Unity Editor Extensions Asset Package. Then use Editor Extension to install the PlayFab Unity 3D SDK and configure your Unity Project. +- Install the PlayFab Unity Editor Extensions Asset Package. Then use Editor Extensions to install the PlayFab Unity 3D SDK and configure your Unity Project. PlayFab Editor Extensions is a stand-alone Unity plug-in that streamlines getting started with PlayFab. - When a supported SDK is installed, additional service menus are available. These menus provide access to SDK configurations. These configuration settings are saved in a combination of places to ensure that the data persists throughout Unity compilations and deployments. + When a supported SDK is installed, other service menus are available. These menus provide access to SDK configurations. These configuration settings are saved in a combination of places to ensure that the data persists throughout Unity compilations and deployments. -- Install the PlayFab Unity 3D SDK directly without using PlayFab Unity Editor Extensions. When you use this installation method, you configure your Unity Project directly by setting properties property values in your code. +- Install the PlayFab Unity 3D SDK directly without using PlayFab Unity Editor Extensions. When you use this installation method, you configure your Unity Project directly by setting the property values in your code. This content assumes you that you have a [PlayFab developer account](https://developer.playfab.com/en-us/sign-up) and an existing Unity Project. @@ -30,21 +30,21 @@ To install the SDK without using the PlayFab Unity Editor Extensions: 1. Open your Unity project. 2. Download the [PlayFab Unity3D SDK Asset Package](https://aka.ms/playfabunitysdkdownload) from the PlayFab GitHub repo. -3. Navigate to where you downloaded the file, and double-click on the .UnityPackage file to open the **Import Unity Package** dialog in the Unity Editor. +3. Navigate to where you downloaded the file, and double-click on the UnityPackage file to open the **Import Unity Package** dialog in the Unity Editor. 4. To import the PlayFab Unity3D SDK into your project, select **Import**. -## Setting the Title ID without using the editor extensions +## Setting the Title ID without using the Editor Extensions To set the title: -1. In the Unity Editor Project panel select the **Assets** folder. +1. In the Unity Editor Project panel, select the **Assets** folder. 2. Open the **Assets** > **PlayFabSdk** > **Shared** > **Public** > **Resources** folder. 3. Select the PlayFabSettings Asset. 4. In the **Inspector** window, set the **Title ID**. ![PlayFab Inspector Title ID Setting](media/playfab-shared-settings-title-id.png) -If you are making a server build, be sure to provide the **Developer Secret Key** as well. +If you're making a server build, be sure to provide the **Developer Secret Key** as well. ![PlayFab Developer Secret Key Setting](media/playfab-shared-settings-secret-key.png) diff --git a/playfab-docs/sdks/unreal/quickstart.md b/playfab-docs/sdks/unreal/quickstart.md index e2ff2eb0e..6d9f9b9a4 100644 --- a/playfab-docs/sdks/unreal/quickstart.md +++ b/playfab-docs/sdks/unreal/quickstart.md @@ -46,6 +46,8 @@ To enable the PlayFab Plugin: 1. From the **Settings** menu, under **Game Specific Settings** select **Plugins**. 2. Enable the **PlayFab** plugin and restart Unreal Engine as required. +If "PlayFab" doesn't appear in **Plugins**, verify that the plugin is installed from the Unreal Marketplace. Restart Unreal Editor. Then open **Plugins** again and search for "PlayFab." + ### Add PlayFab as a Module dependency in C++ In Visual Studio, add PlayFab as a module dependency in your C++ project: diff --git a/playfab-docs/test-documents/login-basics-best-practices-01.md b/playfab-docs/test-documents/login-basics-best-practices-01.md new file mode 100644 index 000000000..bf8ac253d --- /dev/null +++ b/playfab-docs/test-documents/login-basics-best-practices-01.md @@ -0,0 +1,123 @@ +--- +title: Login basics and best Practices +author: antnguyen89 +description: Describes the basics and Best Practices for login and authentication of players in PlayFab. +ms.author: antnguyen +ms.date: 02/20/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, authentication +ms.localizationpriority: medium +--- + +# Login basics and best practices + +## Platform-specific authentication tutorials + +While all of the platform-specific authentication tutorials demonstrate logging in with [LoginWithCustomID](xref:titleid.playfabapi.com.client.authentication.loginwithcustomid), the uses for this login in a published game are limited to pairing a PlayFab account to a pre-existing database, or another back-end system. + +Otherwise, it's rare for a published title to use a custom ID for a primary login, since in most cases you want to capture additional information on the player's platform. + +### Why we demonstrate this first + +Bluntly - because it's the easiest. A custom ID can be anything, and it makes it easier to call your first API. Once you get serious about developing and releasing your title, it's likely you'll switch to another login mechanism. + +### Best practice + +Unless you know *exactly* why you want `LoginWithCustomId` in your released title, you should migrate to another login mechanism before you launch. + +## Anonymous login mechanisms + +Anonymous login mechanisms are the simplest to use. They require *zero* input from the player, so there's no friction to the first time user experience - and the result is a unique account in PlayFab for each player. *This is the most common login mechanism*. + +These logins include: + +- [LoginWithIOSDeviceID](xref:titleid.playfabapi.com.client.authentication.loginwithiosdeviceid) +- [LoginWithAndroidDeviceID](xref:titleid.playfabapi.com.client.authentication.loginwithandroiddeviceid) +- [LoginWithCustomID](xref:titleid.playfabapi.com.client.authentication.loginwithcustomid) +- [LoginWithNintendoSwitchDeviceId](xref:titleid.playfabapi.com.client.authentication.loginwithnintendoswitchdeviceid) + +Since they're anonymous, these methods can uniquely identify a device, *but contain no recoverable information about the player*. If the player loses or breaks their device, the account is lost, and may be difficult to recover. In most cases the account is orphaned and not retrievable. + +So why use it? Because it's the lowest possible barrier to entry for the player, requiring no interaction. It gets the player trying your game with minimal effort, while creating an account they can get back to for continuity (as long as they have that device). + +### Best practice + +Your game should use an *anonymous* login for creating a new account and linking new devices to an existing account. We recommend this because some players might abandon a game that asks for an e-mail or identifiable information. + +However, once the anonymous login is complete, you should provide the option to add *recoverable* login credentials, and provide some explanation regarding the benefits. + +In particular, you should make sure that paying customers are guided to the *recoverable* login systems, to prevent loss of their accounts. A free account lost forever is a disappointment... + +A paid account lost forever affects revenue. + +### iOS devices + +For iOS devices, the player ID changes if they uninstall your game, and then reinstall it. One way to make sure you have a consistent ID on iOS is to save the device ID for the player to the iTunes KeyChain, so that you can read it from there on game start, and use it to sign in. + +You must determine how to generate unique custom IDs for any other device or platform. Custom IDs are an effective alternative for other platforms or devices, but you must generate your custom IDs with care. If they're too simple, you risk hackers stealing the accounts of others. + +### Android devices + +For latest best practices, see [Google's guidelines on user data IDs](https://developer.android.com/training/articles/user-data-ids). + +> [!NOTE] +> Binding a recoverable login is only required *once* per device. Once bound, the game can continue to use the anonymous login with no drawbacks. See the next section. + +An anonymous login is convenient for the player, but it *isn't* required. Your game can rely exclusively on a recoverable login mechanism. However, your players are happier if they *don't* have to type a password every time they log in. + +## Recoverable login mechanisms + +A *recoverable* login mechanism requires some identity information from the player. As described above, it can be paired with an anonymous login for the best player experience. + +### Pure PlayFab options + +The simplest options are: + +- [LoginWithPlayFab](xref:titleid.playfabapi.com.client.authentication.loginwithplayfab) +- [LoginWithEmailAddress](xref:titleid.playfabapi.com.client.authentication.loginwithemailaddress) + +If used, the e-mail or username-plus-password are authenticated directly by PlayFab. The account is recoverable by the e-mail or username, *even* if the user forgets their password. The login is generally secure (you can implement your own password strength check into your game to improve this). + +### Third party API options + +These require separate API calls to another service, but don't require extra SDK installations: + +- [LoginWithKongregate](xref:titleid.playfabapi.com.client.authentication.loginwithkongregate) +- [LoginWithSteam](xref:titleid.playfabapi.com.client.authentication.loginwithsteam) +- [LoginWithTwitch](xref:titleid.playfabapi.com.client.authentication.loginwithtwitch) +- [LoginWithGameCenter](xref:titleid.playfabapi.com.client.authentication.loginwithgamecenter) (iOS only, and provided you require secure authentication.) + +Secure authentication happens between your user, and the third party service API call. + +### Third party SDK options + +These require a separate SDK installed into your game. Secure authentication happens within the third party SDK. + +- [LoginWithFacebook](xref:titleid.playfabapi.com.client.authentication.loginwithfacebook) +- [LoginWithGoogleAccount](xref:titleid.playfabapi.com.client.authentication.loginwithgoogleaccount) + +In all third party options, those services process the login credentials, and you pass a secure token to the appropriate PlayFab login method. PlayFab remains unaware of the login credentials for those services. + +### More best practices + +Use an appropriate anonymous login for a basic login, and encourage your player to link to a recoverable login. You should pick any one or more of the recoverable mechanisms with which you're comfortable and familiar. + +> [!TIP] +> Account recovery only requires *one* recoverable login, so don't pressure your player to use all of them. + +## Insecure login mechanisms + +One benefit of recoverable login mechanisms is they're more secure than logging in with a custom ID, as they require verified authentication with a third party rather than relying on a user's custom ID remaining a shared secret. + +## Conclusion + +Anonymous login is great, and it provides the user with a fully automated login process. The downside is account recovery, which is sometimes impossible without a recoverable login. + +The following flow chart describes anonymous login followed by adding a recoverable login mechanism. + +![PayFab anonymous login and recoverable login mechanism](../media/tutorials/playfab-anonymous-login-and-recoverable-login.png) + +### Best practice + +Use the appropriate anonymous login for your device, paired with one, or more options for account recovery. diff --git a/playfab-docs/test-documents/multiple-logins-01.md b/playfab-docs/test-documents/multiple-logins-01.md new file mode 100644 index 000000000..d1669b31c --- /dev/null +++ b/playfab-docs/test-documents/multiple-logins-01.md @@ -0,0 +1,245 @@ +--- +title: Handling Multiple PlayFab Logins +author: antnguyen89 +description: Describes how to use SDK features to manage multiple logins from a single client. +ms.author: antnguyen +ms.date: 02/20/2025 +ms.topic: article +ms.service: azure-playfab +keywords: playfab, authentication, sdk, unity, unreal +ms.localizationpriority: medium +--- + +# Handling multiple PlayFab logins + +By default, most PlayFab SDKs cache player login results. This caching can be convenient in the most common scenario when you expect a single player login. In games where you support multiple concurrent players or servers where you manage both players' authentication material and server credentials, that caching can get in the way. To facilitate these scenarios, PlayFab SDKs contain both static and instanced API classes. + +## Static versus instanced API classes + +Most examples and sample code for PlayFab are built using static API classes. In Unity, for example, you might see a reference to __PlayFabClientAPI__. These static classes write to and read from static state within the SDK. Their dependence on static state makes it difficult to use these classes when you're working with multiple players within the same game client. Instanced API classes avoid these problems in exchange for increased management and tracking requirements on your part. In cases where you need to support multiple simultaneous PlayFab logins, we recommend using instanced API classes. + +In the Unity SDK, __PlayFabClientInstanceAPI__ is the instanced version of __PlayFabClientAPI__. All other API classes follow a similar naming pattern. When using the instanced version of an API class, you must create an instance of the class before you can call any methods. To create an instance, you have to specify some extra context. For most classes, the extra required context is just the player's authentication context. In Unity, this context is __PlayFabAuthenticationContext__. Some classes contain login calls. For these calls, you might not have a player's authentication context yet. If that's the case, you only have to provide basic settings like a title ID. These settings are passed in via a __PlayFabApiSettings__ object. + +## Using instanced API classes + +Once you have an instanced API class created with an appropriate authentication context or API settings object, it can be used similarly to a static class. All of the request and response objects are identical. The only difference is that you're responsible for tracking the lifetime of the instance and ensure that any potential callers of PlayFab are provided an appropriate instance. When you're dealing with multiple players, you require multiple instances of any API classes, one per player. It's often easiest to manage these instances encapsulated behind a player object as an owner, but that is left to you. + +Instanced classes that log in a player (such as __PlayFabClientInstanceAPI__) also create and cache the authentication context for that player within the API class instance. This feature allows you to easily reference the authentication context when creating any more classes you need. + +## Unity example + +This sample code demonstrates how multiple players can log in to a game and have independent state tracked in separate class instances. In this example, the API classes and basic functionality are encapsulated behind a simplistic __PlayFabPlayer__ object. When the game starts, we log in two players and then get any data stored in PlayFab for each of those players. + +```csharp +using PlayFab; +using PlayFab.ClientModels; +using PlayFab.DataModels; +using System.Collections.Generic; +using UnityEngine; + +public class PlayFabLogin : MonoBehaviour +{ + PlayFabPlayer player1 = new PlayFabPlayer(); + PlayFabPlayer player2 = new PlayFabPlayer(); + + // Start is called before the first frame update + void Start() + { + if (string.IsNullOrEmpty(PlayFabSettings.staticSettings.TitleId)) + { + // Please change the titleId below to your own titleId from PlayFab Game Manager. + PlayFabSettings.staticSettings.TitleId = ""; + } + + player1.Login("testLogin1"); + player2.Login("testLogin2"); + } + + // Update is called once per frame + void Update() + { + if (player1.loggedIn && !player1.dataLoaded && !player1.dataLoading) + { + player1.LoadData(); + } + if (player2.loggedIn && !player2.dataLoaded && !player2.dataLoading) + { + player2.LoadData(); + } + } +} + +class PlayFabPlayer +{ + public bool loggedIn = false; + public bool dataLoading = false; + public bool dataLoaded = false; + public string PlayFabId; + public Dictionary playerData; + + private PlayFabClientInstanceAPI clientApi; + private PlayFabDataInstanceAPI dataApi; + + public void Login(string customId) + { + clientApi = new PlayFabClientInstanceAPI(PlayFabSettings.staticSettings); + + var request = new LoginWithCustomIDRequest { CustomId = customId, CreateAccount = true }; + + clientApi.LoginWithCustomID(request, result => + { + PlayFabId = result.PlayFabId; + loggedIn = true; + dataApi = new PlayFabDataInstanceAPI(clientApi.authenticationContext); + Debug.Log("Login call succeeded."); + }, error => + { + Debug.LogWarning("Something went wrong with the login call."); + Debug.LogError("Here's some debug information:"); + Debug.LogError(error.GenerateErrorReport()); + }); + } + + public void LoadData() + { + dataLoading = true; + var request = new GetObjectsRequest { Entity = new PlayFab.DataModels.EntityKey { Id = clientApi.authenticationContext.EntityId, Type = clientApi.authenticationContext.EntityType } }; + + dataApi.GetObjects(request, result => + { + playerData = result.Objects; + dataLoaded = true; + dataLoading = false; + Debug.Log("Player data loaded."); + }, error => + { + Debug.LogWarning("Something went wrong with the GetObjects call."); + Debug.LogError("Here's some debug information:"); + Debug.LogError(error.GenerateErrorReport()); + }); + } +} +``` + +## Unreal example + +This code sample demonstrates an actor in Unreal that contains its own PlayFab login context. It shows how to encapsulate PlayFab API instance classes within an __ALoginActor__ class. Multiple __ALoginActor__ instances can be added to a map, given their own CustomIds, and perform PlayFab operations independently. + +LoginActor.h: +```cpp +#pragma once + +#include "CoreMinimal.h" +#include "GameFramework/Actor.h" +#include "PlayFab.h" +#include "Core/PlayFabError.h" +#include "Core/PlayFabClientDataModels.h" +#include "Core/PlayFabClientAPI.h" +#include "Core/PlayFabDataAPI.h" +#include "LoginActor.generated.h" + +UCLASS() +class MINUE_PF_MARKET_API ALoginActor : public AActor +{ + GENERATED_BODY() + +public: + // Sets default values for this actor's properties + ALoginActor(); + + // Please change the TitleId below to your own TitleId from PlayFab Game Manager. + UPROPERTY(EditAnywhere, config, Category = Settings) + FString TitleId = TEXT(""); + + UPROPERTY(EditAnywhere, config, Category = Settings) + FString CustomId = TEXT("ExampleCustomId"); + +protected: + // Called when the game starts or when spawned + + virtual void BeginPlay() override; + + void OnLoginSuccess(const PlayFab::ClientModels::FLoginResult& Result); + void OnGetObjectsSuccess(const PlayFab::DataModels::FGetObjectsResponse& Result); + void OnError(const PlayFab::FPlayFabCppError& ErrorResult) const; + +public: + bool LoggedIn = false; + + // Called every frame + virtual void Tick(float DeltaTime) override; + + PlayFabClientPtr clientAPI = nullptr; + PlayFabDataPtr dataAPI = nullptr; + + TMap PlayerData; + bool DataLoaded = false; +}; +``` + +LoginActor.cpp: +```cpp +#include "LoginActor.h" + +ALoginActor::ALoginActor() +{ + // Set this actor to call Tick() every frame. You can turn this off to improve performance if you don't need it. + PrimaryActorTick.bCanEverTick = true; +} + +void ALoginActor::Tick(float DeltaTime) +{ + Super::Tick(DeltaTime); +} + +void ALoginActor::BeginPlay() +{ + Super::BeginPlay(); + GetMutableDefault()->TitleId = TitleId; + + clientAPI = IPlayFabModuleInterface::Get().GetClientAPI(); + dataAPI = IPlayFabModuleInterface::Get().GetDataAPI(); + + PlayFab::ClientModels::FLoginWithCustomIDRequest request; + request.CustomId = CustomId; + request.CreateAccount = true; + + clientAPI->LoginWithCustomID(request, + PlayFab::UPlayFabClientAPI::FLoginWithCustomIDDelegate::CreateUObject(this, &ALoginActor::OnLoginSuccess), + PlayFab::FPlayFabErrorDelegate::CreateUObject(this, &ALoginActor::OnError) + ); +} + +void ALoginActor::OnLoginSuccess(const PlayFab::ClientModels::FLoginResult& Result) +{ + UE_LOG(LogTemp, Log, TEXT("Login call succeeded.")); + LoggedIn = true; + + PlayFab::DataModels::FGetObjectsRequest dataRequest; + dataRequest.AuthenticationContext = Result.AuthenticationContext; + dataRequest.Entity.Id = Result.EntityToken->Entity->Id; + dataRequest.Entity.Type = Result.EntityToken->Entity->Type; + + dataAPI->GetObjects( + dataRequest, + PlayFab::UPlayFabDataAPI::FGetObjectsDelegate::CreateUObject(this, &ALoginActor::OnGetObjectsSuccess), + PlayFab::FPlayFabErrorDelegate::CreateUObject(this, &ALoginActor::OnError) + ); +} + +void ALoginActor::OnError(const PlayFab::FPlayFabCppError& ErrorResult) const +{ + UE_LOG(LogTemp, Error, TEXT("Something went wrong with your API call.\nHere's some debug information:\n%s"), *ErrorResult.GenerateErrorReport()); +} + +void ALoginActor::OnGetObjectsSuccess(const PlayFab::DataModels::FGetObjectsResponse& Result) +{ + PlayerData = Result.Objects; + DataLoaded = true; + UE_LOG(LogTemp, Log, TEXT("Player data loaded.")); +} +``` + +## Server authentication + +Similar to how instanced API classes allow a game client to handle multiple players, they allow servers to handle a combination of title and player authentication or even multiple titles simultaneously. The basic pattern is nearly identical. Instantiate an API class to handle server login, provide that instance the appropriate __PlayFabApiSettings__ object, and then call an authentication API. If you're on a server, that API is commonly __PlayFabAuthenticationInstanceAPI.GetEntityToken__. Just like a player login, the result of a __GetEntityToken__ call is cached in the API class instance and can be referenced to create more API class instances via the __authenticationContext__ instance property. \ No newline at end of file