个推 (GeTui)

https://docs.getui.com
Admin
GeTui is a mobile intelligent data service platform offering a suite of developer tools for message...
Tokens:170,062
Snippets:1,555
Trust Score:9.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Pre-Login Call Example

Source: https://docs.getui.com/geyan/mobile/ios/elogin

Example of how to call the `preGetToken` method and handle the callback.

```APIDOC
##### Call Example

```objectivec
[GeYanSdk preGetToken:^(NSDictionary *tokenDic) {
    NSLog(@"获取token返回结果：%@", tokenDic);
}];
```
```

--------------------------------

### Initialize and Start SDK

Source: https://docs.getui.com/ido/mobile/ios/init

Initialize the SDK with your App ID and Channel ID. This should be called when your application starts.

```APIDOC
## Initialize and Start SDK

### Description
Use this interface to start the data statistics SDK when the App is running. It should be called before using other statistical functions.

### Method
```objective-c
+ (void)startSDKWithAppId:(NSString *)appId withChannelId:(NSString *)channelId;
```

### Parameters
* **appId** (NSString) - Required - The unique App ID generated from the developer center.
* **channelId** (NSString) - Optional - The channel name. Defaults to 'appstore' if nil or empty.

### Request Example
```objective-c
#import <GTCountSDK/GTCountSDK.h>
#define kGcAppId @"xxxxxxx"

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Start the data statistics SDK
   [GTCountSDK startSDKWithAppId:kGcAppId withChannelId:@"appstore"];
   return YES;
 }
@end
```
```

--------------------------------

### Install Getui SDK via CocoaPods

Source: https://docs.getui.com/geyan/mobile/ios/init

Navigate to your project's root directory in the terminal and run 'pod install' to integrate the SDK. This command installs the dependencies listed in your Podfile.

```bash
$ cd "<path/to/project>"
$ pod install

```

--------------------------------

### Navigate to Project Root and Install Pods

Source: https://docs.getui.com/oneid/mobile/ios/init

After creating the Podfile, navigate to your project's root directory in the terminal and run this command to install the specified pods.

```bash
$ cd "<path/to/project>"
$ pod install
```

--------------------------------

### Successful Initialization Response Example

Source: https://docs.getui.com/geyan/mobile/android/api

Example of a successful initialization response from the SDK, showing the GYResponse object with a success status and a success message.

```java
初始化成功 response:GYResponse{
  gyuid='gtc_ea0a6ae25e99358d9a99bc5ed342893838', 
  success=true, 
  code=30000, 
  operator='', 
  msg='{"errorCode":0,"errorDesc":"gysdk success!","metadata":""}'
}
```

--------------------------------

### Pre-Login Success Response Example

Source: https://docs.getui.com/geyan/mobile/android/api

Example of a successful response from the pre-login operation, indicating the device is ready for one-click login.

```text
预登录成功 response:GYResponse{
  gyuid='gtc_ea0a6ae25e99358d9a99bc5ed342893838', 
  success=true, 
  code=30000, 
  operator='CM', 
  msg='{
    "process_id":"1b094917c1d34bef3475e61e60d652e2",
    "operatorType":"1",
    "clienttype":"1",
    "number":"135****9774",
    "expiredTime":1631515911017,
    "errorCode":0,
    "errorDesc":"gysdk success!"
  }'
}
```

--------------------------------

### Initialize and Start SDK

Source: https://docs.getui.com/ido/mobile/miniProgram/api

This interface is used to start the SDK for data statistics. It should be called when the App launches.

```APIDOC
## Initialize and Start SDK

### Description
Used to start the SDK for data statistics. This interface should be called when the App launches.

### Method Signature
```typescript
function init(appInfo: {
    gsAppid: string;
}): void;
```

### Parameters
#### Request Body
- **gsAppid** (string) - Required - Application identifier APPID

### Request Example
```javascript
import GsIdo from './lib/gsido-${platform}.js'
import GTC from './lib/gtc-${platform}.js'
App({
    globalData: {},
    onLaunch: function () {
        // Open/close debug mode, in debug mode the sdk will print running logs in the console
        // GsIdo.setDebugEnable(true)

        // Initialize the statistics sdk
        GsIdo.init({
            // Statistics sdk appid
            gsAppid: 'xXmjbbab3b5F1m7wAYZoG2'
        });
        console.log(GsIdo.getVersion())
    },
});
```
```

--------------------------------

### Get Verify Token Call Example

Source: https://docs.getui.com/geyan/mobile/harmonyos/api

Demonstrates how to call the getVerifyToken method and log the response. Handles both success and failure cases.

```typescript
const response = await GyManager.getInstance().getVerifyToken(phone, 5000);
if (response.isSuccess()) {
    hilog.info(0x0000, "GY", `getVerifyToken success ==>${response}`)
} else {
    hilog.info(0x0000, "GY", `getVerifyToken failed==>${response}`)
}
```

--------------------------------

### Initialize and Start SDK

Source: https://docs.getui.com/ido/mobile/ios/api

This interface is required to start the data statistics SDK before using any statistical functions. It should be called when the App starts.

```APIDOC
## Initialize and Start SDK

### Description
Use the statistics function before starting the SDK, this interface is used to start the data statistics SDK when the App is running.

### Method Signature
```objective-c
+ (void)startSDKWithAppId:(NSString *)appId withChannelId:(NSString *)channelId delegate:(id<GTCountSDKDelegate>)delegate;
```

### Parameters
#### Path Parameters
- **appId** (NSString) - Required - The unique identifier for the application generated by the developer console.
- **channelId** (NSString) - Optional - The channel name. Defaults to 'appstore' if nil or empty.
- **delegate** (id<GTCountSDKDelegate>) - Required - The delegate for SDK callback events.

### Request Example
```objective-c
#import <GTCountSDK/GTCountSDK.h>
#define kGcAppId @"xxxxxxx"

@interface AppDelegate<GTCountSDKDelegate>
@end

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
   // Start the data statistics SDK
   [GTCountSDK startSDKWithAppId:kGcAppId withChannelId:@"appstore" delegate:self];
   return YES;
 }

// SDK delegate callback to get Gtcid
- (void)GTCountSDKDidReceiveGtcid:(NSString *)gtcid error:(NSError *)error {
    NSLog(@"GTCountSDKDidReceiveGtcid gtcid:%@ error:%@", gtcid, error);
}
@end
```

### Response
#### Success Response
This method does not return a value directly, but the delegate method `GTCountSDKDidReceiveGtcid:error:` will be called upon successful initialization or failure.
```

--------------------------------

### Pre-Login Call Example

Source: https://docs.getui.com/geyan/mobile/ios/elogin

Example of calling the preGetToken method and logging the result. The callback provides a dictionary containing the token acquisition status and related information.

```Objective-C
[GeYanSdk preGetToken:^(NSDictionary *tokenDic) {
    NSLog(@"获取token返回结果：%@", tokenDic);
}];
```

--------------------------------

### Pre-login Success Response Example

Source: https://docs.getui.com/geyan/mobile/harmonyos/api

Example of a successful response from the pre-login operation, including cost time, GYUID, operator, and detailed data.

```json
{
    "costTime": 862,
    "gyuid": "gtc_eafb4e7ddbfe059a3eaebde0c6ef858030",
    "code": 30000,
    "operator": "CT",
    "data": {
        "errorCode": 0,
        "errorDesc": "gysdk success!",
        "operatorType": 3,
        "processId": "000a9b675ceeb997f425291687213b8a",
        "expiredTime": 1731489627313,
        "number": "191****1003"
    },
    "success": true
}
```

--------------------------------

### Example: Implementing AuthPageListener

Source: https://docs.getui.com/geyan/mobile/android/elogin

An example of how to implement the AuthPageListener to handle various callbacks from the one-key login page.

```java
//添加一键登录页面回调
        GYManager.getInstance().setAuthPageListener(new AuthPageListener() {
            @Override
            public void onPrivacyClick(String s, String s1) {
                Log.d(TAG, "隐私条款点击回调:" + s + ":" + s1);
            }

            @Override
            public void onPrivacyCheckBoxClick(boolean b) {
                Log.d(TAG, "隐私条款复选框点击回调:" + b);
            }

            @Override
            public void onLoginButtonClick() {
                Log.d(TAG, "一键登录按钮点击回调");
            }

            @Override
            public void onAuthActivityCreate(Activity activity) {
                Log.d(TAG, "授权页面启动回调");
            }

            @Override
            public void onAuthWebActivityCreate(Activity activity) {
                Log.d(TAG, "隐私条款页面启动回调");
            }
        });
```

--------------------------------

### Pre-Login Failure Response Example

Source: https://docs.getui.com/geyan/mobile/android/api

Example of a failed response from the pre-login operation, providing details on the error for troubleshooting.

```text
预登录失败 response:GYResponse{
  gyuid='gtc_ea0a6ae25e99358d9a99bc5ed342893838', 
  success=false, 
  code=30005, 
  operator='', 
  msg='{
    "errno":0,
    "data":{"msg":"应用无效，应用不存在","result":"40004"},
    "errorCode":-20102,
    "errorDesc":"gysdk appid或者签名无效!"
  }'
}
```

--------------------------------

### Initialize and Start SDK

Source: https://docs.getui.com/ido/mobile/ios/init

Call this method in your AppDelegate's didFinishLaunchingWithOptions to start the data statistics SDK. Ensure you use the APPID provided by the developer center. The channelId defaults to 'appstore' if nil or empty.

```objective-c
#import <GTCountSDK/GTCountSDK.h>
#define kGcAppId @"xxxxxxx"

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // 启动数据统计 SDK
   [GTCountSDK startSDKWithAppId:kGcAppId withChannelId:@"appstore"];
   return YES;
 }
```

--------------------------------

### Response Body Example

Source: https://docs.getui.com/ido/server/user

Example of a successful response when querying single file data. Includes a list of IDs and the total count.

```json
{
  "data": {
    "list": [
      "gtcid1",
      "gtcid2"
    ],
    "total": 1000000
  },
  "code": "0",
  "msg": "成功"
}
```

--------------------------------

### Example Debug Log Output

Source: https://docs.getui.com/getui/mobile/android/androidstudio

This is an example of the logcat output you might see when the Getui SDK initializes successfully. Look for 'Login successed with cid = xxx' to confirm.

```log
[GT-PUSH] [PushManager]Start initializing sdk
    [GT-PUSH] [PushManager]start pushService = com.getui.demo.DemoPushServiceNew
    [GT-PUSH] [LOG-LogController] Sdk version = 3.0.1.0
    [GT-PUSH] [PushManager]call registerPushIntentService
    [GT-PUSH] onHandleIntent() = get sdk service pid 
    [GT-PUSH] ServiceManager start from initialize...
    [GT-PUSH] Start login appid = TI85ilD*******L89MFNV appkey = 1qNlp*******BP9COgYjA
    [GT-PUSH] Login successed with cid = e3f004e873f9a5d9e2e006c4a9ca2f5f
    [GT-PUSH] onHandleIntent() = received client id 
```

--------------------------------

### Failed Initialization Response Example

Source: https://docs.getui.com/geyan/mobile/android/api

Example of a failed initialization response from the SDK, illustrating a common error like an empty app ID, with details in the GYResponse object.

```java
初始化失败 response:GYResponse{
  gyuid='', 
  success=false, 
  code=30004, 
  operator='', 
  msg='{"errorCode":-20101,"errorDesc":"gysdk appid为空!","metadata":""}'
}
```

--------------------------------

### Pre-login Success Response Example

Source: https://docs.getui.com/geyan/mobile/android/elogin

Example of a successful pre-login response object, including user ID, success status, status code, and detailed message.

```json
{
    gyuid='1f4b078f06ad4867b641f1976a172f1232', 
    success=true,
    code=30000,
    msg='{"msg":"103000","process_id":"bd9304d883149fd24e345ee9b1deb86f","operatorType":"CM","clienttype":1,"accessCode":"","number":"187****7325","expireTime":1574235119343}'
}
```

--------------------------------

### Initialize and Start iOS Data Statistics SDK

Source: https://docs.getui.com/ido/mobile/ios/api

Use this method to start the data statistics SDK when your application launches. Ensure you provide the correct appId and optionally a channelId. The delegate will receive callbacks for SDK events.

```objective-c
/**
 初始化启动接口 

 @param appId 开发者后台生成的 appId
 @param channelId 渠道名称，默认为 'appstore'
 @param delegate delegate
 */
+ (void)startSDKWithAppId:(NSString *)appId withChannelId:(NSString *)channelId delegate:(id<GTCountSDKDelegate>)delegate;
```

```objective-c
#import <GTCountSDK/GTCountSDK.h>
#define kGcAppId @"xxxxxxx"
@interface AppDelegate<GTCountSDKDelegate>
@end

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
   // 启动数据统计 SDK
   [GTCountSDK startSDKWithAppId:kGcAppId withChannelId:@"appstore" delegate:self];
   return YES;
 }

//SDK代理回调，获取Gtcid
- (void)GTCountSDKDidReceiveGtcid:(NSString *)gtcid error:(NSError *)error {
    NSLog(@"GTCountSDKDidReceiveGtcid gtcid:%@ error:%@", gtcid, error);
}

```

--------------------------------

### Initialize and Configure Getui SDK

Source: https://docs.getui.com/ido/mobile/android/sample

Enable debug mode, set the installation channel, and set up a callback for GtcId retrieval. Call preInit at your application's entry point. Ensure user consent to the privacy policy before calling initialization and registration methods.

```java
GsConfig.setDebugEnable(true);
GsConfig.setInstallChannel(channel);
GsManager.getInstance().setGtcIdCallback(new IGtcIdCallback() {
@Override
public void onGetGtcId(String gtcId) {
        Log.d(TAG, "onGetGtcId: " + gtcId);
    }
});
GsManager.getInstance().preInit(context);
```

--------------------------------

### H5 One-Click Authentication Get Phone Number Request Example

Source: https://docs.getui.com/geyan/server

This is an example of a request payload for the H5 one-click authentication API to obtain a phone number. The token is a credential from the SDK.

```json
{
    "appId": "LLNstWgyGm8UM2SsherlU5",
    "timestamp": 1529391652123,
    "gyuid":"12313ssad",
    "token": ""
}
```

--------------------------------

### APP One-Click Authentication Get Phone Number Response Example

Source: https://docs.getui.com/geyan/server

This is an example of a successful response from the APP one-click authentication API when retrieving a phone number. The phone number is AES encrypted.

```json
{
    "errno": "0",
    "data": {
        "result": "20000",
        "msg": "成功",
        "data": {
            "pn": "1fbf2605f954fad3ba18115000735aee"
        }
    }
}
```

--------------------------------

### Configure and Initialize Getui SDK

Source: https://docs.getui.com/geyan/mobile/android/api

Demonstrates building GyConfig with options for pre-login cache, debug modes, channel, and a callback for success or failure.

```java
GYManager.getInstance().init(GyConfig.with(this.getApplicationContext())
                //预取号使用缓存，可以提高预取号的成功率，建议设置为true
                .preLoginUseCache(true)
                //个验debug调试模式
                .debug(BuildConfig.DEBUG)
                //运营商debug调试模式
                .eLoginDebug(BuildConfig.DEBUG)
                //应用渠道
                .channel("xxxxxx")
                //成功失败回调
                .callBack(new GyCallBack() {
                    @Override
                    public void onSuccess(GYResponse response) {
                        Log.d(TAG, "初始化成功 response:" + response);
                    }

                    @Override
                    public void onFailed(GYResponse response) {
                        Log.e(TAG, "初始化失败 response:" + response);
                    }
                }).build());
```

--------------------------------

### APP One-Click Authentication Get Phone Number Request Example

Source: https://docs.getui.com/geyan/server

This is an example of a request payload for the APP one-click authentication API to obtain a phone number. Ensure the token is valid and the IP is whitelisted.

