The code sample below demonstrates one possible usage for the
`Class.AnalyticsService:FireCustomEvent()|FireCustomEvent()` function, which
can be used to fire a custom event for the `AnalyticsService`. In this
example, the custom function is used to report that a new server has started,
which would allow the developer to track data such as how many servers are
started for their game.


AnalyticsService:FireCustomEvent

player

eventCategory

customData

AnalyticsService:FireEvent

value

The event below demonstrates one possible usage for the
`AnalyticsService:FireInGameEconomyEvent` function. It uses the function to
invoke an analytics economy event when the parented gold `Part` is touched by
a player.


AnalyticsService:FireInGameEconomyEvent

itemName

economyAction

itemCategory

amount

currency

location

The code sample below demonstrates how to use the
`Class.AnalyticsService:FireLogEvent()` function to track log events using the
`AnalyticsService`. The example uses the function to report when a
`Class.TeleportService:Teleport()` call fails.


AnalyticsService:FireLogEvent

logLevel

message

debugInfo

This example demonstrates how to use the
`AnalyticsService:FirePlayerProgressionEvent` function to trigger an analytics
progression event. When a player touches the parent `Part`, a _wisdomStone_,
the function is fired as a _LevelUp_ event.


AnalyticsService:FirePlayerProgressionEvent

progressionStatus

statistics

AnalyticsService:LogEconomyEvent

flowType

currencyType

endingBalance

transactionType

itemSku

customFields

AnalyticsService:LogFunnelStepEvent

funnelName

funnelSessionId

step

stepName

AnalyticsService:LogOnboardingFunnelStepEvent

AnalyticsService:LogProgressionCompleteEvent

progressionPathName

level

levelName

AnalyticsService:LogProgressionEvent

status

AnalyticsService:LogProgressionFailEvent

AnalyticsService:LogProgressionStartEvent

AnalyticsService

AnalyticsService.ApiKey

Demonstrates detecting changes to an instance's ancestry by connecting to the `Class.Instance.AncestryChanged` event.

The ChangingPart's Parent is set to different values overtime. The parent of the part is the part's ancestor, so the `Class.Instance.AncestryChanged` event will fire whenever it changes.


Instance.AncestryChanged

child

parent

Instance.AttributeChanged

attribute

This sample demonstrates the subtleties of the Changed event on normal objects
and "-Value" objects.


This code sample demonstrates the Changed event firing within a parent object.


Instance.Changed

property

This snippet prints the names of objects as they are added to the Workspace:


Instance.ChildAdded

This snippet prints the names of objects as they are removed from the
Workspace:


Instance.ChildRemoved

This following example will print the name of any object that is added to the
Workspace:


Instance.DescendantAdded

descendant

The following example prints the name of any descendant as it is being removed
from the Workspace:


Instance.DescendantRemoving

This sample demonstrates how an Instance being destroyed remains in place
until the connected function yields.


Instance.Destroying

Instance.childAdded

Instance:AddTag

This example creates a Part and adds a few sparkle objects to the part. Then
it calls Part:ClearAllChildren() to remove all of the children.


Instance:ClearAllChildren

Demonstrates cloning a model using `Class.Instance:Clone()`.

Instance:Clone

Demonstrates destroying a Part using the `Class.Instance:Destroy()` function.

This function is the correct way to dispose of objects that are no longer required.


Instance:Destroy

Instance:FindFirstAncestor

name

Instance:FindFirstAncestorOfClass

className

Instance:FindFirstAncestorWhichIsA

The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".


Instance:FindFirstChild

recursive

Instance:FindFirstChildOfClass

Instance:FindFirstChildWhichIsA

Instance:FindFirstDescendant

Instance:GetActor

Instance:GetAttribute

Instance:GetAttributeChangedSignal

Instance:GetAttributes

The below would print the name of all objects currently in Workspace when ran.


Instance:GetChildren

Instance:GetDebugId

scopeLength

GetDescendants is often used to do something to all the descendants that are a
particular type of object. The code in this example uses GetDescendants and
`Class.Instance:IsA()` to find all of the parts in the workspace and turns
them green.


Instance:GetDescendants

This code sample demonstrates the behavior of `Class.Instance:GetFullName()`.
It shows how the function behaves when called on an object not in the
`DataModel` hierarchy, and it also shows how the return value does not escape
special characters.


This code sample re-implements the `Class.Instance:GetFullName()` function in
Lua.


Instance:GetFullName

This code sample demonstrates how to save a value before a changed event fires
on it in order to get more information about a change.


This code sample demonstrates the equivalence of the `Changed` event and event
returned by `GetPropertyChangedSignal`.


Instance:GetPropertyChangedSignal

Instance:GetTags

Instance:HasTag

Demonstrates determining the class of Workspace using `Class.Instance:IsA()`

Workspace is of class 'Workspace', so the first statement is true.
Workspace is not of class 'BasePart', so the second statement is false.
Workspace inherits from Instance and therefore is of class 'Instance', so the third statement is true.


Instance:IsA

Demonstrates determining if one instance is the ancestor of another using `Class.Instance:IsAncestorOf()`

Workspace and SpawnLocation are ancestors of the SpawnLocation's decal.
Workspace is an ancestor of SpawnLocation.

