Result Codes

Publisher Service (Java & Kotlin)

Integrating Ads Kit Through HMS Toolkit

Ad Formats

Banner Ads

Native Ads

Integrating the SDK-rendered Template Ads

Use of Location Data for Ads

Ad Request by Contextual Information

Real-Time Bidding

Customizing Parameters for Channels

App-Level Settings

App Activation Reminder Pop-up

VAST

Consent

Integration with IAB TCF v2.0

Publisher Service (JavaScript)

Integrating the Petal Ads JavaScript API

App Activation Reminder Pop-up

Integration with IAB TCF v2.0

Identifier Service

Use Cases

Obtaining OAID Information (by SDK)

Obtaining Install Referrer Information (by SDK)

Obtaining a Deferred Deep Link

Obtaining Install Referrer Information (by AIDL)

Testing the Install Referrer Capability

Publisher Service Reporting API

Implementation Process

Obtaining the Client ID and Key

Calling the Publisher Service Reporting API

Obtaining Publisher Service Report Data

Ads SDK Privacy Statement

Ads SDK Compliance Guide

Data Protection Information About Ads Kit (EU)

Integrating the Petal Ads SDK into Your Eclipse Project

Supported Sites and Country/Region Codes

Account Kit

Manual Preparations

Scenario-based Development

HUAWEI ID Sign-In Without Identity Verification

HUAWEI ID Sign-In via ID Token (OpenID Connect)

HUAWEI ID Sign-In via Authorization Code (OAuth 2.0)

Quick HUAWEI ID Sign-In to Apps That Apply for Only the OpenID or UnionID

Function-based Development

Signing In with an ID

Silently Signing In with an ID

Signing Out of an ID

(Optional) Independent Authorization

(Optional) Obtaining Icon Resources

HuaweiIdAuthButton Usage Guide

Preparing a Development Environment

Configuring App Signing

Scenario-based Development

HUAWEI ID Sign-In Without Identity Verification

HUAWEI ID Sign-In via ID Token (OpenID Connect)

HUAWEI ID Sign-In via Authorization Code (OAuth 2.0)

HarmonyOS (JavaScript)

Preparing a Development Environment

Configuring App Signing

Signing In with a HUAWEI ID

Silently Signing In

Quick HUAWEI ID Sign-In to Apps That Apply for Only the OpenID or UnionID

Signing Out of a HUAWEI ID

Obtaining an Access Token

Requesting Huawei Open APIs Using an Access Token

Refreshing an Access Code

Mini World Integrates Account Kit to Boost User Growth and Monetization

Asphalt 9: Legends Grows Its User Base by Integrating Account Kit

Account Kit Helps Eternal Sword M Increase Its User Base and Revenue

AliExpress Integrates Account Kit to Boost User Conversion

CITIC's Banking App for HarmonyOS Integrates Account Kit to Provide Better Financial Services

About Calling the Open Platform

UnionID Introduction

OAuth 2.0-based Authentication

API Key-based Authentication

Service Account-based Authentication

RISC-based Cross-Account Protection

Errors and Troubleshooting

Accessing Account Kit Using AppAuth

For Android Apps

For iOS Apps

Setting a Redirection URL

Integrating the HMS Core SDK into Your App Project in the Eclipse IDE

HUAWEI ID Sign-In Button Usage Rules

How to Use accountservertool.jar

HUAWEI ID Sign-In on Apps Released on AppTouch via Authorization Code (OAuth 2.0)

Analytics Kit

Vocational and Adult Education

Operation Guide in AppGallery Connect

Functions

Overview

User Analysis

Distribution by Version

Behavior Analysis

Session Path Analysis

Industry Analysis

Language Training

Mall Shopping

Exercise and Health

House Rental and Purchase

Marketing Analysis

Uninstalls Analysis

Audience Insight

User Lifecycle

Intelligent Data Access

User ID Calculation Logic

SDK Integration for Apps

Tracing by Coding

Verify Tracing Events

Management

Topic-specific Guides

Data Export

Using Sampling Analysis

Managing the Default Data Processing Location

Setting Multiple Data Processing Locations

Attribution Usage Guide

Using Activation Attribution

Using Petal Ads Attribution (Outside the Chinese Mainland)

Using AppGallery Paid Promotion Attribution (Outside the Chinese Mainland)

Using Web Attribution

Awareness Kit

About the Service

Capabilities

Typical Application Scenarios

Travel Apps

Lifestyle Apps

Sports and Health Apps

Music Apps

Game Apps

Photography Apps

Preparations

Bluetooth Car Stereo Awareness

Developing Your App

Audio Device Status Awareness

Headset Awareness

