Image ad items (commonly known as "display ads") are an effective medium for delivering advertising messages across multiple platforms. They are easy to setup and configure because they require only a creative (i.e. an image file) and, when applicable, a destination URL to which users will be redirected when the ad is clicked.
In general, ad items are assigned to an advertiser campaign, and in turn the campaign to a zone. Ad items can also be assigned directly to a zone, but we recommend doing so only if the ad items are directly related to that zone's publisher or are intended to be default/house ads.
x-group: Campañas - name: Ad Items / Custom HTML description: >-Creating a custom HTML ad item is the best option if you need to serve a third-party advertisement from an ad network or another advertiser, or if you want to create an ad that cannot be achieved using traditional display advertising.
Custom HTML ad items allow you to implement virtually any type of ad using Haku’s ad serving macros and a text box.
In general, ad items are assigned to an advertiser campaign, and in turn the campaign to a zone. Ad items can also be assigned directly to a zone, but we recommend doing so only if the ad items are directly related to that zone's publisher or are intended to be default/house ads.
x-group: Campañas - name: Ad Items / Native description: >- Native ad items use native templates to create seamless editorial content.Ad item companion products link an ad item to a product in a product DB catalog. Each companion product belongs to a single ad item and references a specific product via a catalog ID and product identifier (SKU).
Companion products are nested under ad items and can be
managed under both
/ad-items/image/{ad_item_id}/companions/products and
/ad-items/native/{ad_item_id}/companions/products.
Requires the Display Ad Item Companions and Product DB Replicated features.
x-group: Retail media - name: AdServe description: > For server-side ad requests via JSON API, use the adserve endpoint to request ad items in JSON format from the ad server.Ad items represent the particular catalog item (product) being promoted. One or more catalog ad items may be assigned to a campaign.
x-group: Retail media - name: Ad Items / Catalog Item / Bulk description: >-Bulk operations for catalog ad items. These endpoints allow you to create or delete multiple catalog ad items at once and assign them to campaigns.
x-group: Retail media - name: Zones / Catalog description: >-A catalog zone is the representation of a source of promoted product ads. Advertiser campaigns would be assigned to catalog zones (called a placement), making them eligible to be matched against when making an ad request.
x-group: Retail media - name: Creatives (All) description: >- Creatives are the displayed part of an ad item. It can be an image, HTML5/rich media, custom HTML, or video. x-group: Campañas - name: Creatives / Image description: >- The image file that makes up an advertisement is known as the image creative. You can create a new image creative, retrieve one or more image creatives, update an existing image creative, or delete the image creative. x-group: Campañas - name: Data Keys description: >- Aside from keywords, location, and platform-based targeting, Haku also lets you target specific audiences using key value-based attributes. These are called data keys. For example, you can use data keys to target a specific age, gender, or date. Like the other forms of targeting, you must create and define data keys before you can use them. Data keys simply hold the value of attributes. After creating and defining data keys, you must create [Data Key Targets](#tag/Data-Key-Targets) to set up the actual targeting filters. For more information, read How to create data keys and data key targets via API. x-group: Targeting - name: Data Key Targets description: >- Data Key targets are used hand-in-hand with [Data Keys](#tag/Data-Keys) to create custom targeting filters. For more information, read How to create data keys and data key targets via API. x-group: Targeting - name: Geo Targets description: >-Geographic targets ("geo targets") enable you to deliver advertisements to users based on their geographic location. This is an effective way of reducing wasted impressions and increasing your return on investment.
Geographic targeting can be as generic as continents or as specific as cities. A geo target may contain as many areas as desired which can vary in specificity. (For example, an area of "South America" and an area of a specific city could exist in the same geo target.) Geo targets can either be inclusive or exclusive.
x-group: Targeting - name: Media Groups description: >- Media groups allow you to group creatives together for easier organization and management in your account. x-group: Campañas - name: Native Templates description: >- Native templates define the styles and formatting of native ads. Once a template is created it can then be applied, reused, and edited as needed to make native ad items.Native ads are ads that look like editorial content. For example, a native ad on a blog looks like the other articles on the site, a native ad on Instagram looks like an Instagram post, and a native ad on a search engine looks like other search results. Native ads are also known as sponsored content or promoted posts. x-group: Inventario - name: Placements description: >- Assign an advertisement or campaign to a zone based on a set of scheduling criteria using the placements endpoint. Each placement represents a combination of criteria required to serve an advertisement. Prior to creating a placement, you will need to have created several other resources: * An [ad item](#tag/Ad-Items-(All)), * a [campaign](#tag/Campaigns-(All)), * a [zone](#tag/Zones-(All)), * and a [schedule](#tag/Schedules) You also have the option to create targeting filters, keywords, and activity limits to further control the deliverability of your placements. x-group: Campañas - name: Platform Targets description: >-Target your advertisements to specific mobile/tablet/notebook/desktop devices, or to specific browsers and operating systems to help ensure users get the best ads for their platform. You can also target specific mobile phones or tablets, such as iPhones or Samsung devices using device targeting filters.
x-group: Targeting - name: Product DB / Catalog description:Product catalogs that can be used for product-based advertising.
x-group: Retail media - name: Product DB / Catalog Items description: >-Product catalog items that can be used for product-based advertising.
x-group: Retail media - name: Product DB / Catalog Items / Bulk Upload description: >-Bulk upload a catalog CSV with column names that match the fields submitted to a catalog.
x-group: Retail media - name: Product DB / Publisher Sources description: >-Publisher Sources that can be used for product-based advertising targeting.
x-group: Retail media - name: Product DB / Publisher Source Targets description: >-Publisher Source Targets that can be used for product-based advertising targeting.
x-group: Retail media - name: Publishers description: >- A publisher is typically a person or a company who owns a website, app, newsletter, or even another ad server. Each publisher will have one or more zones, which represent the locations on their websites, apps or newsletters where advertisements can be displayed. x-group: Inventario - name: Reports description: >-Reporting is the new interface to Statistics. It serves to quantify the serving of your advertisements across price and performance related metrics. They are updated in real time. We go to great lengths to give you detailed and accurate data about the performance of your advertisements to help you make informed decisions. The following endpoints enable you to build your own reporting dashboard.
x-group: Reportes - name: Schedules description: >- Schedules describe the conditions necessary for serving advertisements. Common conditions include start and end dates, and quotas. You can also use delivery methods to determine the expiration and pacing set up for advertisements. Default delivery delivers the impressions as quickly as possible, while smooth delivery will evenly serve impressions over the lifetime dates and quotas. For example, with smooth delivery, if your campaign has a quota of 30,000 impression set over a period of 60 days, the system would serve the assignment 500 times per day. Smooth delivery assignments have the highest potential priority for serving within Haku. If a quota has not been filled then that assignment will generally always serve as long as a targeting system does not interfere. __NOTE__: Schedules have no effect on their own and must be referenced through their ID. For campaigns with campaign-level scheduling, the schedule must be referenced in the [placement](#tag/Placements). For campaigns with ad item-level scheduling, the schedule must be referenced in the [campaign assignment](#tag/Campaign-Assignments) for each ad item in the campaign. Multiple placements and assignments can reference the same schedule, so they can share the same quota, start/end dates, and other common settings. x-group: Campañas - name: Zones (All) description: > Zones represent the space on a Publisher's website where ads are displayed ("served"). A zone's size can either be fixed or dynamic. The types of zones are: * __Standard__ - The most common, used to serve various ads including image, HTML5/Rich Media, Native Ads or third party scripts. * __VAST__ - Used to serve VAST video ads. * __Email__ - Used to serve image ads in emails and newsletters. x-group: Inventario - name: Zones / Standard description: >- The most common zone type. Used to serve image ads (JPG,PNG, or GIF), HTML5/Rich Media, or third party scripts. x-group: Inventario paths: /ad-items/image/{id}: get: tags: - Ad Items / Image summary: Get a Single Image Ad Item parameters: - name: id in: path description: Identifier of the ad item you'd like to get. required: true schema: type: integer example: '' - $ref: '#/components/parameters/fields' responses: default: description: successful operation content: application/json: schema: $ref: '#/components/schemas/image_ad_item_get' components: parameters: fields: name: fields in: query description: >- Restrict the fields you wish to retrieve by listing the desired fields formatted as a comma-separated list. Fields like "object", "self", and "id" are always returned. schema: type: string schemas: image_ad_item_get: properties: object: description: A string denoting the current resource being requested or affected. type: string example: image_ad_item self: description: >- The relative URL of the current resource being requested or affected. type: string example: /v2/ad-items/image/675265899 id: description: The current resource identifier (ID). type: integer example: 675265899 type: object allOf: - $ref: '#/components/schemas/ad_item_shared_fields' - $ref: '#/components/schemas/image_ad_item' - $ref: '#/components/schemas/ad_item_created_last_modified' ad_item_shared_fields: properties: name: description: >- The name of the ad item. We recommend using a naming convention that is descriptive, consistent, and clear. type: string example: Example Ad Item height: description: >- The height of the ad item in pixels. Defaults to __0__ when no height given. If `width` is set to a value greater than 0, a height must also be set to a non-zero value. A width and height both set to __0__ signify a "dynamic ad". Read more about dynamic ads. type: integer example: 400 width: description: >- The width of the ad item in pixels. Defaults to __0__ when no width given. If `height` is set to a value greater than 0, a width must also be set to a non-zero value. A width and height both set to __0__ signify a "dynamic ad". Read more about dynamic ads. type: integer example: 650 location: description: >- The destination URL to which the user will be redirected when they click on the ad item. A __null__ value denotes no redirection. type: string example: '' tracking_pixel: description: >- An optional third party tracking pixel served with the ad for monitoring impressions. A __null__ value means no tracking pixel was added. Use `tracking_pixels` if you want to add multiple tracking pixels. __NOTE__: Essentials subscribers do not have access to third-party pixel tracking and therefore must set this field's value to __null__. type: string example: https://url.com tracking_pixels: description: >- List of tracking pixels. An empty array means that no tracking pixels were added. To create a tracking pixel, enter an object that only has the `url` field. An `id` for the new tracking pixel will be sent in the response. To update a tracking pixel, enter an object with the tracking pixel's `id` and the new `url` for the tracking pixel. To delete a tracking pixel, enter an object with the tracking pixel `id` and set `url` to __null__. type: array items: $ref: '#/components/schemas/tracking_pixel' example: - id: 27419 url: https://url1.com - id: 27420 url: https://url2.com metadata: description: >- An object containing any number of metadata keys and values. Keys and values must be strings. type: object example: mobile_only: 'false' TNR: '15' trusted_redirect_domains: description: >- An array containing any number of trusted redirect domains. Values must always be valid domains, e.g. `example.com`, `*.example.com`, or custom protocols like `tel:342682346`. **NOTE:** This only applies to ad items which will be used in a zone with a 3rd party click macro implementation. type: object example: - example.com - '*.example.com' - tel:342682346 is_self_serve: description: Whether or not this ad item is from Self-Serve. type: boolean readOnly: true example: false type: object image_ad_item: properties: creative: description: >- The image creative identifier (ID). Only one of `creative` or `creative_url` can be given in a POST, but one must be given. To swap an ad item to use `creative_url` instead of `creative` in a PUT, set `creative` to __null__. type: string example: null creative_url: description: >- A URL leading to an image file (PNG, JPEG, or GIF). Only one of `creative` or `creative_url` can be given in a POST, but one must be given. To swap an ad item to use `creative` instead of `creative_url` in a PUT, set `creative_url` to __null__. type: string example: https://ads.hakumedia.ai/default_banner.gif html_alt_text: description: >- Textual description of the image creative intended to be used by Assistive Technologies or if the image fails to load. type: string example: The Haku Logo html_target: description: >- The window/frame in which the destination URL should load when clicked. Leave this field as __null__ to open in the same tab. Another common option is __"\_blank"__ for a new window or tab, but many options are available. type: string example: _blank html_content_below: description: The HTML content that will appear below the ad item. type: string example: