Campaigns

You can create, update and delete campaigns using the fields in Campaigns.

Important

If you select eCPC (enhanced cost-per-click) as the bidding strategy for your campaign, Native Ad Platform will dynamically modify your bids in order to optimize for conversions. Note that bids made may be ABOVE the bid amount that you have set. Navigate to the section below that deals with How to Create a Campaign with a Bidding Strategy for details.

For more information on modifying bids and using bid adjustments, refer to:

Fields

The following fields are available for creating and managing campaigns:

Name

Description

Type

Add

Update

Campaign Id

The ID of the campaign.

long

N/A

required

Campaign Objective

The objective of the campaign. The objective can only be set at the time of campaign creation and cannot be modified. The default is VisitWeb, if not specified. The objective can be:

  • VisitWeb

The default value. Should be used if your goal is to generate traffic to your web pages. This objective supports CPC pricing type for both mobile search and native ads campaigns.

  • Shopping

Use this objective for dynamic product ads campaigns. Note that the objective supports the CPC pricing type and NATIVE campaigns only.

  • PromoteBrand

Use this objective if your goal is to increase brand awareness. This objective supports CPM or CPV pricing type.

  • MailSponsored

Use this objective if your goal is to generate email ad opens. This objective supports the CPC or CPV pricing type and NATIVE campaigns only.

  • InstallApp

Use this objective if your goal is to generate an app install. This objective supports CPC pricing type and NATIVE campaigns only.

  • ReengageApp

Use this objective if your goal is to generate an app re-engagement. This objective supports the CPM pricing type and NATIVE campaigns only.

string

optional

read-only

Campaign Budget

The budget for your campaign in the currency provided in your account billing settings. This should be a positive value, greater than zero.

BigDecimal

required

optional

Campaign Budget Type

Type of budget. Values can be:

  • Lifetime

The budget is for the entire duration of the campaign.

  • Daily

The budget is the daily spend amount. Daily spend will be capped at the budget value.

string

required

optional

Tracking Partner

Add the name of one of our certified partners or none. This applies to InstallApp campaigns only.

string

optional

optional

Channel

The supply channel on which the campaign will run. The available options are:

  • Native

Will run in native positions on content streams. Note: Channel must be set to Native for app install ads to serve.

  • Search

Will run on search supply.

  • Search and Native

Will run on both search and content stream supply.

If the channel is not set, the default value will be Search and Native.

string

optional

optional

Sub Channel

The supply channel on which the campaign will run. The sub channel is only applicable when channel is SEARCH. The available options are:

  • SRN_AND_SEARCH

  • SRN_ONLY

  • DEFAULT - to remove

enum

optional

optional

Advanced Location

By default, all campaigns target users by their physical location as well as by location of intent (in the search query). You can now explicitly target either users physically located in your geo-targeted location or users searching for your geo-targeted location, or both (default). See Create Advanced Location Targeting for more information.

string

optional

optional

Bid Modifier

The bid modifier enables you to increase or decrease your native campaign bid for SRN. The bid modifier (%) range is: -90 to 100 (i.e., from 0.1 to 2 times of bid)

string

Required if the campaign Sub Channel is set. Default -70.

optional

Bidding Strategy

Available values are:

  • OPT_ENHANCED_CPC - For VisitWeb, MailSponsored, and Shopping campaigns. The ECPA Goal on ad group is required. Setting this on campaign will override any bidding strategy set on the ad group level.

When applied to a SEARCH campaign, this means that Gemini will dynamically modify your bid in order to optimize for eCPC conversions. An ad group bid is still required and will define the initial bid that Gemini will gradually optimize. You also need to have at least one conversion rule set up in order to leverage this strategy.

When applied to a NATIVE campaign, this allows you to meet a CPC goal on average while getting more conversions by allowing your bids to be adjusted for individual impressions based on the likelihood of conversion.

  • OPT_POST_INSTALL - For InstallApp or ReengageApp NATIVE campaigns only. ECPA Goal on ad group is required. Setting this on campaign will override any bidding strategy set on the ad group level.

This means that Native Ad Platform will dynamically modify your bid in order to optimize for the install and specific in-app event conversion rule. You also need to have at least one conversion rule set up in order to leverage this strategy, and it must be also included in the corresponding campaign’s Conversion Rule IDs.

  • OPT_CONVERSION - For VisitWeb, MailSponsored, InstallApp, or ReengageApp NATIVE campaigns only. ECPA Goal on ad group is required. Setting this on campaign will override any bidding strategy set on the ad group level.