Ambient Light Awareness

Weather Awareness

Phone Status Awareness

Screen Status Awareness

Wi-Fi Status Awareness

Data Donation

Obtaining a Service Open ID

HMS Core Awareness SDK

Awareness Kit Joins Forces with Qunar.com, Leading You Wherever Your Ambitions Take You

Success Stories

Awareness Kit Partners with Tongcheng to Make Each Journey Newly Rewarding

Jike Cooperates with HUAWEI Awareness Kit to Provide Brand-New Smart Services

Appendix

Supported Countries/Regions (by the Data Donation Capability)

Drive Kit

Accessing Drive Kit

Obtaining Authentication Information

Function Description

Obtaining User Information

Managing and Searching for Files

Storing App Data

Tracking File Changes

Enabling File Change Notification

Disabling File Change Notification

Commenting on Files and Replying to Comments

Commenting on Files

Replying to Comments

Querying the Historical Versions of Files

Performing Batch Operations

Accessing Drive Kit

Obtaining Authentication Information

Function Description

Obtaining User Information

Managing and Searching for Files

Storing App Data

Using File Change Notification

Enabling File Change Notification

Stopping File Change Notification

Commenting on Files and Replying to Comments

Commenting on Files

Replying to Comments

Querying the Historical Versions of a File

Performing Batch Operations

Development Specifications

Status Codes

Terms

Dynamic Tag Manager

Use Cases

Android

Preparations

Common Visual Event Tracking (Procedure)

Operations on the Server

Workspace

Overview

Visual Event Management

Introduction

Common Visual Event Tracking (Example)

Tag Template-based Visual Event Tracking (Procedure)

Tag Template-based Visual Event Tracking (Example)

Visual Event Tracking by HUAWEI Analytics (Procedure)

Tag Management

Condition Management

Variable Management

Group Management

Version Management

Configuration Management

Review Management

Extension Template Fields

Fields

Variable Data Types

iOS

Preparations

Common Visual Event Tracking (Procedure)

Operations on the Server

Workspace

Overview

Visual Event Management

Introduction

Common Visual Event Tracking (Example)

Tag Template-based Visual Event Tracking (Procedure)

Tag Template-based Visual Event Tracking (Example)

Visual Event Tracking by HUAWEI Analytics (Procedure)

Tag Management

Condition Management

Variable Management

Group Management

Version Management

Configuration Management

Review Management

(Optional) Configuring Information in iTunes Connect

Extension Template Fields

Web

Preparations

(Optional) Integrating the SDK

Operations on the Server

Workspace

Overview

Visual Event Management

Introduction

Common Visual Event Tracking (Procedure)

Common Visual Event Tracking (Example)

Tag Template-based Visual Event Tracking (Procedure)

Tag Template-based Visual Event Tracking (Example)

Visual Event Tracking by HUAWEI Analytics (Procedure)

Tag Management

SEAD Intermodal Launch Platform

Condition Management

Variable Management

Group Management

Version Management

Configuration Management

Review Management

Extension Template Fields

Fields

Variable Data Types

Appendixes

Integrating the HMS Core SDK into Your Eclipse Project

Game Service

Preparations in AppGallery Connect

App development (Phones & Tablets)

Game Addiction Prevention

(Optional) GameTurbo Engine

Game Addiction Prevention FAQs

Sign-in Signature Verification FAQs

Querying Game Service Information

Querying App Information

Querying IAP Information

Generating a Signature String for the Sign-in Signature Verification API

Method for Verifying the Signature in the Response for Sign-in Signature Verification

Obtaining the Public Key for Signature Verification

Obtaining a Project ID

Verifying the Signature for Missed Orders

Account Linking

Game Service Terminology

Solution to Replace PlayerIDs with OpenIDs

Integrating the HMS Core SDK into Your App Project in the Eclipse IDE

GameTurbo Engine

Integrating GameTurbo Engine

Permission Application

Sample Code

Integration Description

Introduction to Health Service Kit

Health Service Kit

Health Service Kit Overview

Health Service Kit Integration Process

App-oriented Open Services

Device-oriented Open Services

Getting Help

Accessing Health Kit

Qualifications Requirements for Developers

Cloud-side Data Openness

Applying for the HUAWEI ID Service

Authentication

Developing the Login-Free Authorization Feature

Releasing Your App

Developing the Login-Free Authorization Feature

Open Authorization in Huawei Health

Improving Real-time Data Openness

Reading Historical Data

Storing and Querying Data

Moderate to High Intensity

Expedition Marked Points

Getting In and Out of Bed

ECG Measurement Details

Reproductive Health

Maximum Oxygen Uptake