```json
{
    "appId": "LLNstWgyGm8UM2SsherlU5",
    "timestamp": 1529391652123,
    "gyuid":"12313ssad",
    "sign": "8f8ef776b7364c96fc1a7e734976e32b6a5e297a1ddbaea31bf3deab517d1",
    "token": ""
}
```

--------------------------------

### Initialize Getui SDK (Pre-init)

Source: https://docs.getui.com/geyan/mobile/android/init?id=4

Call preInit in your Application.onCreate() after the user has agreed to the privacy policy. This step prepares the SDK but does not enable its features or generate a GYUID.

```java
GYManager.getInstance().preInit(this.getApplicationContext());
```

--------------------------------

### Get Gtcid

Source: https://docs.getui.com/ido/mobile/miniProgram/api

Retrieves the Gtcid, which can be used for querying user portrait tags. This function should be called after the SDK has started.

```typescript
/*
     * gtcid可用于用户画像标签的查询,需要在sdk启动后调用
     */
    function gtcid(): string;
```

--------------------------------

### SDK Initialization

Source: https://docs.getui.com/ido/mobile/android/sample

Initialize the Getui SDK and set up necessary configurations. It's recommended to enable debug mode for development and set the installation channel. A callback is provided to receive the GtcId.

```APIDOC
## Initialization
> To ensure user operation functions can be used normally, you must ensure the user agrees to the "Privacy Policy" before calling the initialization and registration gtcid methods. If the registration gtcid method is not called, user operation functions cannot be used normally.
```java
// Default switch is off, you can turn on developer mode with the following code, which will output SDK related logs in this mode
GsConfig.setDebugEnable(true);
// Set channel
GsConfig.setInstallChannel(channel);
// Set gtcid callback
GsManager.getInstance().setGtcIdCallback(new IGtcIdCallback() {
@Override
public void onGetGtcId(String gtcId) {
        Log.d(TAG, "onGetGtcId: " + gtcId);
    }
});
// Call the SDK's initialization code at your application's startup entry
GsManager.getInstance().preInit(context);
```
```

--------------------------------

### Python AES Decryption Algorithm Example

Source: https://docs.getui.com/geyan/server

Shows AES decryption in Python using the pycryptodome library. It requires installation via `pip3 install pycryptodome`. The key is padded to 16 characters, and a 16-byte zero IV is used.

```python
# pip3 install pycryptodome
from Crypto.Cipher import AES
from Crypto.Util.Padding import unpad

def decrypt(content, secret):
    # 参数设置
    iv = b'0' * 16

    # 取16位密钥
    key = secret
    while len(key) < 16:
        key += secret
    key = key[0:16]

    # 解密
    cipher = AES.new(key.encode(), AES.MODE_CBC, iv)
    result = unpad(cipher.decrypt(bytes.fromhex(content)), 16)
    return result.decode()

if __name__ == '__main__':
    pn = '1fbf2605f954fad3ba18115000735aee'    # 密文
    master_secret = '126781'                   # 密钥
    print(decrypt(pn, master_secret))
```

--------------------------------

### Initialize Getui SDK

Source: https://docs.getui.com/ido/mobile/android/api

Call preInit to initialize the SDK. This reads configuration parameters but does not start the user operation service or generate a gtcid.

```java
GsManager.getInstance().preInit(context);
```

--------------------------------

### Initialize SDK (preInit)

Source: https://docs.getui.com/geyan/mobile/android/api

Initializes the Getui SDK. This should be called in Application.onCreate() after the user has agreed to the privacy policy. It reads configuration parameters but does not start the one-click authentication service or generate a GYUID.

```APIDOC
## 2. Initialize SDK

### Description
Suggest initializing the gysdk in Application.onCreate() after the user has agreed to the privacy policy. It reads configuration parameters, at which point the one-click authentication service is not yet started, GYUID is not generated, and the one-click authentication function is not enabled.

### Method Signature
```java
/**
 * Initializes the SDK interface.
 * @param context The application context.
 */
public void preInit(Context context)
```

### Usage Example
```java
GYManager.getInstance().preInit(this.getApplicationContext());
```
```

