-
Notifications
You must be signed in to change notification settings - Fork 0
home
This is the Facebook extension, which contains various functionality for Facebook, including sign in.
The sign-in functionality is supported on all platforms. Other functionality may not be available on all platforms.
Important
Some functions of this extension take a parameter of type DSList. However, extension functions currently cannot accept DS list references. To fix this you can wrap the list in a function call to real.
These are the guides for the Facebook extension:
These are the functions in the Facebook extension:
- fb_login
- fb_login_oauth
- fb_logout
- fb_status
- fb_graph_request
- fb_dialog
- fb_check_permission
- fb_accesstoken
- fb_request_read_permissions
- fb_request_publish_permissions
- fb_user_id
- fb_ready
- fb_init
- fb_refresh_accesstoken
- fb_send_event
- fb_send_event_string
- fb_set_auto_log_app_events_enabled
- fb_set_advertiser_id_collection_enabled
These are the constants used by the Facebook extension.
This function starts a login, requesting the given list of permissions.
For every requested permission, a key is added to async_load with the value being either "granted" or "declined".
See: Facebook Login
Note
This function is only supported on Android, iOS and HTML5.
Note
If your app asks for more than the default public profile fields and email, Facebook must review it before you release it. See App Review.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.
Syntax:
fb_login(permissions)
| Argument | Type | Description |
|---|---|---|
| permissions | DSList | The permissions to request |
Returns:
Triggers:
| Key | Type | Description |
|---|---|---|
| type | String | The string "facebook_login_result"
|
| requestId | Real | The async request ID |
| status | String | The status of the request, as a string (one of "success", "cancelled" or "error") |
| exception | String | The exception message, in case of an error |
| permission_status | String | A key-value pair added to async_load with the key the permission name and the value either "granted" or "declined"
|
Example:
permissions = ds_list_create();
ds_list_add(permissions, "public_profile");
fb_login(real(permissions));The code above logs in using fb_login, requesting the default "public_profile" permission.
If the login succeeds, a Social Async Event will be triggered:
if(async_load[?"type"] == "facebook_login_result")
{
var _status = async_load[?"status"];
if(_status == "success")
{
show_debug_message("Facebook Token: " + fb_accesstoken());
show_debug_message("Permissions:");
for(var i = 0;i < ds_list_size(permissions);i++)
{
var _permission = permissions[|i];
show_debug_message($"{_permission}: {async_load[? _permission]}");
};
ds_list_destroy(permissions);
}
else if(_status == "cancelled")
{
}
else if(_status == "error")
{
var _exception = ds_map_find_value(async_load, "exception");
show_message_async(_exception);
}
}If the status equals "success", the access token as well as the permissions are shown in a debug message.
This function starts a login using OAuth.
The function sends a request to the Facebook API's OAuth endpoint.
OAuth authentication is supported on all platforms and can be used as an alternative login method on platforms that use the SDK (using fb_login).
Syntax:
fb_login_oauth(state)
| Argument | Type | Description |
|---|---|---|
| state | String | A unique state value that's sent with the login request |
Returns:
N/A
Example:
See the OAuth section of the Login Guide page for a detailed code example.
This function logs out of Facebook.
Syntax:
fb_logout()
Returns:
N/A
This function returns the current login status.
This status can be one of the following values:
"IDLE""PROCESSING""FAILED""AUTHORISED"
Syntax:
fb_status()
Returns:
Example:
var _status = fb_status();
show_debug_message(_status);The above code requests the login status and outputs it in a debug message.
This function sends a request to the provided endpoint with the parameters defined as a set of key-value pairs.
See the User reference for the possible key-value pairs.
See: Graph API
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.
Syntax:
fb_graph_request(graph_path, http_method, params)
| Argument | Type | Description |
|---|---|---|
| graph_path | String | the path to the endpoint in the graph to access |
| http_method | String | the HTTP method to use. Can be one of the following: "GET", "POST", "DELETE"
|
| params | DSList | The parameters to use, provided as key-value pairs |
Returns:
Triggers:
| Key | Type | Description |
|---|---|---|
| type | String | The string "fb_graph_request"
|
| requestId | Real | The ID of the async request |
| status | String | The status of the request, as a string (one of "success", "cancelled" or "error") |
| exception | String | The exception message, in case of an error |
| response_text | String | The response text, if the request was successful |
Example:
fb_graph_request("me/friends", "GET", -1);The code above gets the current user's friends.
This function brings up a share dialog to share the given link on the user's Timeline.
See: Sharing
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.
Syntax:
fb_dialog(link)
| Argument | Type | Description |
|---|---|---|
| link | String | The link to share |
Returns:
Triggers:
| Key | Type | Description |
|---|---|---|
| type | String | The string "fb_dialog"
|
| requestId | Real | The async request ID |
| status | String | The status of the request, as a string (one of "success", "cancelled" or "error") |
| exception | String | The exception message, in case of an error |
| postId | String | The ID of the post |
Example:
fb_dialog("www.gamemaker.io");The code above brings up a share dialog to share the given URL.
This functions checks if the given permission is present in the current access token.
Syntax:
fb_check_permission(permission)
| Argument | Type | Description |
|---|---|---|
| permission | String | The name of the permission to check |
Returns:
Example:
if(!fb_check_permission("user_likes"))
{
show_debug_message("Permission user_likes not granted.");
}This function returns the current access token.
If no access token exists an empty string "" is returned.
Syntax:
fb_accesstoken()
Returns:
This function reauthenticates the currently logged in user with read permissions.
Note
If your app asks for more than the default public profile fields and email, Facebook must review it before you release it. See App Review.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.
Syntax:
fb_request_read_permissions(permissions)
| Argument | Type | Description |
|---|---|---|
| permissions | DSList | The permissions to request |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| type | String | The string "facebook_login_result"
|
| requestId | Real | The async request ID |
| status | String | The status of the request, as a string (one of "success", "cancelled" or "error") |
| exception | String | The exception message, in case of an error |
Example:
var _permissions = ds_list_create();
ds_list_add(_permissions,
"user_age_range",
"user_birthday",
"user_location"
);
fb_request_read_permissions(real(_permissions));
ds_list_destroy(_permissions);The code above creates a DSList and adds a few permissions (scopes) to it. It then requests read permissions on this list of items. Finally, the list is destroyed.
This function reauthenticates the currently logged in user with publish permissions.
Note
If your app asks for more than the default public profile fields and email, Facebook must review it before you release it. See App Review.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.
Syntax:
fb_request_publish_permissions(permissions)
| Argument | Type | Description |
|---|---|---|
| permissions | DSList | The permissions to request |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| type | String | The string "facebook_login_result"
|
| requestId | Real | The async request ID |
| status | String | The status of the request, as a string (one of "success", "cancelled" or "error") |
| exception | String | The exception message, in case of an error |
Example:
var _permissions = ds_list_create();
ds_list_add(_permissions, "publish_actions");
fb_request_publish_permissions(real(_permissions));
ds_list_destroy(_permissions);The code above creates a DSList and adds a permission (scope) to it. It then requests publish permissions on this list of items. Finally, the list is destroyed.
This function returns the user ID of the user that's currently logged in.
The user ID is a string of numbers that doesn't personally identify you but does connect to your Facebook profile and specific chats on Messenger.
If no valid user ID was found, an empty string "" is returned.
Syntax:
fb_user_id()
Returns:
This function returns if the extension has been initialised. See fb_init.
Syntax:
fb_ready()
Returns:
Example:
if (!fb_ready()) { exit; }
// Call fb_* functions here
// ...The code above checks if the Facebook extension has been initialised and exits the current block of code if not.
If code execution reaches the next line, calls to the fb_* functions can be made here.
This function initialises the Facebook extension.
Note
This function must be called before using any other extension functions. Use fb_ready to check if the extension was initialised successfully.
Syntax:
fb_init()
Returns:
N/A
Example:
fb_init();This function refreshes the current access token.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.
Syntax:
fb_refresh_accesstoken()
Returns:
Triggers:
| Key | Type | Description |
|---|---|---|
| type | String | The string "fb_refresh_accesstoken"
|
| requestId | Real | The async request ID |
| status | String | The status of the request, either "success" or "error"
|
| exception | String | The exception message in case of an error |
Example:
fb_refresh_accesstoken();This function logs a custom app event.
The function returns whether the event was sent successfully.
See: App Events
Syntax:
fb_send_event(event_name, value_to_sum=undefined, event_params=undefined)
| Argument | Type | Description |
|---|---|---|
| event_name | FacebookExtension2_EVENT | The name of the event to log |
| value_to_sum | Real | The value to add to the sum for this event |
| event_params | DSList | The event parameters (one or more of FacebookExtension2_PARAM) as key-value pairs |
Returns:
N/A
Example:
var _params = ds_list_create();
ds_list_add(_params,
FacebookExtension2_PARAM_CONTENT_ID, "ContentIdTest",
FacebookExtension2_PARAM_CURRENCY, "GBP",
FacebookExtension2_PARAM_NUM_ITEMS, 3
);
fb_send_event(FacebookExtension2_EVENT_ADDED_TO_WISHLIST, 10, real(_params));
ds_list_destroy(_params);The code above first creates a DSList and adds the key-value pairs to be used as the parameters to it. It then logs an "Added To Wishlist" event with these parameters, adding 10 to the value to sum for this event.
This function logs a custom app event.
See: App Events
Syntax:
fb_send_event_string(event_name, value_to_sum, event_params)
| Argument | Type | Description |
|---|---|---|
| event_name | FACEBOOK_EVENT_NAME | The name of the event to log |
| value_to_sum | Real | The value to add to the sum for this event |
| event_params | DSList | A DSList of FACEBOOK_EVENT_PARAM. |
Returns:
N/A
Example:
var _params = ds_list_create();
ds_list_add(_params,
FACEBOOK_EVENT_PARAM.CONTENT_ID, "ContentIdTest",
FACEBOOK_EVENT_PARAM.CURRENCY, "GBP",
FACEBOOK_EVENT_PARAM.NUM_ITEMS, 3);
fb_send_event_string(FACEBOOK_EVENT_NAME.ADDED_TO_WISHLIST, 123, real(_params));
ds_list_destroy(_params);The code example above logs an app event. The parameters are added to a temporary DSList, which is destroyed after the call to the function.
This function sets whether to enable automatic logging of app events.
See: Automatic App Event Logging, App Events
Syntax:
fb_set_auto_log_app_events_enabled(on)
| Argument | Type | Description |
|---|---|---|
| on | Boolean | Whether to enable automatic logging of app events |
Returns:
N/A
Example:
fb_set_auto_log_app_events_enabled(false);The code example above disables automatic logging of app events.
This function sets whether to enable or disable the collection of advertiser IDs.
See: Disable Collection of Advertiser IDs
Syntax:
fb_set_advertiser_id_collection_enabled(on)
| Argument | Type | Description |
|---|---|---|
| on | Boolean | Whether to enable the collection of advertiser IDs |
Returns:
N/A
Example:
fb_set_advertiser_id_collection_enabled(false);The code example above disables the collection of advertiser IDs.
Facebook Constants: EVENT_PARAM_*
This set of constants represents the possible event parameter types.
| Member | Description |
|---|---|
FacebookExtension2_PARAM_CONTENT_ID |
Parameter key used to specify an ID for the specific piece of content being logged about. This could be an EAN, article identifier, etc., depending on the nature of the app. |
FacebookExtension2_PARAM_CONTENT_TYPE |
Parameter key used to specify a generic content type/family for the logged event, e.g. "music", "photo", "video". Options to use will vary depending on the nature of the app. |
FacebookExtension2_PARAM_CURRENCY |
Parameter key used to specify currency used with logged event. E.g. "USD", "EUR", "GBP". See ISO-4217 for specific values. |
FacebookExtension2_PARAM_DESCRIPTION |
Parameter key used to specify a description appropriate to the event being logged. E.g., the name of the achievement unlocked in the EVENT_NAME_ACHIEVEMENT_UNLOCKED event. |
FacebookExtension2_PARAM_LEVEL |
Parameter key used to specify the level achieved in an EVENT_NAME_LEVEL_ACHIEVED event. |
FacebookExtension2_PARAM_MAX_RATING_VALUE |
Parameter key used to specify the maximum rating available for the EVENT_NAME_RATE event. E.g., "5" or "10". |
FacebookExtension2_PARAM_NUM_ITEMS |
Parameter key used to specify how many items are being processed for an EVENT_NAME_INITIATED_CHECKOUT or EVENT_NAME_PURCHASE event. |
FacebookExtension2_PARAM_PAYMENT_INFO_AVAILABLE |
Parameter key used to specify whether payment info is available for the EVENT_NAME_INITIATED_CHECKOUT event. EVENT_PARAM_VALUE_YES and EVENT_PARAM_VALUE_NO are good canonical values to use for this parameter. |
FacebookExtension2_PARAM_REGISTRATION_METHOD |
Parameter key used to specify the method the user has used to register for the app, e.g., "Facebook", "email", "Twitter", etc. |
FacebookExtension2_PARAM_SEARCH_STRING |
Parameter key used to specify the string provided by the user for a search operation. |
FacebookExtension2_PARAM_SUCCESS |
Parameter key used to specify whether the activity being logged about was successful or not. EVENT_PARAM_VALUE_YES and EVENT_PARAM_VALUE_NO are good canonical values to use for this parameter. |
Facebook Constants: EVENT_NAME_*
This set of constants represents the possible built-in event names.
These constants are referenced by the following functions:
| Member | Description |
|---|---|
FacebookExtension2_EVENT_ACHIEVED_LEVEL |
Log this event when the user has achieved a level in the app. |
FacebookExtension2_EVENT_ADDED_PAYMENT_INFO |
Log this event when the user has entered their payment info. |
FacebookExtension2_EVENT_ADDED_TO_CART |
Log this event when the user has added an item to their cart. The valueToSum passed to fb_send_event should be the item's price. |
FacebookExtension2_EVENT_ADDED_TO_WISHLIST |
Log this event when the user has added an item to their wishlist. The valueToSum passed to fb_send_event should be the item's price. |
FacebookExtension2_EVENT_COMPLETED_REGISTRATION |
Log this event when the user has completed registration with the app. |
FacebookExtension2_EVENT_COMPLETED_TUTORIAL |
Log this event when the user has completed a tutorial in the app. |
FacebookExtension2_EVENT_INITIATED_CHECKOUT |
Log this event when the user has entered the checkout process. The valueToSum passed to fb_send_event should be the total price in the cart. |
FacebookExtension2_EVENT_RATED |
Log this event when the user has rated an item in the app. The valueToSum passed to fb_send_event should be the numeric rating. |
FacebookExtension2_EVENT_SEARCHED |
Log this event when the user has performed a search within the app. |
FacebookExtension2_EVENT_SPENT_CREDITS |
Log this event when the user has spent app credits. The valueToSum passed to fb_send_event should be the number of credits spent. |
FacebookExtension2_EVENT_UNLOCKED_ACHIEVEMENT |
Log this event when the user has unlocked an achievement in the app. |
FacebookExtension2_EVENT_VIEWED_CONTENT |
Log this event when the user has viewed a form of content in the app. |
Facebook Object: AppEventsConstants
This set of constants represents the possible built-in event names.
These constants are referenced by the following functions:
| Member | Description |
|---|---|
ACTIVATED_APP |
The launch of your app. Takes no event parameters. |
DEACTIVATED_APP |
The app is deactivated. |
SESSION_INTERRUPTIONS |
|
TIME_BETWEEN_SESSIONS |
|
COMPLETED_REGISTRATION |
Log this event when the user has completed registration with the app. Takes event parameters: FACEBOOK_EVENT_PARAM.REGISTRATION_METHOD. |
VIEWED_CONTENT |
Log this event when the user has viewed a form of content in the app. Takes event parameters: FACEBOOK_EVENT_PARAM.CONTENT_TYPE, FACEBOOK_EVENT_PARAM.CONTENT_ID, FACEBOOK_EVENT_PARAM.CONTENT, FACEBOOK_EVENT_PARAM.CURRENCY. |
SEARCHED |
A search performed on your website, app or other property, such as product searches, travel searches, etc. Takes event parameters: FACEBOOK_EVENT_PARAM.CONTENT_TYPE, FACEBOOK_EVENT_PARAM.SEARCH_STRING, FACEBOOK_EVENT_PARAM.SUCCESS. |
RATED |
Log this event when the user has rated an item in the app. The value_to_sum passed to fb_send_event should be the numeric rating. Takes event parameters: FACEBOOK_EVENT_PARAM.CONTENT_TYPE, FACEBOOK_EVENT_PARAM.CONTENT_ID or FACEBOOK_EVENT_PARAM.CONTENT, FACEBOOK_EVENT_PARAM.MAX_RATING_VALUE. |
COMPLETED_TUTORIAL |
Log this event when the user has completed a tutorial in the app. Takes event parameters: FACEBOOK_EVENT_PARAM.SUCCESS, FACEBOOK_EVENT_PARAM.CONTENT_ID or FACEBOOK_EVENT_PARAM.CONTENT. |
ADDED_TO_CART |
Log this event when the user has added an item to their cart. The value_to_sum passed to fb_send_event should be the item's price. Takes event parameters: FACEBOOK_EVENT_PARAM.CONTENT_TYPE, FACEBOOK_EVENT_PARAM.CONTENT_ID or FACEBOOK_EVENT_PARAM.CONTENT and FACEBOOK_EVENT_PARAM.CURRENCY. |
ADDED_TO_WISHLIST |
Log this event when the user has added an item to their wishlist. The value_to_sum passed to fb_send_event should be the item's price. Takes event parameters: FACEBOOK_EVENT_PARAM.CONTENT_TYPE, FACEBOOK_EVENT_PARAM.CONTENT_ID or FACEBOOK_EVENT_PARAM.CONTENT and FACEBOOK_EVENT_PARAM.CURRENCY. |
INITIATED_CHECKOUT |
Log this event when the user has entered the checkout process. The value_to_sum passed to fb_send_event should be the total price in the cart. Takes event parameters: FACEBOOK_EVENT_PARAM.CONTENT_TYPE, FACEBOOK_EVENT_PARAM.CONTENT_ID OR FACEBOOK_EVENT_PARAM.CONTENT, FACEBOOK_EVENT_PARAM.NUM_ITEMS, FACEBOOK_EVENT_PARAM.PAYMENT_INFO_AVAILABLE, FACEBOOK_EVENT_PARAM.CURRENCY. |
ADDED_PAYMENT_INFO |
Log this event when the user has entered their payment info. Takes event parameters: FACEBOOK_EVENT_PARAM.SUCCESS. |
PURCHASED |
[Deprecated] The completion of a purchase, usually signified by receiving order or purchase confirmation or a transaction receipt. Takes event parameters: FACEBOOK_EVENT_PARAM.NUM_ITEMS, FACEBOOK_EVENT_PARAM.CONTENT_TYPE, FACEBOOK_EVENT_PARAM.CONTENT_ID, FACEBOOK_EVENT_PARAM.CONTENT, FACEBOOK_EVENT_PARAM.CURRENCY. |
ACHIEVED_LEVEL |
Log this event when the user has achieved a level in the app. Takes event parameters: FACEBOOK_EVENT_PARAM.LEVEL. |
UNLOCKED_ACHIEVEMENT |
Log this event when the user has unlocked an achievement in the app. Takes event parameters: FACEBOOK_EVENT_PARAM.DESCRIPTION. |
SPENT_CREDITS |
The completion of a transaction where people spend credits specific to your business or application, such as in-app currency. Log this event when the user has spent app credits. The value_to_sum passed to fb_send_event should be the number of credits spent. Takes event parameters: FACEBOOK_EVENT_PARAM.CONTENT_TYPE, FACEBOOK_EVENT_PARAM.CONTENT_ID or FACEBOOK_EVENT_PARAM.CONTENT. |
CONTACT |
A telephone or SMS, email, chat or other type of contact between a customer and your business. |
CUSTOMIZE_PRODUCT |
The customization of products through a configuration tool or other application your business owns. |
DONATE |
The donation of funds to your organization or cause. |
FIND_LOCATION |
When a person finds one of your locations via web or app, with an intention to visit. For example, searching for a product and finding it at one of your local stores. |
SCHEDULE |
The booking of an appointment to visit one of your locations. |
START_TRIAL |
The start of a free trial of a product or service you offer, such as a trial subscription. Takes event parameters: FACEBOOK_EVENT_PARAM.SUBSCRIPTION_ID, FACEBOOK_EVENT_PARAM.CURRENCY. |
SUBMIT_APPLICATION |
The submission of an application for a product, service or program you offer (example: credit card, educational program or job) |
SUBSCRIBE |
The start of a paid subscription for a product or service you offer. Takes event parameters: FACEBOOK_EVENT_PARAM.SUBSCRIPTION_ID, FACEBOOK_EVENT_PARAM.CURRENCY. |
AD_IMPRESSION |
An ad from a third-party platform appears on-screen within your app. If value_to_sum is provided, the event can be used for in-app ads optimization. The value_to_sum value represents the in-app ads revenue generated from a user viewing an ad in your app. Refer to the documentation here to learn about maximizing the value of in-app ad impressions. Takes event parameters: FACEBOOK_EVENT_PARAM.AD_TYPE. |
AD_CLICK |
An ad from a third-party platform is clicked within your app. Takes event parameters: FACEBOOK_EVENT_PARAM.AD_TYPE. |
LIVE_STREAMING_START |
Live streaming event |
LIVE_STREAMING_STOP |
Live streaming event |
LIVE_STREAMING_PAUSE |
Live streaming event |
LIVE_STREAMING_RESUME |
Live streaming event |
LIVE_STREAMING_ERROR |
Live streaming event |
LIVE_STREAMING_UPDATE_STATUS |
Live streaming event |
PRODUCT_CATALOG_UPDATE |
Update of a product catalog item |
Facebook Object: AppEventsConstants
This set of constants represents the possible built-in event parameter types.
| Member | Description |
|---|---|
CURRENCY |
Parameter key used to specify currency used with logged event. E.g. "USD", "EUR", "GBP". See ISO-4217 for specific values. |
REGISTRATION_METHOD |
Parameter key used to specify the method the user has used to register for the app, e.g., "Facebook", "email", "Twitter", etc. |
CONTENT_TYPE |
Parameter key used to specify a generic content type/family for the logged event, e.g. "music", "photo", "video". Options to use will vary depending on the nature of the app. |
CONTENT_ID |
Parameter key used to specify an ID for the specific piece of content being logged about. This could be an EAN, article identifier, etc., depending on the nature of the app. |
SEARCH_STRING |
Parameter key used to specify the string provided by the user for a search operation. |
SUCCESS |
Parameter key used to specify whether the activity being logged about was successful or not. FACEBOOK_EVENT_PARAM.VALUE_YES and FACEBOOK_EVENT_PARAM.VALUE_NO are good canonical values to use for this parameter. |
MAX_RATING_VALUE |
Parameter key used to specify the maximum rating available for the FACEBOOK_EVENT_NAME.RATED event. E.g., "5" or "10". |
PAYMENT_INFO_AVAILABLE |
Parameter key used to specify whether payment info is available for the FACEBOOK_EVENT_NAME.INITIATED_CHECKOUT event. FACEBOOK_EVENT_PARAM.VALUE_YES and FACEBOOK_EVENT_PARAM.VALUE_NO are good canonical values to use for this parameter. |
NUM_ITEMS |
Parameter key used to specify how many items are being processed for a FACEBOOK_EVENT_NAME.INITIATED_CHECKOUT or FACEBOOK_EVENT_NAME.PURCHASED event. |
LEVEL |
Parameter key used to specify the level achieved in a FACEBOOK_EVENT_NAME.LEVEL_ACHIEVED event. |
DESCRIPTION |
Parameter key used to specify a description appropriate to the event being logged. E.g., the name of the achievement unlocked in the FACEBOOK_EVENT_NAME.ACHIEVEMENT_UNLOCKED event. |
SOURCE_APPLICATION |
Parameter key used to specify source application package. |
VALUE_YES |
Yes-valued parameter value to be used with parameter keys that need a Yes/No value |
VALUE_NO |
No-valued parameter value to be used with parameter keys that need a Yes/No value |
LIVE_STREAMING_PREV_STATUS |
Live streaming event parameter |
LIVE_STREAMING_STATUS |
Live streaming event parameter |
LIVE_STREAMING_ERROR |
Live streaming event parameter |
AD_TYPE |
Type of ad: banner, interstitial, rewarded_video, native |
ORDER_ID |
The unique ID for all events within a subscription |
VALUE_TO_SUM |
The value to sum for the event |
PRODUCT_CUSTOM_LABEL_0 |
Parameter key used to specify additional information about item for EVENT_NAME.PRODUCT_CATALOG_UPDATE event |
PRODUCT_CUSTOM_LABEL_1 |
Parameter key used to specify additional information about item for EVENT_NAME.PRODUCT_CATALOG_UPDATE event |
PRODUCT_CUSTOM_LABEL_2 |
Parameter key used to specify additional information about item for EVENT_NAME.PRODUCT_CATALOG_UPDATE event |
PRODUCT_CUSTOM_LABEL_3 |
Parameter key used to specify additional information about item for EVENT_NAME.PRODUCT_CATALOG_UPDATE event |
PRODUCT_CUSTOM_LABEL_4 |
Parameter key used to specify additional information about item for EVENT_NAME.PRODUCT_CATALOG_UPDATE event |
PRODUCT_CATEGORY |
Product category |
PRODUCT_APPLINK_IOS_URL |
App Link event parameter |
PRODUCT_APPLINK_IOS_APP_STORE_ID |
App Link event parameter |
PRODUCT_APPLINK_IOS_APP_NAME |
App Link event parameter |
PRODUCT_APPLINK_IPHONE_URL |
App Link event parameter |
PRODUCT_APPLINK_IPHONE_APP_STORE_ID |
App Link event parameter |
PRODUCT_APPLINK_IPHONE_APP_NAME |
App Link event parameter |
PRODUCT_APPLINK_IPAD_APP_STORE_ID |
App Link event parameter |
PRODUCT_APPLINK_IPAD_APP_NAME |
App Link event parameter |
PRODUCT_APPLINK_ANDROID_URL |
App Link event parameter |
PRODUCT_APPLINK_ANDROID_PACKAGE |
App Link event parameter |
PRODUCT_APPLINK_ANDROID_APP_NAME |
App Link event parameter |
PRODUCT_APPLINK_WINDOWS_PHONE_URL |
App Link event parameter |
PRODUCT_APPLINK_WINDOWS_PHONE_APP_ID |
App Link event parameter |
PRODUCT_APPLINK_WINDOWS_PHONE_APP_NAME |
App Link event parameter |
YoYoGames 2025