Sleep Breathing

Resting Calories

Emotion

Heart Rate Variability

ECG Measurement Records

Sleep Records

Tachycardia and Bradycardia

Menstrual Cycle Data

Sleep Breathing Records

Low SpO2 Level Data

ABPM Reports

High Body Temperature Data

Example Use Scenarios of Major Data Types

Step Count Statistics of Multiple Days

Writing Step Count

Blood Glucose Data (Finger-prick Test)

Running Exercise Records

Running Exercise Records (Segments Included)

Jump Rope Exercise Records

Jump Rope Exercise Records (Segments Included)

Rower Exercise Records

Swimming Exercise Records

Basketball Exercise Records

Freediving Exercise Records

Apnea Training Records

Apnea Test Records

Skiing Exercise Records

Elliptical Exercise Records

ECG Records

Sleep Records

Heart Rate Alert Health Records

Route Import

Menstrual Cycle Records

Sleep Breathing Records

Importing Running Courses

Data Query Timeliness

Device-side Data Openness

Applying for the HUAWEI ID Service

Importing the Certificate Fingerprint, Changing the Package Name, and Configuring the JDK Build Version

Obtaining User Authorization

Enabling Health Service Kit in Huawei Health

Managing Health and Fitness Sampling Data

Managing Exercise Records

Managing Health Records

Reading Real-time Data

Reading Historical Data

Moderate to high intensity

Maximum Oxygen Uptake

Sleep Breathing Records

Example Use Scenarios of Major Data Types

Step Count Statistics of the Day

Step Count Statistics of Multiple Days

Running Exercise Records

Writing Running Exercise Records

Reading Running Exercise Records

Running Exercise Records (Segments Included)

Writing Running Exercise Records (Segments Included)

Reading Running Exercise Records (Segments Included)

Reading Real-time Data

Reading Real-time Step Count

Sleep Data

Writing Sleep Data

Reading Sleep Data

Basketball Exercise Records

Writing Basketball Exercise Records

Reading Basketball Exercise Records

Jump Rope Exercise Records

Writing Jump Rope Exercise Records

Reading Jump Rope Exercise Records

Freediving Exercise Records

Writing Freediving Exercise Records

Reading Freediving Exercise Records

Apnea Training Records

Writing Apnea Training Records

Reading Apnea Training Records

Apnea Test Records

Writing Apnea Test Records

Reading Apnea Test Records

Heart Rate Alert Health Records

Writing Heart Rate Alert Health Records

Reading Heart Rate Alert Health Records

Extended Health Kit Capabilities

Importing the Certificate Fingerprint, Changing the Package Name, and Configuring the JDK Build Version

Obtaining User Authorization

Obtaining Personal Information

Querying Daily Activities

Querying an Individual Exercise Record

Querying Health Data

Pagination

Obtaining Real-time Heart Rate

Storing Data

Deleting Data

Controlling Activity Status and Obtaining Real-time Data

Subscribing to Data

Obtaining the API Level

Commissioning and Verification

Releasing Your App

HarmonyOS (JavaScript)

Preparing the Development Environment

Configuring App Signature Information

Obtaining User Authorization

Enabling Health Service Kit in Huawei Health

Managing Health and Fitness Sampling Data

Managing Exercise Records

Managing Health Records

Managing Personal Information

Managing Real-Time Data

Obtaining Real-time Heart Rate

Controlling Activity Status and Obtaining Real-time Data

Obtaining Data from Smart Watches

Data Types

Example Use Scenarios of Major Data Types

Step Count Statistics of the Day

Step Count Statistics of Multiple Days

Running Exercise Records

Writing Running Exercise Records

Reading Running Exercise Records

Basketball Exercise Records

Writing Basketball Exercise Records

Reading Basketball Exercise Records

Jump Rope Exercise Records

Writing Jump Rope Exercise Records

Reading Jump Rope Exercise Records

Freediving Exercise Records

Reading Freediving Exercise Records

Sleep Records

Writing Sleep Records

Reading Sleep Records

Heart Rate Alert Health Records

Writing Heart Rate Alert Health Records

Reading Heart Rate Alert Health Records

Specifications for Using Logos

Appendixes

App Package Name

Signing Certificate Fingerprint

Notice on Disabling Cipher Suites of the TLS 1.2 and TLS 1.3 Protocols for the Health Service Kit Domain

About Changes in the Openness of Route Data

Example of Calling APIs of the Health Service Kit SDK for Android

Bundle Keys for Real-time Activities

Supported Countries/Regions (Basic Capabilities)

Supported Countries/Regions (Extended Capabilities)

Device Access

Fitness Machine Access Guide

