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: /platform-targets: get: tags: - Platform Targets summary: Get a List of Platform Targets description: >- You can use the `fields` query parameter to restrict the fields to be retrieved. parameters: - $ref: '#/components/parameters/list_limit' - $ref: '#/components/parameters/list_offset' - $ref: '#/components/parameters/list_ids' - $ref: '#/components/parameters/fields' responses: default: description: successful operation content: application/json: schema: $ref: '#/components/schemas/platform_target_list' components: parameters: list_limit: name: limit in: query description: >- The number of objects returned in the response, sometimes called "take". The max value is __100__. schema: type: integer list_offset: name: offset in: query description: The position to start the retrieval of objects, sometimes called "skip". schema: type: integer list_ids: name: id in: query description: >- A list of IDs by which to filter the list of objects returned. Formatted as a list of the IDs separated by commas. (For example: __"1134, 1153, 1138, 1176"__) schema: type: string 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: platform_target_list: type: object allOf: - $ref: '#/components/schemas/list' - properties: url: description: The URL of the current resource list. type: string example: /v2/platform-targets data: type: array items: $ref: '#/components/schemas/platform_target_get' type: object list: properties: object: description: For list resources, the value of 'object' will always be 'list'. type: string example: list has_more: description: True if there are more data beyond the offset and limit. type: boolean example: false limit: description: The number of resources to return. Sometimes called 'take'. type: integer example: 10 offset: description: >- The number of resources in sequence to ignore, sometimes called 'skip'. type: integer example: 0 type: object platform_target_get: properties: object: description: A string denoting the current resource being requested or affected. type: string example: platform_target id: description: The current resource identifier (ID). type: integer example: 3654 self: description: >- The relative URL of the current resource being requested or affected. type: string example: /v2/platform-targets/3654 type: object allOf: - $ref: '#/components/schemas/platform_target' platform_target: type: object allOf: - properties: name: description: The name of the platform target. type: string example: Focus LG G Series platform: description: >- A preset platform target including devices of a certain form factor. Possible values are **"any"** (also called **"specific"**), **"mobile"**,**"tablet"**,**"mobile_and_tablet"**, and **"desktop"**. When this field is set to a value other than **"any"** or **"specific"**, the browser and OS targets will all be enabled and cannot be disabled or customized. type: string example: any type: object - $ref: '#/components/schemas/platform_target_deprecated_browser_os' - $ref: '#/components/schemas/platform_target_new_browser_os' - properties: device_targets: description: >- The list of device-specific patterns to target. For example, __"Apple*"__ will target all Apple devices and __"Samsung Galaxy S5"__ will only target devices with that name. Device targeting is not available for the __"desktop"__ platform. type: array items: example: LG G* example: - Focus LG G type: object - properties: resolution_targets: description: >- An object containing a breakdown of the resolution targets. The resolution targets allow you to target different screen sizes. properties: small: description: Whether the target should include small screen sizes. type: boolean example: true medium: description: Whether the target should include medium screen sizes. type: boolean example: true large: description: Whether the target should include large screen sizes. type: boolean example: true small_resolution_end: description: >- Where the small screen size range ends. All screen sizes between 0 and this value will be considered small. type: number format: integer example: 599 medium_resolution_end: description: >- Where the medium screen size range ends. All screen sizes between small_resolution_end and this value will be considered medium. type: number format: integer example: 1199 type: object type: object platform_target_deprecated_browser_os: properties: desktop_browser_targets: description: >- A list of desktop internet browsers to target. The list may include any combination of **"chrome"**, **"safari"**, **"firefox"**, **"opera"**, **"edge"**, **"ie"**, and **"others"**. The **"others"** option encompasses all other possible desktop browsers not in this list. type: array items: {} example: - chrome - firefox - others deprecated: true mobile_browser_targets: description: >- A list of mobile internet browsers to target. The list may include any combination of **"chrome"**, **"safari"**, **"firefox"**, **"opera"**, **"blackberry"**, **"uc"**, **"edge"**, **"samsung"**, and **"others"**. The **"others"** option encompasses all other possible mobile browsers not on this list. type: array items: example: chrome deprecated: true desktop_os_targets: description: >- The list of desktop operating systems to target. The list may include any combination of **"mac"**, **"windows"**, **"chromeos"**, **"ubuntu"**, **"linux"**, and **"others"**. The **"others"** option encompasses all other possible desktop operating systems not in this list. type: array items: {} example: - chromeos - others deprecated: true mobile_os_targets: description: >- The list of mobile operating systems to target. The list may include any combination of **"android"**, **"ios"**, **"blackberry"**, **"windows_phone"**, and **"others"**. The **"others"** option encompasses all other possible mobile operating systems not in this list. type: array items: example: android deprecated: true type: object platform_target_new_browser_os: properties: browser_targets: description: >- An object containing a breakdown of the available browser targets, organized by mobile and desktop. When creating or updating the target, setting this field's value to **true** will enable every browser target for both mobile and desktop options. Specific browsers may be targeted by providing their name and setting the name's value to **true** to include the browser in the target or **false** to exclude the browser. Cannot set this field to **false**, because if no browsers are allowed to match then there will never be a positive match to the target. properties: desktop: description: >- All desktop browsers available for platform targeting. When creating/updating the target, setting this value to __true__ will enable every desktop browser target and setting it to __false__ will disable all targets. However, if all browser targets in mobile and desktop are disabled, the system will treat it as they are all enabled; if no browsers are allowed to match then there will never be a positive match to the target.