--------------------------------

### Export Today's User Statistics (Response Body)

Source: https://docs.getui.com/ido/server/statistics

This is a sample successful response for the export/todayStatistics API. It includes data on total, Android, and iOS platform statistics for installs, active users, and starts, along with percentage changes.

```json
{
  "data": {
    "list": [
      {
        "dimension": "total",
        "statisticsData": {
          "install": {
            "cnt": 156902,
            "ytdPercent": "11.11",
            "sevenPercent": "11.12"
          },
          "active": {
            "cnt": 89891,
            "sevenPercent": "22.11",
            "ytdPercent": "-22.22"
          },
          "start": {
            "cnt": 988,
            "sevenPercent": "-22.1",
            "ytdPercent": "34.5"
          }
        }
      }
    ]
  },
  "code": 0,
  "msg": "成功"
}
```

--------------------------------

### Initialize Getui SDK

Source: https://docs.getui.com/getui/mobile/android/androidstudio

Use this recommended interface to initialize the Getui SDK. It simplifies the setup by automatically finding the necessary PushService and GTIntentService.

```java
PushManager.getInstance().initialize(Context context)
```

--------------------------------

### Initialize SDK

Source: https://docs.getui.com/ido/mobile/android/api

Initializes the SDK. This step reads configuration parameters but does not start the user operation service or generate a gtcid.

```APIDOC
## Initialize SDK

### Class
`com.getui.gs.sdk.GsManager`

### Method
`public void preInit(Context context)`

### Description
Initializes the SDK and reads configuration parameters. The user operation service is not started at this point, and a gtcid is not generated.

### Parameters
* `context` (Context) - The application's ApplicationContext.
```

--------------------------------

### 初始化 SDK (AppLaunch)

Source: https://docs.getui.com/ido/mobile/miniProgram/init

在应用启动时调用 GSIDO SDK 的初始化方法。适用于微信、支付宝、抖音、Uni 小程序等平台。

```javascript
import GsIdo from './lib/gsido-${platform}.js'
import GTC from './lib/gtc-${platform}.js'
App({
    globalData: {},
    onLaunch: function () {

        //打开/关闭调试模式,调试模式下sdk将会在控制台打印运行日志
        //GsIdo.setDebugEnable(true)

        //初始化统计sdk
        GsIdo.init({
            //统计sdk appid
            gsAppid: 'xXmjbbab3b5F1m7wAYZoG2'
        });
        console.log(GsIdo.getVersion())
    },
});
```

--------------------------------

### Pre-Login Callback Definition and Example

Source: https://docs.getui.com/geyan/mobile/ios/elogin

Defines the `GyVerifyCallback` type and provides an example of the returned dictionary structure and its fields.

```APIDOC
##### Return Example

Verification token will be returned via `GyVerifyCallback`.

GyVerifyCallback:
```objectivec
typedef void (^GyVerifyCallback)(NSDictionary *verifyDictionary);
```

`verifyDictionary` return example and description:
```json
{
    "code": 30000, // NSNumber, non-30000 is a failure status code
    "processID": "47dab9b7c26629cd9bc117f88e2f9233", // NSString, transaction ID
    "operatorType": "4", // NSString, operation type
    "errorCode": "-30003", // NSString, carrier error code
    "msg": "\U83b7\U53d6accessCode\U6210\U529f", // NSString, carrier returned message
    "metadata": {{}} // NSDictionary, carrier response content when failed.
}
```
```

--------------------------------

### Execute Pre-login

Source: https://docs.getui.com/geyan/mobile/android/elogin

Example of how to initiate a pre-login request with a specified timeout and handle the asynchronous response via a callback.

```java
 GYManager.getInstance().ePreLogin(5000, new GyCallBack() {
            @Override
            public void onSuccess(GYResponse response) {
                showToast("预登录成功");
                Log.d(TAG, "response:" + response);
            }

            @Override
            public void onFailed(GYResponse response) {
                showToast("预登录失败:" + response);
            }
        });
```

--------------------------------

### Application Initialization

Source: https://docs.getui.com/geyan/mobile/android/initold