Fitness Machine Access

Aerobic Fitness Machine Access

Obtaining the Gym Profile Development Suite

Integration Process

Bluetooth Module Function Development

Overall Structure of the Bluetooth Protocols

Characteristic-based Interaction Process

Supported Range of the DIS Characteristics

Supported Range of the FTMS Characteristics

FTMS Characteristics

Huawei-defined Parameters in Advertising Packets

Service Data AD Type of Advertising Packets

Fitness Machine Feature

Treadmill Data

Elliptical Trainer Data

Rower Data

Indoor Bike Data

Training Status

Supported Speed Range

Supported Inclination Range

Supported Resistance Level Range

Supported Power Range

Supported Heart Rate Range

Fitness Machine Control Point

Fitness Machine Status

Huawei Extension FTMS Characteristics

Bluetooth Sample Code

FAQs Related to Fitness Machine Access

Identity Kit

Preparations

Configure Obfuscation Scripts

Appendix

Integrating the HMS Core SDK into Your Eclipse Project

In-App Purchases

Order and Subscription Services

Configuring Your Products

Integrating IAP Through HMS Toolkit

(Mandatory) Redelivery Process for Consumables

Purchase Process

Purchase Implementation

Subscription Functions

Pending Purchase Implementation

Key Parameters

HarmonyOS (JavaScript)

Setting Up the Development Environment

Configuring Your Products

(Mandatory) Redelivery Process for Consumables

Purchase Process

Purchase Implementation

Subscription Functions

Verifying the Purchase Token for the Order Service

Server

Verifying the Purchase Token for the Subscription Service

Confirming the Purchase for the Order Service

Canceling Subscriptions

Deferring Billing

Refunding Subscription Payments

Revoking Subscriptions

Querying Canceled or Refunded Orders

Querying Orders Related to Specific Purchase Records

Receiving Notifications About Key Order or Subscription Events

Receiving Notifications About Key Events of Pending Purchase

Verifying the Signature in the Returned Result

(Mandatory) Verifying InAppPurchaseData

Suggestions on Preventing Against Fraud and Abuse

Sandbox Testing

Integrating the HMS Core SDK into Your Eclipse Project

Location Kit

(Optional) Optimizing the App Package Size

Integrating Location Kit Through HMS Toolkit

Development Guide

Developing the Fused Location Service

Developing the Activity Identification Service

Developing the Geofence Service

Developing the High-precision Location Service

(Optional) Developing the Log Recording Service

Developing the Indoor Location Service

iOS (Objective-C)

Declaring Required Permissions

Development Guide

Developing the Fused Location Service

Developing the GeoLocation (API) Service

Developing the IPLocation (API) Service

Location Kit Bolsters ComfortDelGro with Precise Positioning, for Accurate Taxi Hailing Down to the Specific Street Curb

Success Stories

Location Kit Assists Kerry Express with High-precision Positioning, Making Express Pickup and Delivery Easier than Ever

Location Kit Provides OneMap with Enhanced Location-based Services

Appendixes

Devices Supporting Geofence

Submitting a Ticket Online

Map Kit

Integrating Map Kit Through HMS Toolkit

Map Creation

Migration From Google Maps to HMS Core Map Kit

Map Instance Creation

Map Type

My Location

Map Attribute Settings

UI Controls and Gestures

Map Style Customization

Map Layer Customization

Tile Service

Customizing a Map Layer

Temperature Map Layer

Precipitation Map Layer

Function Overview

Preparing the Development Environment

Map Creation

Map Instance Creation

Map Type

Map Attribute Settings

UI Controls and Gestures

Map Instance Creation

Map Type

My Location

Map Attribute Settings

Map Interaction

PetalMaps Intents for Android

Map Camera

UI Controls and Gestures

Map Style Customization

Customizing an Overlay

Heatmap

Traffic Condition Layer

Shapes

Drawing Layer

Map Style Customization

Place Search Suggestion

Geometric Calculation

Calculating the Distance

Calculating the Area

Development Guide

Development Process

Preparing the Development Environment

Integrating the Map Kit Plugin for Flutter

Client Development

Huawei Map Kit Personal Data Processing Information

Creating a Map

Interacting with a Map

Map Data Copyright Statement

Appendixes

Supported Countries/Regions (Route Planning)

Navi Kit

Map Data Copyright Statement

Push Kit

About the Service

Android

Preparations

Configuring the AndroidManifest.xml File

Obtaining and Deleting a Push Token

Basic Capabilities

Sending a Test Message

Obtaining Message Content

Customizing Actions to Be Triggered upon Notification Message Tapping

Configuring Whether to Display Notification Messages

Enhanced Capabilities

