createAdset: Create an adset

In JohnCoene/oRion: Integrate R & Cheetah Mobile Orion

Description

Create an adset.

Usage

createAdset(body)

Arguments

body	body of request that includes adset settings. See examples and details

Details

Valid adset settings (body):

• campaign_id The campaign id which the ad set is to belongs to

• audience_create_way 0: Create audience targeting parameters directly. Audience should be along with this API if choose this audience_create_way. 1: Create audience targeting by a template. Note: Once audience created, any changes made on the template will not affect this audience.

• audience_template_id Required when audience_create_way: 1 or 2

• bid_type Use bidType to generate otherwise, 1: Install (CPI) [Only for KA user], 3: Click (CPC), 4 Impressions (CPM)

• app_show_type Use appShowType to generate otherwise, 50000: Native News Feed, 50001: Mini Native News Feed, 50003: Video Ad, 50008: App Locker Ad

• name Ad set name (unique)

• unit_price Unit Price. Amount you want to spend to pay per click (CPC) or per 1,000 impressions (CPM)

• click_url click_url, protocol is required (http://, https://).

• deeplink Deep link is the ability to link into a specific page or function inside of your app, making an app linkable just like a web site. If you are only targeting people who already installed your app, you do not need to add deferred deep linking. Used when the objective of campaign which ad set belonged to is "Get App Reengagement" (objective = 4)

• imp_url Impression Tracking. An Impression tracking is an optional URL that allows you to track how many people viewed your ads through third-party tracking system, and our system supported macro is Gaid, e.g. http://host/imp?gaid=gaid. Used when the bid type is "CPM" bid_type = 4

• budget_lifetime Your budget is the maximum amount you want to spend. If you choose lifetime, the amount you enter is the maximum you'll spend during the lifetime of your ad set. At least one of budget_daily and budget_lifetime is filled.

• budget_daily Your budget is the maximum amount you want to spend. If you choose Per Day, the amount you enter is the maximum you'll spend each day. At least one of "budget_daily" and "budget_lifetime" is filled.

• start_time Start time for the adset (i.e.: 2015-09-09 10:10)

• end_time End time for the adset (i.e.: 2015-09-09 10:10)

• ad_scheduling Your ad set will either run continuously within some days or within some hours range you select. (JSON) i.e.: {1:[1,2],7:[1,2,23]}

• delivery_type Use deliveryType to generate otherwise, 0: Standard delivery, 1: Accelerated delivery. Standard delivery is recommended and the preferred option for most advertisers. Accelerated delivery can be useful for promoting time-sensitive events and quickly reaching a target audience.

• target_cpi Target CPI. Only for KA user. 3: Click (CPC)

• freq_type Frequency Capping type. Frequency capping controls frequency capping of the ad set per user.

• freq_times Frequency Capping type. Frequency capping controls frequency capping of the ad set per user.

• country Audience country code. Narrow your potential audience to the people in those countries. Using '|' separated if more than one country. i.e.: US|ID|CN. See dictCountry

• language Audience language code, i.e.: en see dictLanguage

• gender Use gender to generate otherwise, 0: All, 1: Male, 2 Female

• age Audience age. Use age to generate otherwise, 1: 18-24, 2: 25-30, 3: 32-40, 4: 41+.

• interest Audience interest. Reach users based on their specific interests. See dictInterest

• behavior Audience behavior. Reach users based on app usage and other behaviors. See dictBehaviour

• device_brand Audience device brand. See dictDevice

• min_device_os Min OS version of audience used, blank for unrestricted. See dictOS

• max_device_os Max OS version of audience used, blank for unrestricted. See dictOS

• net_type Use netType to generate otherwise, 0: All, 1: Wifi, 2: 2G/3G/4G

• dsp_url Bid request url of DSP when this pre-targeting condition meets.

Author(s)

John Coene [e-mail]

See Also

orionOAuth, createCampaign, helpers

Examples

## Not run: 
# authenticate
orionOAuth(client.id = 0000,
           client.secret = "0x00000000x00x0x000xxx0000x0xx0")
 
# list of campaigns
camps <- listCampaigns()

# list of audience templates
audiences <- listAudiences()
                                                
# create adset using random template, in random campaign
createAdset(body = list(
   name = "testAdset",
   bid_type = bidType("cpi"),
   unit_price = 1000,
   budget_lifetime = 10000,
   campaign_id = sample(camps$id, 1),
   audience_create_way = 2,
   app_show_type = appShowType("newsfeed"),
   audience_template_id = sample(audiences$id, 1),
   click_url = "http://app.adjust.io"))

## End(Not run)

JohnCoene/oRion documentation built on June 13, 2019, 12:44 p.m.