This means that Native Ad Platform will dynamically modify your bid in order to optimize for conversions. An ad group bid is still required and will define the initial bid that Gemini will gradually optimize. You also need to have at least one conversion rule set up in order to leverage this strategy, and it must be also included in the corresponding campaign’s Conversion Rule IDs.

  • OPT_CLICK - For VisitWeb, MailSponsored, InstallApp, or ReengageApp NATIVE campaigns only. Setting this on campaign will override any bidding strategy set on the ad group level.

This means Native Ad Platform will optimize per your selected price type (that is, deliver clicks for CPC ads or impressions for CPM ads).

  • MAX_OPT_CONVERSION - For VisitWeb or MailSponsored NATIVE campaigns only. Setting this on campaign will override any bidding strategy set on the ad group level.

This means Native Ad Platform bids in a way that tried to balance spending the entire campaign budget with achieving the lowest CPA possible (that is, maximizing the number of conversions driven by the budget). Best for advertisers who are CPA-sensitive and also want to hit spend goals.

  • DEFAULT. This default means there is no bidding strategy set on the campaign level. It means that the ad group bidding strategy set will take place.

enum

optional

optional

Language

The language of the targeted audience. By default, this is set to EN (for English). This can be set at the time of campaign creation and cannot be modified. See the list of languages supported below:

  • ARABIC ar

  • GERMAN de

  • GREEK el

  • ENGLISH en

  • SPANISH es

  • FRENCH fr

  • INDONESIAN id

  • ITALIAN it

  • MALAY ms

  • DUTCH nl

  • PORTUGUESE pt

  • ROMANIAN ro

  • RUSSIAN ru

  • SWEDISH sv

  • TURKISH tr

  • VIETNAMESE vi

  • TRADITIONAL_CHINESE zh_TW

string

optional

read-only

Conversion Pixel

The ID of a conversion pixel associated with the campaign.

long

optional

optional

Landing URL

Required only for InstallApp and ReengageApp campaigns. Should be used to pass the App Store or Google Play Store app url, and cannot be updated once set. Note that for InstallApp, tracking parameters and redirects should not be part of the campaign level Landing Url. These should be provided through the ad level landing Url.

string

optional

optional

App Locale

An optional field for InstallApp and ReengageApp campaigns. Can be used to specify the desired locale of the app store, and will default to en-us if not specified. Currently supported locales: en-us, en-gb, fr-fr, de-de, it-it, es-es, pt-br, en-in, en-hk, zh-hk, zh-tw, en-ca, fr-ca, es-mx, en-ph, es-ar, es-us, ms-my, en-au, id-id, sv-se, ru-ru, en-za, en-sg, zh-cn, fr-be, es-cl, en-nz, vi-vn, es-co, ro-ro, el-gr, fr-ch, ko-kr.

string

optional

read-only

Network

Applies only to mobile search campaigns. Determines whether your campaign will run on:

  • YahooAndPartner (default)

  • Yahoo

string

optional

optional

Campaign Status

The status of the campaign. Valid values are:

  • Active

  • Paused

Campaigns are defaulted to Active if no status is provided upon campaign creation. A campaign in Paused state will require valid start and end dates to be set at the ad group level in order to be activated.

string

optional

optional

Frequency

Frequency capping for the campaign. Currently this only allows daily or weekly capping for PromoteBrand campaigns. Acceptable values are:

  • (Daily[n])

  • (Weekly[n]) where n is the cap number.

Examples: (Daily[10]) (Weekly[50]). To remove the frequency setting, you can use the generic clearing bulk value of delete_value

string

optional

optional

Campaign Effective Status

The read-only effective status of the campaign based on the direct campaign status, accounts funds, campaign budget, and summarized ad group flight dates. Valid values are:

  • Active

  • Paused

  • Deleted

  • Ended

  • Lifetime Budget Spent

  • Awaiting Funds

  • Awaiting Start Date

string

N/A Read-only

N/A Read-only

Conversion Rule IDs

The conversion rule IDs associated with this campaign. Must be valid IDs of conversion rules created in the account. Example values:

  • [ 1000, 2000, 3000 ]

  • [ 2001 ]

To remove IDs, you can use delete_value.

List of longs

optional

optional

Conversion Lookback Window

The post-click conversion lookback window assigned to this campaign. Valid only for VisitWeb and PromoteBrand campaigns. Minimum allowed: 1 Minute. Maximum allowed: 30 Days. Default value is 30 Days. Example values:

  • 30 Days

  • 1 Day

  • 6 Hours

  • 1 Hour

  • 15 Minutes

  • 1 Minute

  • 2 Weeks

  • 1 Week

string