A/B Testing

Audience-based Message Sending

Topic-based Message Sending

Multiple Senders

Account Verification

Automated Notification

Other Capabilities

Ringtone

Notification Channel Customization

Notification Message Localization

Notification Message Overwriting

Notification Message Content Hiding on the Lock Screen

Notification Message Processing for Apps Running in the Foreground

Message Overwriting for Offline Users

Message Cache Time for Offline Users

Message Sending by Topic Combination

Message Display

Badges

Image on the Right of a Message

App Icon on the Left of a Message

Action Button in a Notification Message

Inbox Style for a Notification Message

Large Text Style for a Notification Message

HarmonyOS (Java)

Setting Up the Development Environment

Preparations

Signing Your App

iOS

Service Enabling and Rights Configuration

Web (Beta)

Server Development Guide

Downlink Message Sending

Uplink Message Sending

Message Receipt

Push Kit Console

Message Sending

Message Sending Report

Appendix

Notification Icon Specifications

Sample Code for Sending Downlink Messages Through HTTPS

OAuth 2.0-based Authentication

Integrating the HMS Core SDK into Your Eclipse Project

Technical Support

Scan Kit

Integrating Scan Kit Through HMS Toolkit

Building Scanning Capabilities

Available Modes to Call Scan Kit

Default View

Customized View

Bitmap

Scanning Barcodes Using the Camera

Scanning Barcodes from Images

Building the Barcode Generation Function

iOS

Building Scanning Capabilities

Available Modes to Call Scan Kit

Default View

Customized View

Bitmap

Scanning Barcodes Using the Camera

Scanning Barcodes from Images

Parsing Barcodes

Building the Barcode Generation Function

Scan Kit Provides APUS Browser with Nimble Scanning Services and Sharable Capabilities

Cases

Scan Kit Gives JomParking the Tools to Make Users Pay – But with Zero Hassle!

Scan Kit Bolsters UnDosTres with Effortless Payment Solutions

Scan Kit Gives UnionBank the Tools to Better Serve its Customers, with Complex Payment Solutions on Demand

Barcode Formats Supported by HMS Core Scan Kit

Custom Elements for the Scanning UI in Customized View Mode

Converting the HmsScan Object into a JSON String

Search Kit

Preparations

REST

Error Codes

Appendix

Site Kit

Android

Preparations

Integrating Site Kit Through HMS Toolkit

Keyword Search

Nearby Place Search

Place Detail Search

Place Search Suggestion

REST

Appendixes

Supported Languages

Wallet Kit

Use Cases

Smart Locks for Hotels and Homes

App Development

Pass Integration Scenarios

Car Keys

Client-Side Development

Preparations

Generating Security Keys for Pass Claiming by Web Page, SMS Message, Email, or App

Applying for Security Components

Applying for the Wallet Kit service

Adding a Pass

Integrating the Add to HUAWEI Wallet Button to Your Web Page to Claim a Pass

Adding a Deep Link to an SMS Message or Email to Claim a Pass

Adding a Pass from HUAWEI Wallet CardStore

Adding a Pass from Your Quick App

Adding a Pass from Your App

Pushing JWE Data to the Huawei Server After Your App Is Integrated with the Wallet SDK

Integrating the Wallet SDK

Sample Code for Adding a Loyalty Card Through the SDK

Pushing a Pass Package to HUAWEI Wallet After Your App Is Integrated with the Wallet SDK

Integrating the Wallet SDK

Adding a Button for Claiming Passes in Your App

Adding a Pass

Updating a Pass

Calling Huawei Server APIs to Update a Pass

Calling Your Server APIs to Update a Pass

Integrating NFC Capabilities

Implementing NFC Capability APIs on Your Server

Calling the Wallet SDK APIs to Implement the NFC Pass Writing Capability

Appendix

Pass Reader Development

Reading the Applet Identity Public Key and Its Signature

Internal Authentication

Sending an Instruction for Internal Authentication

Performing Internal Authentication

Verifying the PBOC Digital Signature

Selecting Files from ADF

Reading Private Data from the Target App After Authentication

Reporting the Pass Reading Result

Calculating the MAC

Add to HUAWEI Wallet Button

Test Cases

Integrating the Wallet SDK into Your Eclipse Project

urlList Redirection Configuration

Button Redirection Configuration

Device ID Service

AAID

OAID

ODID

Result Codes

Last updated: 2024-01-16 09:11

Result codes for web clients

SDK result codes for Android apps

If the error persists, submit a ticket online. Huawei will get back to you as soon as possible. For details about the ticket submission procedure, please refer to Submitting a Ticket Online.

Snap to Roads API