Example of initializing the GY SDK within the Application class.

```APIDOC
## Application Initialization

### Description
Initializes the GY SDK within your application's context. Ensure this is called after registering the broadcast receiver.

### Code Example
```java
// Ensure you call init after registering the broadcast receiver to prevent issues receiving broadcast messages.
GYManager.getInstance().init(this.getApplicationContext());
```
```

--------------------------------

### Authentication API Request Example

Source: https://docs.getui.com/sms/interface

JSON example for the authentication API request. This includes appId, timestamp, and the generated sign.

```json
{
    "appId": "xxxxxx",
    "timestamp": "1234567890000",
    "sign": "xxxxxx"
}
```

--------------------------------

### Request Body Example

Source: https://docs.getui.com/ido/server/user

Example of the JSON body to send for querying single file data. Includes crowdId, taskId, and fileId.

```json
{
  "crowdId": "CROWD_yyyy-MM-dd_XXX",
  "taskId": 1001,
  "fileId": "9e385078-8210-4ebc-a4fe-e8edde2476eb"
}
```

--------------------------------

### Android Project Structure Example

Source: https://docs.getui.com/getui/mobile/android/androidstudio

This illustrates the typical directory structure for an Android project when integrating the Getui SDK.

```text
Getui_SDK_Demo_AS_official/
    |- app/ （项目主模块）
    |    |- libs/ （第三方库）
    |    |- src/ （代码目录）
    |    |- build.gradle （模块级 gradle 文件）
    |- gradle/
    |- build.gradle （顶层 gradle 文件）
    |- settings.gradle
    | ......
```

--------------------------------

### User ID Data Examples (oaid)

Source: https://docs.getui.com/ido/server/common_args?id=doc-title-1

Provides examples of oaid formats: 36-bit, 16-bit, and 64-bit. These are unique identifiers for devices.

```text
## 36位
0000aa11-11aa-1a11-a111-01aaaaaaaa11
## 16位
00010111a1a0aaaa
## 64位
00011A111E11111A1A011111A1111111111111a11b11aa111bcd11a1a1fa1111
```

--------------------------------

### Exported Privacy Report Example

Source: https://docs.getui.com/geyan/mobile/ios/privacyManifest

An example of an exported privacy report PDF file name after archiving the app with the correct configuration.

```text
4 导出GtSdkDemo-PrivacyReport 2024-01-16 10-07-15.pdf：
```

--------------------------------

### Initialize SDK with GyConfig

Source: https://docs.getui.com/geyan/mobile/harmonyos/api

Initialize the SDK in EntryAbility.onCreate() after user consent. Pass configuration parameters and register the GYUID. The AppID set here has higher priority than the one in module.json5.

```typescript
const response = await GyManager.getInstance().init(new GyConfig(getContext())
    .setDebug(false)
    .setAppid("个推平台的appid")
    .setPreLoginUseCache(true)
    .setChannel("huawei"))
```

--------------------------------

### Authentication API Response Example

Source: https://docs.getui.com/sms/interface

JSON example of a successful response from the authentication API. It contains the authToken required for subsequent API calls.

```json
{
    "result": "20000",
    "msg": "success",
    "data": {
        "authToken": "xxxxxxxxxxx"
    }
}
```

--------------------------------

### 1 初始化启动接口

Source: https://docs.getui.com/aisdk/mobile/h5_mp/api

Initializes the SDK. This function must be called before any other SDK functions. It takes an object with appId, onSuccess, and onFailure callbacks.

```APIDOC
## 1 初始化启动接口

### Description
启动 SDK

### Method
```javascript
function init(obj: {
        appId: string,
        onSuccess: (res: any) => void,
        onFailure: (res: any) => void
    }): void;
