Intelligent Assistant
Chat with our virtual assistant to get answers promptly.
This API does not support contract data query.
Querying Advertiser Data
This API can be called to obtain basic ad delivery data of advertisers, including spends, clicks, and cost per click.
NOTE
- Request URL: Select a URL based on your nearest area.
Asia, Africa, and Latin America: https://ads-dra.cloud.huawei.com/openapi/v2/reports/advertiser/query
Russia: https://ads-drru.cloud.huawei.ru/openapi/v2/reports/advertiser/query
Europe: https://ads-dre.cloud.huawei.com/openapi/v2/reports/advertiser/query
- Request method: POST
- Request parameters
Parameter
Type
Mandatory (M)/Optional (O)
Description
advertiser_id
string
O
Advertiser ID. This parameter is mandatory in two cases: (1) A manager or partner account is used for sign-in. (2) The current HUAWEI ID supports multiple advertiser accounts.
time_granularity
string
O
Time granularity. Example: STAT_TIME_GRANULARITY_DAILY. For details, please refer to Time granularity.
start_date
string
M
Start date.
Format: yyyy-MM-dd
end_date
string
M
End date.
Format: yyyy-MM-dd
page
integer
O
Page number.
Default value: 1
Value range: 1–10000
page_size
integer
O
Number of records displayed on a page.
Default value: 20
Value range: 1–10000
topn
integer
O
Indicates that top N records are used.
is_abroad
Boolean
M
Indicates whether the account is an account outside the Chinese mainland. The options are as follows:
true: yes
false: no
flow_resource
integer
O
Network where ads are delivered.
campaign_type
integer
O
Campaign type. The options are as follows: 1: display campaign; 2: keyword campaign; 3: push campaign; 4: shopping campaign.
index_screen_list
List <Struct1>
O
Filter indicators.
dimension_type
Struct2
O
Dimension type.
time_line
string
O
Time type. For details, please refer to Time type.
group_by
string[]
O
Dimensions for grouping. For details, please refer to Grouping dimension.
target_country
List
O
Target country/region codes, for example, ["AF", "AE"].
This parameter is valid only when time_granularity is set to STAT_TIME_GRANULARITY_SUMMARY.
Parameters of dimension_type(Struct2)
Parameter
Type
Mandatory (M)/Optional (O)
Description
dimension
string
O
Dimension. The options are as follows: adposition_id: slot ID.
country: country/region. Set it to a two-letter code defined by ISO, for example, CN or RU.
data
string[]
O
Value of dimension.
Parameters of index_screen_list(Struct1)
Parameter
Type
Mandatory (M)/Optional (O)
Description
index_screen
string
O
Filter indicator. The options are as follows:
effective_cost: cost
effective_impression_count: number of impressions
effective_click_count: number of clicks
effective_per_click: cost per click
effective_download_count: number of downloads
type
integer
O
Filter indicator type. The options are as follows:
1: ≥ (only low_value needs to be set)
2: ≤ (only up_value needs to be set)
0: range (both low_value and up_value need to be set)
low_value
float
O
Lower limit.
up_value
float
O
Upper limit.
- Request example
POST openapi/v2/reports/advertiser/query HTTP/1.1
Accept:application/json
Content-Type:application/json
Authorization:Bearer CgB6e3x9ERGComr9dENxZX22iBk+mLuf1yGtQVPUjPJUMrstfKlqpdXk+kfHU9J8ZJ/soYIZHZzT446GeSYumluQuhsK7jvz4kz1Bkms4CLI/rE=
{ "flow_resource": 2, "campaign_type": 1, "topn": 5, "dimension_type": { "data": [], "dimension": "" }, "index_screen_list": [ { "index_screen": "effective_cost", "low_value": 0, "type": 1, "up_value": 4000 } ], "start_date": "2021-06-22", "end_date": "2021-06-27", "is_abroad": "true", "time_granularity": "STAT_TIME_GRANULARITY_DAILY", "page": "1", "page_size": "10", "target_country": ["CN","EU","GB","EE"] } - Response parameters
Parameter
Type
Mandatory (M)/Optional (O)
Description
code
string
M
Result code.
message
string
M
Result code description.
data
Struct1
O
Statistics of a specified object.
Parameters of data(Struct1)
Parameter
Type
Mandatory (M)/Optional (O)
Description
page_info
Struct2
M
Pagination information.
list
Struct3[]
M
Statistics list.
list_summary
Struct3
M
Statistics list summary.
Parameters of page_info(Struct2)
Parameter
Type
Mandatory (M)/Optional (O)
Description
page
integer
M
Page number.
page_size
integer
M
Number of records displayed on a page.
total_number
integer
M
Total number of records on all pages.
total_page
integer
M
Total number of pages.
Parameters of list(Struct3)
Parameter
Type
Mandatory (M)/Optional (O)
Description
advertiser_id
string
M
Advertiser ID.
stat_datetime
string
M
Start time.
Format: YYYYMMDDHH
The time granularity in the request determines the time precision.
show_count
integer
M
Number of impressions.
click_count
integer
M
Number of clicks.
cpc
float
M
Cost per click.
thousand_show_cost
float
M
Cost per thousand impressions.
cost
float
M
Cost.
download_count
integer
M
Number of downloads.
download_cost
float
M
Cost per download.
install_count
integer
M
Number of installs.
install_cost
float
M
Cost per install.
active_count_normalized
integer
M
Normalized number of activations.
active_cost_normalized
float
M
Normalized cost per activation.
register_count
integer
M
Number of registrations.
register_cost
float
M
Cost per registration.
retain_count_normalized
integer
M
Normalized number of day 1 retentions.
retain_cost_normalized
float
M
Normalized cost per day 1 retention.
pay_count_normalized
integer
M
Normalized number of payments.
pay_cost_normalized
float
M
Normalized cost per payment.
browse_count
integer
M
Number of browses.
browse_cost
float
M
Cost per browse.
collection_count
integer
M
Number of favorites.
collection_cost
float
M
Cost per favorite.
add_cart_count
integer
M
Number of adds to cart.
add_cart_cost
float
M
Cost per add-to-cart.
pre_order_count
integer
M
Number of order placements.
pre_order_cost
float
M
Cost per order placement.
form_submit_count
integer
M
Number of form submissions.
form_submit_cost
float
M
Cost per form submission.
effective_consult_count
integer
M
Number of effective consultings.
effective_consult_cost
float
M
Cost per effective consulting.
effective_customer_acquisition_count
integer
M
Number of effective customer acquisitions.
effective_customer_acquisition_cost
float
M
Cost per effective customer acquisition.
app_custom_count
integer
M
Number of custom conversions in the app.
app_custom_cost
float
M
Cost per custom conversion in the app.
web_custom_count
integer
M
Number of custom conversions on the web page.
web_custom_cost
float
M
Cost per custom conversion on the web page.
play_count
integer
O
Number of video playbacks.
play_over_count
integer
O
Number of video playback completions.
play_impression_count
integer
O
Number of video impressions.
play_valid_effective_count
integer
O
Number of valid video playbacks.
effective_book_count
integer
O
Number of effective bookings.
effective_book_cost
float
O
Cost per effective booking.
book_amount
integer
O
Number of bookings.
pay_amount_normalized
float
O
Normalized payment amount.
venus_form_submit_count
integer
O
Number of form submissions (Venus).
venus_form_submit_cost
float
O
Cost per form submission (Venus).
vote_count
integer
O
Number of votes.
vote_cost
float
O
Cost per vote.
update_count
integer
O
Number of updates.
update_cost
float
O
Cost per update.
tutorial_completion_count
integer
O
Number of tutorial completions.
tutorial_completion_cost
float
O
Cost per tutorial completion.
travel_booking_count
integer
O
Number of travel bookings.
travel_booking_cost
float
O
Cost per travel booking.
three_day_retain_count
integer
O
Number of day 3 retentions.
three_day_retain_cost
float
O
Cost per day 3 retention.
subscribe_count
integer
O
Number of subscriptions.
subscribe_cost
float
O
Cost per subscription.
start_trial_count
integer
O
Number of trial use starts.
start_trial_cost
float
O
Cost per trial use start.
spent_credits_count
integer
O
Number of bonus points spends.
spent_credits_cost
float
O
Cost per bonus points spend.
share_count
integer
O
Number of sharings.
share_cost
float
O
Cost per sharing.
seven_day_retain_count
integer
O
Number of day 7 retentions.
seven_day_retain_cost
float
O
Cost per day 7 retention.
search_count
integer
O
Number of searches.
search_cost
float
O
Cost per search.
reservation_count
integer
O
Number of reservations.
reservation_cost
float
O
Cost per reservation.
redirect_count
integer
O
Number of redirections to another page.
redirect_cost
float
O
Cost per redirection to another page.
read_count
integer
O
Number of readings.
read_cost
float
O
Cost per reading.
re_engage_count
integer
O
Number of user wakeups.
re_engage_cost
float
O
Cost per user wakeup.
rate_count
integer
O
Number of ratings.
rate_cost
float
O
Cost per rating.
purchase_membercard_count
integer
O
Number of membership purchases.
purchase_membercard_cost
float
O
Cost per membership purchase.
precredit_count
integer
O
Number of credit preapprovals.
precredit_cost
float
O
Cost per credit preapproval.
potential_customer_phone_count
integer
O
Number of potential user leads (call).
potential_customer_phone_cost
float
O
Cost per potential user lead (call).
potential_customer_online_count
integer
O
Number of potential user leads (consulting).
potential_customer_online_cost
float
O
Cost per potential user lead (consulting).
potential_customer_form_count
integer
O
Number of potential user leads (form).
potential_customer_form_cost
float
O
Cost per potential user lead (form).
phone_dialing_count
integer
O
Number of direct dialings.
phone_dialing_cost
float
O
Cost per direct dialing.
order_signing_count
integer
O
Number of order signings and acceptances.
order_signing_cost
float
O
Cost per order signing and acceptance.
opened_frompushnotification_count
integer
O
Number of openings from push messages.
opened_frompushnotification_cost
float
O
Cost per opening from a push message.
navigate_count
integer
O
Number of store navigations.
navigate_cost
float
O
Cost per store navigation.
lottery_count
integer
O
Number of lucky draws.
lottery_cost
float
O
Cost per lucky draw.
login_count
integer
O
Number of sign-ins.
login_cost
float
O
Cost per sign-in.
loan_completion_count
integer
O
Number of completions.
loan_completion_cost
float
O
Cost per completion.
like_count
integer
O
Number of likes.
like_cost
float
O
Cost per like.
level_achieved_count
integer
O
Number of level reaches.
level_achieved_cost
float
O
Cost per level reach.
leads_lottery_count
integer
O
Number of leads (lucky draw).
leads_lottery_cost
float
O
Cost per lead (lucky draw).
landingpage_click_count
integer
O
Number of landing page button clicks.
landingpage_click_cost
float
O
Cost per landing page button click.
invite_count
integer
O
Number of invitations.
invite_cost
float
O
Cost per invitation.
initiated_checkout_count
integer
O
Number of checkout starts.
initiated_checkout_cost
float
O
Cost per checkout start.
game_package_redemption_count
integer
O
Number of gift redemptions.
game_package_redemption_cost
float
O
Cost per gift redemption.
game_package_claiming_count
integer
O
Number of gift claims.
game_package_claiming_cost
float
O
Cost per gift claim.
forward_count
integer
O
Number of forwardings.
forward_cost
float
O
Cost per forwarding.
follow_scan_count
integer
O
Number of scans to follow.
follow_scan_cost
float
O
Cost per scan-to-follow.
follow_count
integer
O
Number of follows.
follow_cost
float
O
Cost per follow.
first_purchase_membercard_count
integer
O
Number of first member purchases.
first_purchase_membercard_cost
float
O
Cost per first member purchase.
effective_leadsform_count
integer
O
Number of valid leads (form).
effective_leadsform_cost
float
O
Cost per valid lead (form).
effective_leads_phone_count
integer
O
Number of valid leads (call).
effective_leads_phone_cost
float
O
Cost per valid lead (call).
effective_leads_online_count
integer
O
Number of valid leads (consulting).
effective_leads_online_cost
float
O
Cost per valid lead (consulting).
deliver_count
integer
O
Number of order shipments.
deliver_cost
float
O
Cost per order shipment.
custom_count
integer
O
Number of customizations.
custom_cost
float
O
Cost per customization.
credit_count
integer
O
Number of credit approvals.
credit_cost
float
O
Cost per credit approval.
create_role_count
integer
O
Number of in-game role creations.
create_role_cost
float
O
Cost per in-game role creation.
coupon_count
integer
O
Number of pass claims.
coupon_cost
float
O
Cost per pass claim.
content_view_count
integer
O
Number of content view browsings.
content_view_cost
float
O
Cost per content view browsing.
consult_online_count
integer
O
Number of website consultings.
consult_online_cost
float
O
Cost per website consulting.
comment_count
integer
O
Number of comments.
comment_cost
float
O
Cost per comment.
authorize_count
integer
O
Number of game authorizations.
authorize_cost
float
O
Cost per game authorization.
add_to_wishlist_count
integer
O
Number of adds to wishlist.
add_to_wishlist_cost
float
O
Cost per add-to-wishlist.
add_quick_app_count
integer
O
Number of quick app adds.
add_quick_app_cost
float
O
Cost per quick app add.
add_payment_info_count
integer
O
Number of payment information adds.
add_payment_info_cost
float
O
Cost per payment information add.
achievement_unlocked_count
integer
O
Number of achievement unlocks.
achievement_unlocked_cost
float
O
Cost per achievement unlock.
country
string
O
Country/Region code, for example, RU. To return this parameter, add the group parameter COUNTRY.
high_quality_active_count
integer
O
Number of premium activations.
high_quality_active_cost
float
O
Cost per premium activation.
tracking_conversion_count
integer
O
Number of specified conversions.
tracking_conversion_value
integer
O
Specified conversion value.
attribution_income_iaa
float
O
IAA
roas
float
O
roas
attribution_income_iaa
integer
O
IAA revenue.
attribution_income_iap_normalized
integer
O
Normalized IAP revenue.
transition_count
long
O
Conversions.
click_transition_ratio
float
O
Conversion rate.
transition_cost
float
O
Cost per conversion.
deep_transition_count
long
O
Deep conversions.
click_deep_transition_ratio
float
O
Deep conversion rate.
deep_transition_cost
float
O
Deep conversion cost.
all_transition_count
long
O
All deep conversions.
click_all_transition_ratio
float
O
All deep conversion rate.
all_transition_cost
float
O
All deep conversion cost.
key_action_count
long
O
Number of key actions.
key_action_click_ratio
bigdecimal
O
Key action rate.
cost_per_key_action
bigdecimal
O
Cost per key action.
refund_count
long
O
Number of refunds.
click_refund_ratio
bigdecimal
O
Refund rate.
cost_refund
bigdecimal
O
Cost per refund.
refund_amount
bigdecimal
O
Refund amount.
paid_amount
float
O
Payment amount.
- Response example
HTTPS/1.1 200 OK
{ "code": "0", "data": { "list_summary": { "comment_count": 0, "purchase_membercard_count": 0, "coupon_count": 0, "forward_count": 0, "effective_leads_online_count": 0, "click_count": 0, "search_count": 0, "reservation_count": 0, "seven_day_retain_count": 0, "consult_online_count": 0, "phone_dialing_count": 0, "add_payment_info_count": 0, "effective_leads_phone_count": 0, "landingpage_click_count": 0, "venus_form_submit_count": 0, "travel_booking_count": 0, "book_amount": 0, "follow_count": 0, "subscribe_count": 0, "play_over_count": 0, "web_custom_count": 0, "leads_lottery_count": 0, "precredit_count": 0, "login_count": 0, "potential_customer_online_count": 0, "pre_order_count": 0, "browse_count": 0, "vote_count": 0, "three_day_retain_count": 0, "pay_count_normalized": 0, "potential_customer_form_count": 0, "order_signing_count": 0, "add_to_wishlist_count": 0, "update_count": 0, "redirect_count": 0, "level_achieved_count": 0, "download_count": 0, "form_submit_count": 0, "add_quick_app_count": 0, "loan_completion_count": 0, "show_count": 0, "tutorial_completion_count": 0, "navigate_count": 0, "start_trial_count": 0, "lottery_count": 0, "potential_customer_phone_count": 0, "install_count": 0, "app_custom_count": 0, "content_view_count": 0, "read_count": 0, "effective_book_count": 0, "add_cart_count": 0, "like_count": 0, "create_role_count": 0, "play_count": 0, "register_count": 0, "opened_frompushnotification_count": 0, "game_package_claiming_count": 0, "rate_count": 0, "collection_count": 0, "first_purchase_membercard_count": 0, "achievement_unlocked_count": 0, "retain_count_normalized": 0, "follow_scan_count": 0, "game_package_redemption_count": 0, "authorize_count": 0, "spent_credits_count": 0, "initiated_checkout_count": 0, "effective_leadsform_count": 0, "effective_consult_count": 0, "re_engage_count": 0, "active_count_normalized": 0, "share_count": 0, "invite_count": 0, "credit_count": 0, "effective_customer_acquisition_count": 0, "deliver_count": 0 "country": RU "high_quality_active_count": 0 "high_quality_active_cost": 0 "tracking_conversion_count": 0 "tracking_conversion_value": 0 "attribution_income_iaa": 0 "attribution_income_iap_normalized":0 }, "page_info": { "total_num": 0, "total_page": 0, "page": 1, "page_size": 0 }, "list": [] }, "message": "OK" }
- Request example
Search in Promotion and Paid Advertising
Enter a keyword.