# 游戏与原生交互文档 **Repository Path**: zisuyiyi/GameDoc ## Basic Information - **Project Name**: 游戏与原生交互文档 - **Description**: 游戏与原生交互文档 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-12-14 - **Last Updated**: 2026-09-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # ## 1.交互固定格式说明 所有信息传递皆以json格式字符串交互 示例： ```json { "code":0, "type":"USER_INFO", "message":"SUCCESS", "json":"{\"name\":\"userName\"}" } ``` type（必需）：标识此次数据传递的类型 code（必须）：标识是否成功，0或者不传标识成功，其他失败 message（非必）：null或者“SUCCESS”表示成功，失败：显示错误描述 json（非必）：json格式字符串，传递的额外数据，比如用户信息 ## 2.直接发起HTTP请求 type：**TYPE_HTTP_API** 游戏TO原生 ```json { "code":0, "json":"{"api":"/api/v2/user/","method":"post","params":"{\"id\":\"112549185697687926102\",\"name\":\"zhiyi xie\",\"thumb\":\"https://lh6.googleusercontent.com/-hz4FBPJ2jio/AAAAAAAAAAI/AAAAAAAAAAA/AMZuucmVbHRH7MSI0JjcEvFOK9U0wp667Q/s96-c/photo.jpg\",\"token\":\"eyJhbGciOiJSUzI1NiIsImtpZCI6ImUxOTdiZjJlODdiZDE5MDU1NzVmOWI2ZTVlYjQyNmVkYTVkNTc0ZTMiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiIyMTEyNjEwOTE3MzEtc3VoNzdtaDgyaG1xYm0zaDlqbGFyajVuNXRncDNtZzAuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiIyMTEyNjEwOTE3MzEtb2VlNHFjZnI0YzRkbmJ1MGNxN2twMmhhOGw2OXE2M3UuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMTI1NDkxODU2OTc2ODc5MjYxMDIiLCJlbWFpbCI6InhpbmNoYW9uZW5nMjAyMEBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6InpoaXlpIHhpZSIsInBpY3R1cmUiOiJodHRwczovL2xoNi5nb29nbGV1c2VyY29udGVudC5jb20vLWh6NEZCUEoyamlvL0FBQUFBQUFBQUFJL0FBQUFBQUFBQUFBL0FNWnV1Y21WYkhSSDdNU0kwSmpjRXZGT0s5VTB3cDY2N1Evczk2LWMvcGhvdG8uanBnIiwiZ2l2ZW5fbmFtZSI6InpoaXlpIiwiZmFtaWx5X25hbWUiOiJ4aWUiLCJsb2NhbGUiOiJlbiIsImlhdCI6MTYwNzkxMzI2NywiZXhwIjoxNjA3OTE2ODY3fQ.b4KCX3Y4QDtVoSLH5tfs6O93_wzQW4N-yTl7e6INoqOBwmqUeKWUPRWAVMz0yeU2QnjsGS29iOM-29qkhHg0PGInEdqVhdMvGmZYqhYe1-QE9XlavHeoHZleuagc4gDNi-NSbmp33SloTbbVtlTZjo0_lbpn9UIrFcf5suD-46ipM3O--lBZCC9-vvq1EbPMPSgB_oyfzmMvvMd1qG9TcqJnGupHBQGyJ4Y7xiWCWtOxCI9q5m8IlIzWxzFbCOY2zen4qk9jUy7ZC1wiStsGpwX1gvVZsJCt5M6hThkHHFYCih9BIhmARHXrQ9UyWYwtbgJYbmkD22KR6hnNityJdQ\",\"type\":\"google\"}"}", "type":"TYPE_HTTP_API" } json：json格式字符串 { "api":"/api/v2/user/", "method":"post", "params":"{"id":"112549185697687926102","name":"zhiyi xie","thumb":"https://lh6.googleusercontent.com/-hz4FBPJ2jio/AAAAAAAAAAI/AAAAAAAAAAA/AMZuucmVbHRH7MSI0JjcEvFOK9U0wp667Q/s96-c/photo.jpg","token":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImUxOTdiZjJlODdiZDE5MDU1NzVmOWI2ZTVlYjQyNmVkYTVkNTc0ZTMiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiIyMTEyNjEwOTE3MzEtc3VoNzdtaDgyaG1xYm0zaDlqbGFyajVuNXRncDNtZzAuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiIyMTEyNjEwOTE3MzEtb2VlNHFjZnI0YzRkbmJ1MGNxN2twMmhhOGw2OXE2M3UuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMTI1NDkxODU2OTc2ODc5MjYxMDIiLCJlbWFpbCI6InhpbmNoYW9uZW5nMjAyMEBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6InpoaXlpIHhpZSIsInBpY3R1cmUiOiJodHRwczovL2xoNi5nb29nbGV1c2VyY29udGVudC5jb20vLWh6NEZCUEoyamlvL0FBQUFBQUFBQUFJL0FBQUFBQUFBQUFBL0FNWnV1Y21WYkhSSDdNU0kwSmpjRXZGT0s5VTB3cDY2N1Evczk2LWMvcGhvdG8uanBnIiwiZ2l2ZW5fbmFtZSI6InpoaXlpIiwiZmFtaWx5X25hbWUiOiJ4aWUiLCJsb2NhbGUiOiJlbiIsImlhdCI6MTYwNzkxMzI2NywiZXhwIjoxNjA3OTE2ODY3fQ.b4KCX3Y4QDtVoSLH5tfs6O93_wzQW4N-yTl7e6INoqOBwmqUeKWUPRWAVMz0yeU2QnjsGS29iOM-29qkhHg0PGInEdqVhdMvGmZYqhYe1-QE9XlavHeoHZleuagc4gDNi-NSbmp33SloTbbVtlTZjo0_lbpn9UIrFcf5suD-46ipM3O--lBZCC9-vvq1EbPMPSgB_oyfzmMvvMd1qG9TcqJnGupHBQGyJ4Y7xiWCWtOxCI9q5m8IlIzWxzFbCOY2zen4qk9jUy7ZC1wiStsGpwX1gvVZsJCt5M6hThkHHFYCih9BIhmARHXrQ9UyWYwtbgJYbmkD22KR6hnNityJdQ","type":"google"}" } params:json格式字符串 { "id":"112549185697687926102", "name":"zhiyi xie", "thumb":"https://lh6.googleusercontent.com/-hz4FBPJ2jio/AAAAAAAAAAI/AAAAAAAAAAA/AMZuucmVbHRH7MSI0JjcEvFOK9U0wp667Q/s96-c/photo.jpg", "token":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImUxOTdiZjJlODdiZDE5MDU1NzVmOWI2ZTVlYjQyNmVkYTVkNTc0ZTMiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiIyMTEyNjEwOTE3MzEtc3VoNzdtaDgyaG1xYm0zaDlqbGFyajVuNXRncDNtZzAuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiIyMTEyNjEwOTE3MzEtb2VlNHFjZnI0YzRkbmJ1MGNxN2twMmhhOGw2OXE2M3UuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMTI1NDkxODU2OTc2ODc5MjYxMDIiLCJlbWFpbCI6InhpbmNoYW9uZW5nMjAyMEBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6InpoaXlpIHhpZSIsInBpY3R1cmUiOiJodHRwczovL2xoNi5nb29nbGV1c2VyY29udGVudC5jb20vLWh6NEZCUEoyamlvL0FBQUFBQUFBQUFJL0FBQUFBQUFBQUFBL0FNWnV1Y21WYkhSSDdNU0kwSmpjRXZGT0s5VTB3cDY2N1Evczk2LWMvcGhvdG8uanBnIiwiZ2l2ZW5fbmFtZSI6InpoaXlpIiwiZmFtaWx5X25hbWUiOiJ4aWUiLCJsb2NhbGUiOiJlbiIsImlhdCI6MTYwNzkxMzI2NywiZXhwIjoxNjA3OTE2ODY3fQ.b4KCX3Y4QDtVoSLH5tfs6O93_wzQW4N-yTl7e6INoqOBwmqUeKWUPRWAVMz0yeU2QnjsGS29iOM-29qkhHg0PGInEdqVhdMvGmZYqhYe1-QE9XlavHeoHZleuagc4gDNi-NSbmp33SloTbbVtlTZjo0_lbpn9UIrFcf5suD-46ipM3O--lBZCC9-vvq1EbPMPSgB_oyfzmMvvMd1qG9TcqJnGupHBQGyJ4Y7xiWCWtOxCI9q5m8IlIzWxzFbCOY2zen4qk9jUy7ZC1wiStsGpwX1gvVZsJCt5M6hThkHHFYCih9BIhmARHXrQ9UyWYwtbgJYbmkD22KR6hnNityJdQ", "type":"google" } ``` 原生TO游戏 请参考服务器数据返回，不论成功失败，会将服务器数据原封不动的返回给游戏 ```json { "code":0, "json":"{"api":"/api/v2/user/","data":"{\"code\":200,\"message\":\"success\",\"data\":{\"secret\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJjb2RlIjoiNEc4NDkyUCIsImNvdW50cnkiOiJKUCIsImlkIjo0LCJwZyI6ImNvbS5pZGxlLmNvb2suaGFtYnVyZ2VyIn0.jiLYE6WTj3pLCgd5cWeU6ukHikQSXIR-ywfARN-tVdp9eFkxEv2MbJ1cat2QJnYjnr6E0kpk3LGTFOTxPBHhtw\",\"share_link\":\"https://i.tyes.space/4G8492P\",\"code\":\"4G8492P\",\"inviter\":\"\",\"redeem\":null,\"inviter_coin\":300,\"invitee_coin\":800},\"assets\":{\"coin\":0,\"diamond\":0}}","method":"post","params":"{\"id\":\"112549185697687926102\",\"name\":\"zhiyi xie\",\"thumb\":\"https://lh6.googleusercontent.com/-hz4FBPJ2jio/AAAAAAAAAAI/AAAAAAAAAAA/AMZuucmVbHRH7MSI0JjcEvFOK9U0wp667Q/s96-c/photo.jpg\",\"token\":\"eyJhbGciOiJSUzI1NiIsImtpZCI6ImUxOTdiZjJlODdiZDE5MDU1NzVmOWI2ZTVlYjQyNmVkYTVkNTc0ZTMiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiIyMTEyNjEwOTE3MzEtc3VoNzdtaDgyaG1xYm0zaDlqbGFyajVuNXRncDNtZzAuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiIyMTEyNjEwOTE3MzEtb2VlNHFjZnI0YzRkbmJ1MGNxN2twMmhhOGw2OXE2M3UuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMTI1NDkxODU2OTc2ODc5MjYxMDIiLCJlbWFpbCI6InhpbmNoYW9uZW5nMjAyMEBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6InpoaXlpIHhpZSIsInBpY3R1cmUiOiJodHRwczovL2xoNi5nb29nbGV1c2VyY29udGVudC5jb20vLWh6NEZCUEoyamlvL0FBQUFBQUFBQUFJL0FBQUFBQUFBQUFBL0FNWnV1Y21WYkhSSDdNU0kwSmpjRXZGT0s5VTB3cDY2N1Evczk2LWMvcGhvdG8uanBnIiwiZ2l2ZW5fbmFtZSI6InpoaXlpIiwiZmFtaWx5X25hbWUiOiJ4aWUiLCJsb2NhbGUiOiJlbiIsImlhdCI6MTYwNzkxMzI2NywiZXhwIjoxNjA3OTE2ODY3fQ.b4KCX3Y4QDtVoSLH5tfs6O93_wzQW4N-yTl7e6INoqOBwmqUeKWUPRWAVMz0yeU2QnjsGS29iOM-29qkhHg0PGInEdqVhdMvGmZYqhYe1-QE9XlavHeoHZleuagc4gDNi-NSbmp33SloTbbVtlTZjo0_lbpn9UIrFcf5suD-46ipM3O--lBZCC9-vvq1EbPMPSgB_oyfzmMvvMd1qG9TcqJnGupHBQGyJ4Y7xiWCWtOxCI9q5m8IlIzWxzFbCOY2zen4qk9jUy7ZC1wiStsGpwX1gvVZsJCt5M6hThkHHFYCih9BIhmARHXrQ9UyWYwtbgJYbmkD22KR6hnNityJdQ\",\"type\":\"google\"}"}", "type":"TYPE_HTTP_API" } json：json格式字符串 { "api":"/api/v2/user/", "data":"{"code":200,"message":"success","data":{"secret":"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJjb2RlIjoiNEc4NDkyUCIsImNvdW50cnkiOiJKUCIsImlkIjo0LCJwZyI6ImNvbS5pZGxlLmNvb2suaGFtYnVyZ2VyIn0.jiLYE6WTj3pLCgd5cWeU6ukHikQSXIR-ywfARN-tVdp9eFkxEv2MbJ1cat2QJnYjnr6E0kpk3LGTFOTxPBHhtw","share_link":"https://i.tyes.space/4G8492P","code":"4G8492P","inviter":"","redeem":null,"inviter_coin":300,"invitee_coin":800},"assets":{"coin":0,"diamond":0}}", "method":"post", "params":"{"id":"112549185697687926102","name":"zhiyi xie","thumb":"https://lh6.googleusercontent.com/-hz4FBPJ2jio/AAAAAAAAAAI/AAAAAAAAAAA/AMZuucmVbHRH7MSI0JjcEvFOK9U0wp667Q/s96-c/photo.jpg","token":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImUxOTdiZjJlODdiZDE5MDU1NzVmOWI2ZTVlYjQyNmVkYTVkNTc0ZTMiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiIyMTEyNjEwOTE3MzEtc3VoNzdtaDgyaG1xYm0zaDlqbGFyajVuNXRncDNtZzAuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiIyMTEyNjEwOTE3MzEtb2VlNHFjZnI0YzRkbmJ1MGNxN2twMmhhOGw2OXE2M3UuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMTI1NDkxODU2OTc2ODc5MjYxMDIiLCJlbWFpbCI6InhpbmNoYW9uZW5nMjAyMEBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6InpoaXlpIHhpZSIsInBpY3R1cmUiOiJodHRwczovL2xoNi5nb29nbGV1c2VyY29udGVudC5jb20vLWh6NEZCUEoyamlvL0FBQUFBQUFBQUFJL0FBQUFBQUFBQUFBL0FNWnV1Y21WYkhSSDdNU0kwSmpjRXZGT0s5VTB3cDY2N1Evczk2LWMvcGhvdG8uanBnIiwiZ2l2ZW5fbmFtZSI6InpoaXlpIiwiZmFtaWx5X25hbWUiOiJ4aWUiLCJsb2NhbGUiOiJlbiIsImlhdCI6MTYwNzkxMzI2NywiZXhwIjoxNjA3OTE2ODY3fQ.b4KCX3Y4QDtVoSLH5tfs6O93_wzQW4N-yTl7e6INoqOBwmqUeKWUPRWAVMz0yeU2QnjsGS29iOM-29qkhHg0PGInEdqVhdMvGmZYqhYe1-QE9XlavHeoHZleuagc4gDNi-NSbmp33SloTbbVtlTZjo0_lbpn9UIrFcf5suD-46ipM3O--lBZCC9-vvq1EbPMPSgB_oyfzmMvvMd1qG9TcqJnGupHBQGyJ4Y7xiWCWtOxCI9q5m8IlIzWxzFbCOY2zen4qk9jUy7ZC1wiStsGpwX1gvVZsJCt5M6hThkHHFYCih9BIhmARHXrQ9UyWYwtbgJYbmkD22KR6hnNityJdQ","type":"google"}" } params:json格式字符串,你这次请求传的参数 { "id":"112549185697687926102", "name":"zhiyi xie", "thumb":"https://lh6.googleusercontent.com/-hz4FBPJ2jio/AAAAAAAAAAI/AAAAAAAAAAA/AMZuucmVbHRH7MSI0JjcEvFOK9U0wp667Q/s96-c/photo.jpg", "token":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImUxOTdiZjJlODdiZDE5MDU1NzVmOWI2ZTVlYjQyNmVkYTVkNTc0ZTMiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiIyMTEyNjEwOTE3MzEtc3VoNzdtaDgyaG1xYm0zaDlqbGFyajVuNXRncDNtZzAuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiIyMTEyNjEwOTE3MzEtb2VlNHFjZnI0YzRkbmJ1MGNxN2twMmhhOGw2OXE2M3UuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMTI1NDkxODU2OTc2ODc5MjYxMDIiLCJlbWFpbCI6InhpbmNoYW9uZW5nMjAyMEBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6InpoaXlpIHhpZSIsInBpY3R1cmUiOiJodHRwczovL2xoNi5nb29nbGV1c2VyY29udGVudC5jb20vLWh6NEZCUEoyamlvL0FBQUFBQUFBQUFJL0FBQUFBQUFBQUFBL0FNWnV1Y21WYkhSSDdNU0kwSmpjRXZGT0s5VTB3cDY2N1Evczk2LWMvcGhvdG8uanBnIiwiZ2l2ZW5fbmFtZSI6InpoaXlpIiwiZmFtaWx5X25hbWUiOiJ4aWUiLCJsb2NhbGUiOiJlbiIsImlhdCI6MTYwNzkxMzI2NywiZXhwIjoxNjA3OTE2ODY3fQ.b4KCX3Y4QDtVoSLH5tfs6O93_wzQW4N-yTl7e6INoqOBwmqUeKWUPRWAVMz0yeU2QnjsGS29iOM-29qkhHg0PGInEdqVhdMvGmZYqhYe1-QE9XlavHeoHZleuagc4gDNi-NSbmp33SloTbbVtlTZjo0_lbpn9UIrFcf5suD-46ipM3O--lBZCC9-vvq1EbPMPSgB_oyfzmMvvMd1qG9TcqJnGupHBQGyJ4Y7xiWCWtOxCI9q5m8IlIzWxzFbCOY2zen4qk9jUy7ZC1wiStsGpwX1gvVZsJCt5M6hThkHHFYCih9BIhmARHXrQ9UyWYwtbgJYbmkD22KR6hnNityJdQ", "type":"google" } data:json格式字符串，原封不动的服务器数据 { "code":200, "message":"success", "data":{ "secret":"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJjb2RlIjoiNEc4NDkyUCIsImNvdW50cnkiOiJKUCIsImlkIjo0LCJwZyI6ImNvbS5pZGxlLmNvb2suaGFtYnVyZ2VyIn0.jiLYE6WTj3pLCgd5cWeU6ukHikQSXIR-ywfARN-tVdp9eFkxEv2MbJ1cat2QJnYjnr6E0kpk3LGTFOTxPBHhtw", "share_link":"https://i.tyes.space/4G8492P", "code":"4G8492P", "inviter":"", "redeem":null, "inviter_coin":300, "invitee_coin":800 }, "assets":{ "coin":0, "diamond":0 } } ``` ## 3.其他Api说明 ### 1.游戏点击设置按钮 type：**TYPE_SHOW_SETTING_DIALOG** 游戏To原生 ```json { "code":0, "type":"TYPE_SHOW_SETTING_DIALOG" } ``` ### 2.游戏请求用户信息 建议游戏端直接发起HTTP请求，因为这里返回的信息，也是服务器返回给我的数据结构 这里处理只是为了在原生端消耗了金币或者钻石（比如兑换），然后通知游戏端 type：**TYPE_USER_GAME_INFO** 游戏TO原生 ```json { "code":0, "type":"TYPE_USER_GAME_INFO" } ``` 原生TO游戏（包含主动更新发送消息（例如用户金币数发生变化）） ```json { "code":0, "type":"TYPE_USER_GAME_INFO", "json":"{\"coin\":123,\"diamond\":456,\"level\":6}" } coin:用户金币 diamond：钻石数 level：用户等级 ``` ### 3.展示视频广告 type：**TYPE_SHOW_VIDEO_AD** 原生返回的结果一样 游戏TO原生 ```json { "code":0, "type":"TYPE_SHOW_VIDEO_AD", "json":"true" } json: "true" 如果视频广告还没有加载成功，会等待视频广告加载成功后展示，或等有了加载结果（成功/失败）返回数据 "fasle" 如果视频广告正在加载中，不会等待加载完成，将直接返回错误 ``` 原生TO游戏 只有当用户获取了奖励才会返回成功，否则（比如中途关闭广告）返回失败 ```json { "code":0, "type":"TYPE_SHOW_VIDEO_AD", "message":"success" } ``` ###