3. Script Language > AI - Artificial Intelligence Commands > AIG. - Google AI > 5. Configuration User, File & Clipboard > AIG.SetUser

AIG.SetUser

Previous Top Next

MiniRobotLanguage (MRL)

AIG.SetUser
Set an Optional User Identifier

Intention

Associate an arbitrary user identifier string with API requests. This is an optional parameter that can be sent to the Google API for potential logging, tracking, or abuse monitoring purposes.

What is the SetUser Command?

This Command sets the AIG_User global variable with the provided string.

If you provide an empty string ("") or omit the parameter, the user identifier is reset to the default (empty string), and no user identifier will be sent.

Why Do You Need It?

Use this Command to:

�Identify Users: Associate requests with specific users in your application for logging or analysis.

�Abuse Monitoring: Provide Google with an identifier to help track usage patterns.

How to Use

Provide the desired user identifier string as parameter P1. Use an empty string to clear it.

Example Usage

// Set a user ID

AIG.SetUser|User1234

DBP. User identifier set.

// Clear the user ID (reset to default)

AIG.SetUser|""

DBP. User identifier cleared.

Syntax

AIG.SetUser|P1

AIG.sus|P1

Parameter Explanation

P1 - (Optional) A string representing the user identifier.
� �- If an empty string (`""`) is provided or the parameter is omitted, the user ID is cleared.

Remarks

- The exact usage of this identifier by Google is subject to their API terms and policies.

- Use AIG.GetUser to retrieve the currently configured user ID.

See also:

? AIG.GetUser