SpawnLocation and its decal are descendants of Workspace, not ancenstors.
Decal is a descendant to SpawnLocation, not an ancestor.


Instance:IsAncestorOf

Instance:IsDescendantOf

ancestor

The following code demonstrates how a part can be re-added to the DataModel
after being removed:


Instance:Remove

Instance:RemoveTag

Instance:SetAttribute

The following code waits for an instance named "Part" to be added to
Workspace.


Instance:WaitForChild

childName

timeOut

Instance:children

Instance:clone

Instance:destroy

Instance:findFirstChild

Instance:getChildren

Instance:isA

Instance:isDescendantOf

Instance:remove

Instance

Instance.Archivable

Instance.ClassName

Instance.Name

Instance.Parent

Instance.RobloxLocked

Instance.Sandboxed

Instance.UniqueId

Instance.archivable

Instance.className

/reference/engine/classes/AnalyticsService.yaml

An internal service used by Roblox to collect analytics from `CoreScripts`.


An `Class.Actor` is a container for code that can be safely split into its own thread.

Class

Actor

This enum is used as an argument in `Class.AnalyticsService:FireInGameEconomyEvent()`.

Enum

Enum.AnalyticsEconomyAction

Enum.AnalyticsEconomyFlowType

This enum is used as an argument in `Class.AnalyticsService.LogEvent` to describe the error severity level.

Enum.AnalyticsLogLevel

This enum is used as an argument in `Class.AnalyticsService:FirePlayerProgressionEvent()` to describe the status of progression.

Enum.AnalyticsProgressionStatus

Enum.AnalyticsProgressionType

Luau

Array

Dictionary

Data Type

Objects

An object that represents a presently connected client to the game.

Player

An object that runs connected functions upon a specific occurrence.

RBXScriptSignal

Variant

Data type having a value of either true or false.

bool

A double-precision floating-point number.

number

A sequence of characters, such as letters, numbers, and symbols.

string

void

概要

ガイド

チュートリアル

リファレンス

リソース

アート

デザイン

エンジン

Avatar

クラウド

このフィールドはリソースの作成時に設定できますがその後のリクエストでは変更することはできません。

このフィールドはリクエスト上で提供されることはあるかもしれませんが、応答に入ることはありません。

各APIキー：各IPアドレスにつき {maxInPeriod} 回のリクエストが {periodInSeconds} 秒ごとに送信されます

このフィールドは応答に設定できますが、リクエストでは無視されます。

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 [API キーの管理]({apiKeyReferenceDocLink}) をごらんください。

次のエンドポイントは、ベースのURLに相対するパスで使用できます。

この文字列は [Timestamp](/cloud/reference/types#fieldmask) としてフォーマットされています。

JSON 値は、 `null`、 `boolean`、 `string`、 `number`、 `array`、 `object` にはできません。

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下の範囲が必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 [アプリ登録とレビュー]({oauth2ReferenceDocLink}) をごらんください。

以下のオブジェクトは、受け入れられたか返されたペイロードの説明です。これらのオブジェクトがいつ使用されるかについて詳しくは、各エンドポイントを参照してください。

この文字列は [Timestamp](/cloud/reference/types#timestamp) としてフォーマットされています。

これであなたのアセットについての情報を表示できるようになります。

これでRobloxにアセットをアップロードしたり、アップデートしたりできます。

これでクリエーターストアの製品に関する情報を表示できます。

これでクリエーターストアの製品に関する情報を変更できます。

これであなたのグループについての情報を表示できるようになります。

これでお持ちのアカウントのグループ参加リクエストを管理できるようになります。

これであなたの持ち物リストについての情報を表示できるようになります。

これでユーザーに代わってメッセージを公開する権限を与えることができます。

これでバーチャル空間からユーザーに通知を送信できるようになります

これであなたのバーチャル空間に関連した秘密をリストアップできるようになります。

これであなたのバーチャル空間に関連した秘密を作成してアップデートできるようになります。

プレース情報を読み取る能力を付与。

プレース情報を編集する能力を付与。

この操作によって、Robloxに新しいバージョンのバーチャル空間を公開するアクセス権限が与えられます。

バーチャル空間の情報を読む能力を付与。

バーチャル空間の情報を編集する能力を付与。

バーチャル空間内でのユーザー制限を表示できます。

バーチャル空間内でのユーザー制限が編集できるようになります。

ユーザーがプレミアム会員がどうかと認証済みかどうかを読み取る権限を付与。

これでユーザーのSNSアカウントを表示できるようになります。

これはシングルサインオン機能を有効化

これにより、あなたのプロフィール情報を読む権限が与えられます

AnalyticsService

概要

プロパティ

方法

イベント

プロパティ

方法

LogEconomyEvent

パラメータ

戻り値

LogFunnelStepEvent

パラメータ

戻り値

LogOnboardingFunnelStepEvent

パラメータ

戻り値

LogProgressionCompleteEvent

パラメータ

戻り値

LogProgressionEvent

パラメータ

戻り値

LogProgressionFailEvent

パラメータ

戻り値

LogProgressionStartEvent

パラメータ

戻り値

イベント