interface_sdk-js/api/advertising/advertisement.d.ts
amoscloud d298ebfaef Description: Supplementary Specification for Interface Declaration
Feature or Bugfix: Feature
Binary Source: No
Signed-off-by: amoscloud2013<dingxiaoyi2@huawei.com>
2024-03-19 10:04:48 +08:00

139 lines
3.2 KiB
TypeScript

/*
* Copyright (c) 2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file Defines the advertisement data model
* @kit AdsKit
*/
/**
* Defines the advertisement data model.
* @typedef Advertisement
* @syscap SystemCapability.Advertising.Ads
* @since 11
*/
/**
* Defines the advertisement data model.
* @typedef Advertisement
* @syscap SystemCapability.Advertising.Ads
* @atomicservice
* @since 12
*/
export interface Advertisement {
/**
* The advertisement type.
* @type { number }
* @syscap SystemCapability.Advertising.Ads
* @since 11
*/
/**
* The advertisement type.
* @type { number }
* @syscap SystemCapability.Advertising.Ads
* @atomicservice
* @since 12
*/
adType: number;
/**
* The server verifies the configuration parameters.
* @type { Map<string, string> }
* @syscap SystemCapability.Advertising.Ads
* @since 11
*/
/**
* The server verifies the configuration parameters.
* @type { Map<string, string> }
* @syscap SystemCapability.Advertising.Ads
* @atomicservice
* @since 12
*/
rewardVerifyConfig: Map<string, string>;
/**
* The unique identifier of the advertisement.
* @type { string }
* @syscap SystemCapability.Advertising.Ads
* @since 11
*/
/**
* The unique identifier of the advertisement.
* @type { string }
* @syscap SystemCapability.Advertising.Ads
* @atomicservice
* @since 12
*/
uniqueId: string;
/**
* The subscriber has been rewarded.
* @type { boolean }
* @syscap SystemCapability.Advertising.Ads
* @since 11
*/
/**
* The subscriber has been rewarded.
* @type { boolean }
* @syscap SystemCapability.Advertising.Ads
* @atomicservice
* @since 12
*/
rewarded: boolean;
/**
* The advertisement has been shown.
* @type { boolean }
* @syscap SystemCapability.Advertising.Ads
* @since 11
*/
/**
* The advertisement has been shown.
* @type { boolean }
* @syscap SystemCapability.Advertising.Ads
* @atomicservice
* @since 12
*/
shown: boolean;
/**
* The advertisement has been clicked.
* @type { boolean }
* @syscap SystemCapability.Advertising.Ads
* @since 11
*/
/**
* The advertisement has been clicked.
* @type { boolean }
* @syscap SystemCapability.Advertising.Ads
* @atomicservice
* @since 12
*/
clicked: boolean;
/**
* The extended attributes of advertisement.
* @type { Object }
* @syscap SystemCapability.Advertising.Ads
* @since 11
*/
/**
* The extended attributes of advertisement.
* @type { Object }
* @syscap SystemCapability.Advertising.Ads
* @atomicservice
* @since 12
*/
[key:string]: Object;
}