```

### Parameters
#### Path Parameters
- **appId** (string) - Required - 应用标识 APPID
- **userId** (string) - Optional - 开发者用户体系下的userId
- **onSuccess** (function) - Required - 初始化成功回调
- **onFailure** (function) - Required - 初始化失败回调

### Request Example
```javascript
import AISDK from './lib/aisdk-${platform}.js'
import GTC from './lib/gtc-${platform}.js'
App({
    globalData: {},
    onLaunch: function () {

       AISDK.init({
            appId: DEFAULT_APP_ID,
            userId: "",
            onSuccess: function (res) {
                const text = '初始化成功：' + stringify(res)
                console.log(text)
            },
            onFailure: function (err) {
            /*
            onFailure中的错误码说明：
            -10002：相同 `userId` 重复初始化 ， 避免对同一 `userId` 重复调用 `AISDK.init` 
            -30001：网络错误
            -50001：userid 不合法， 要求userid长度<100
            */
                const text = '初始化失败：' + stringify(err)
                console.error(text)
            }
        })

        console.log(AISDK.getVersion())
    },
});
```
```

--------------------------------

### User ID Data Example (imei)

Source: https://docs.getui.com/ido/server/common_args?id=doc-title-1

An example of an imei (International Mobile Equipment Identity) format, a unique identifier for mobile devices.

```text
000001A11111111
```

--------------------------------

### 在 oh-package.json5 中添加个推 SDK 依赖

Source: https://docs.getui.com/ido/mobile/harmonyos/init

在 entry 模块下的 oh-package.json5 文件中添加 '@getui/ido' 依赖，以引入个推用户运营 SDK。

```json
{
  "dependencies": {
    "@getui/ido": "x.x.x"//填写对应版本号，如："@getui/ido": "1.0.1"
  }

}
```

--------------------------------

### User ID Data Example (idfa)

Source: https://docs.getui.com/ido/server/common_args?id=doc-title-1

An example of an idfa (Identifier for Advertisers) format, used for tracking user activity across apps.

```text
00011111-AA11-1CB1-AA11-A11A1111AAAA
```

--------------------------------

### Configure AndResGuard WhiteList for Command Line

Source: https://docs.getui.com/getui/mobile/android/androidstudio

For command-line AndResGuard usage, add Getui SDK resources to the `config.xml` file within the `<issue id="whitelist">` node. Replace `<your_package_name>` with your actual package name.

```xml
<issue id="whitelist" isactive="true">
    <path value="<your_package_name>.R.drawable.push"/>
    <path value="<your_package_name>.R.drawable.push_small"/>
    <!-- 若您需要使用其他自定义推送图标，也需要在此处添加，此处的 R.drawable.push，R.drawable.push_small 应为您当前放置的推送图标。 -->
</issue>
```

--------------------------------

### Pre-login Failure Response Example

Source: https://docs.getui.com/geyan/mobile/android/elogin

Example of a failed pre-login response object, showing failure status, error code, and a detailed error message.

```json
{
    gyuid='1f4b078f06ad4867b641f1976a172f1232', 
    success=false, 
    code=30005, 
    msg='{"errorCode":"-40301","process_id":"6684c251a45717e57105af385649d5f4","metadata":{"msg":"timestamp-out-of-date","result":-10009},"operatorType":"CT","clienttype":"1","msg":"-10009"}',
}
```

--------------------------------

### Initialize GeYan SDK

Source: https://docs.getui.com/geyan/mobile/ios/init?id=5

Initialize the GeYan SDK in `AppDelegate didFinishLaunchingWithOptions`. Set pre-login and login timeouts, and start the SDK with your App ID. Pre-login is initiated to reduce subsequent user wait times.

```objective-c
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    //超时设置，建议为8s以上，至少5s以上;
    [GeYanSdk setPreLoginTimeout:10]; //预登录超时时长
    [GeYanSdk setEloginTimeout:10];   //登录超时时长

    //初始化
    [GeYanSdk startWithAppId:APPID
                withCallback:^(BOOL isSuccess, NSError *error, NSString *gtcid) {
        NSLog(@"GeYanSdk startWithAppId gtcid:%@", gtcid);
    }];

    //提前进行预登录，以便节省后续用户的等待时间;
    [GeYanSdk preGetToken:^(NSDictionary *preDic) {
      NSLog(@"preGetToken:%@", preDic);
    }];
    return YES;
}
```
Tokens:
Raw