optional

optional

Conversion Post View Lookback Window

The post-view conversion lookback window assigned to this campaign. Valid only for VisitWeb and PromoteBrand campaigns. Minimum allowed: 1 Minute. Maximum allowed: 30 Days. Default value is 2 Days. Example values:

  • 30 Days

  • 1 Day

  • 6 Hours

  • 1 Hour

  • 15 Minutes

  • 1 Minute

  • 2 Weeks

  • 1 Week

string

optional

optional

Is Deep Link

Deep link into your mobile app, targeting your product or users who have already installed your app. Available for:

  • VisitWeb

  • ReengageApp (Note that you can’t set the value. Defaults to TRUE.)

  • Shopping campaign objectives, and only for Native channels.

enum

optional

optional

Conversion Counting

The Conversion Counting setting for your campaign. Must be one of the following values:

  • ALL_PER_INTERACTION

  • ONE_PER_INTERACTION. Default is ALL_PER_INTERACTION.

string

optional

optional

Strict Targeting

A targeting object type with any one or combination of the following values:

  • AGE

  • GENDER

  • SEGMENT

Multiple values are separated by a semicolon (:). If you wish to disable expanded targeting for age, use AGE. To disable expanded targeting for gender, use GENDER. To disable expanded targeting for segment, use SEGMENT. For update requests, if not specified, expanded targeting for that type won’t be disabled. For example, if the original value is AGE;GENDER;SEGMENT and updated to AGE, gender and segment will use expanded targeting.

string

optional

optional

Create a Campaign

The following example contains the fields required for creating a campaign. All other fields in this spreadsheet are blank and are not shown:

Action

Object Type

Campaign

Campaign Objective

Campaign Budget

Campaign Budget Type

Channel

Language

Network

Add

Campaign

My new campaign name

VisitWeb

800

Daily

Search

EN

YahooAndPartner

Note

The campaign object field is optional for create and read-only for update.

Update a Campaign

When updating a campaign, the only required fields are Action, Object Type, Campaign ID and the fields you would like to update. The following example shows updating the budget for a campaign with an ID of 123. All other fields in this spreadsheet are blank and are not shown:

Action

Object Type

Campaign ID

Campaign Budget

Update

Campaign

123

1200

Create Advanced Location Targeting

Gemini Search provides support for advanced location targeting.

By default all your campaigns target users by their physical location as well as location of intent (in the search query).

You can now explicitly target either users physically located in your geo-targeted location or users searching for your geo-targeted location, or both (default).

Important

If you upload a bulk file without any location targeting attached to the campaign, then the corresponding campaign will be targeting world-wide.

Three advanced location options are available:

  • (Default) Show ads to people in, searching for, or viewing pages about your targeted location.

  • Show ads to people in your targeted location only.

  • Show ads to people searching for your targeted location only. All three options are supported by Native Ad Platform. You can access this feature using a Bulk file or the Native Ad Platform API.

Positive and Negative advanced location options are also supported.

The Negative advanced location option only supports the physical location and default (both physical & location of interest) options. All three options are supported by positive advanced location.

If your Bing accounts are synced with Gemini, the advanced location options will not be carried over. You can leverage this feature by breaking the sync and setting the advanced geo targeting option using Bulk or the Gemini API.

This change will not impact your location bid modifiers. Bid modifiers will be applied, and will work in accordance with existing behavior.

Note that support for reporting in the UI will not be available immediately. You should be able to run ad-hoc reports if required, however.

The output looks like this:

Location

Advanced Location

Positive[Default]:Negative[Default]

This field will have the following values/format:

Positive [Default or Physical or Interest]:Negative [Default or Physical]

Examples would be: Positive[Physical]:Negative[Physical] Positive[Interest]:Negative[Default]

If Positive or Negative are not provided, we would set them to Default, so setting Positive[Physical] alone would mean that you’re implicitly setting negative to default so on download you will get: Positive[Physical]:Negative[Default].

Note the following:

  • Value is set on Campaign and Ad Group object types.

  • Value is optional.

  • Value is editable on existing object.

Create a Campaign with a Bidding Strategy

The following example contains the fields required for creating a campaign with a bidding strategy that will run on mobile search channels. All other fields in this spreadsheet are blank and are not shown:

Action

Object Type

Campaign

Campaign Objective

Campaign Budget

Budget Type

Channel

Frequency

Landing URL

Campaign Status

Bidding Strategy

Add

Campaign

visit_web_search_campaign

VISIT_WEB

25000

DAILY

Search

https://www.landingUrl.com

ACTIVE

OPT_ENHANCED_CPC