Banner

The object contains the ad title and text, contact information, and links to the advertiser's website.

The ad has an ID, BannerID. It is returned when creating an ad using the CreateOrUpdateBanners method, and is used for getting parameters using the GetBanners method.

The following structure shows the minimal set of ad parameters.

params = {
   "BannerID": (int),
   "CampaignID": (int),
   "Title": (string),
   "Text": (string),
   "Href": (string),
   "Geo":  (string),
   "Phrases": [
      {
      "PhraseID": (long),
      "Phrase": (string),
      "Price": (float)
      }
   ]
}

There are additional parameters provided for ads, which are described below. A full list of parameters is given in the response to the GetBanners method.

The ad must conform to the Advertising Requirements and contain at least one keyword (the Phrases array).

General data

The Title and Text parameters contain the ad title and text.

The Href parameter sets the main link to the advertiser's website. Contact information may be set instead of it or together with it (see below). The Domain parameter is automatically filled in with the name of the domain that the link leads to, taking redirects into account.

In addition, from one to four sitelinks can be set in the Sitelinks array. The text of a sitelink is set in the Title parameter and the address is set in the Href parameter.

Substitution variables can be set in the links, and they will be replaced with values when the ad is displayed. Use substitution variables to pass information about the site and section where the ad was displayed, the keyword that triggered the impression, and so on. Values for the {param1} and {param2} variables are set for each keyword in the UserParams structure, and values for the other variables are detected automatically.

Note

The values of the {campaign_id}, {ad_id}, {banner_id}, and {phrase_id} variables will be substituted in the sitelinks only if the same variables are present in the main link for the ad.

Contact information

The ContactInfo structure is mandatory only if the ad does not have a link to the advertiser's website set. This structure contains detailed information about the advertiser: address, telephone, hours of operation, location, and others.

Status and state

The following parameters show the results of review: StatusBannerModerate, StatusPhrasesModerate, StatusPhoneModerate, StatusSitelinksModerate, FixedOnModeration, ModerateRejectionReasons.

The StatusShow parameter contains the status for displaying an ad, which can be switched. The IsActive parameter indicates the actual state for impressions, and changes automatically. In addition, the beginning of impressions is indicated by the StatusActivating parameter.

An inactive ad can be moved to the archive. This changes the value of the StatusArchive parameter.

The equivalence of ad statuses in the Yandex Direct web interface and the API is described below.

Active

StatusShow == 'Yes' AND (
   IsActive == 'Yes' OR (
      StatusBannerModerate IN ('Yes', 'PreliminaryAccepted') AND
      StatusPhrasesModerate IN ('Yes', 'PreliminaryAccepted') AND (
         Href != '' OR
         StatusPhoneModerate == 'Yes'
      )
   )
)

Drafts

StatusArchive == 'No' AND (
   StatusBannerModerate == 'New' AND
   StatusPhrasesModerate == 'New' AND
   StatusPhoneModerate == 'New' AND
   StatusSitelinksModerate == 'New'
)

Under moderation

StatusArchive == 'No' AND (
    StatusBannerModerate == 'Pending' OR
    StatusPhrasesModerate == 'Pending' OR
    StatusPhoneModerate == 'Pending' OR
    StatusSitelinksModerate == 'Pending'
) AND  StatusBannerModerate != 'No' AND StatusPhrasesModerate != 'No'

Stopped

StatusArchive == 'No' AND StatusShow == 'No'

Rejected

StatusArchive == 'No' AND (
   StatusBannerModerate == 'No' OR 
   StatusPhrasesModerate == 'No' OR
   StatusPhoneModerate == 'No' OR
   StatusSitelinksModerate == 'No'
)

Targeting

Targeting defines conditions for showing ads. The configuration of these conditions involves campaigns, ads, and keywords, and is described in the section Targeting.

Others

The AdWarnings parameter notifies you when an ad impression is accompanied by a warning in accordance with the federal law of the Russian Federation “About advertising”. For example, a warning is required for advertisements of alcohol and tobacco products.

The AgeLabel parameter (Live 4) contains the age-appropriate category of the advertised product, if this category is required to be specified by the federal law of the Russian Federation “About advertising”.

Keywords

An ad must contain at least one keyword.

Images

Ads can be supplemented with images. Ads with images attract more attention and have a higher click-through rate.

The section Images in ads covers working with images.

Previous
Ad Group
Next
Phrase