.. index:: Advertisement, Images

.. _advertisement_images:

Advertisement images
====================

Collection of :ref:`image <image>` representations.

Currently the only way to attach an image to an advertisement is by issuing a POST against the images resource with a
post body that contains a list of urls. A placeholder image will be created for each of the uploaded images.
The real images are downloaded in the background and the placeholder images will be updated when downloading completes.
An image will have its status attribute set to downloading until downloading completes. Clients
interested in knowing when the image download has completed should poll the image resource and wait until the status
attribute changes.
The images will be attached to the advertisement in the order they are provided.

Each ad can contain up to 24 images. This limit is different for car dealers.

For Basic dealers the ad can contain up to 24 images, Plus dealer ads can contain up to 35 images and Premium dealer
ads have a maximum of 99 images.


An image is valid if it is in JPG, PNG or BMP format and is smaller than 8MB
in size. GIF images are not supported. Images will automatically be resized. It is not recommended to upload images
with a size which doesn't fit in 1024x1024 pixels box.

Note: Each url will only be downloaded once for each advertisement. Therefore if the image changes but the url stays the
same then the image will *not* be re-downloaded. In this case you need to give the changed image a new url.

Reference
---------

.. endpoint:: GET /v1/advertisements/{itemId}/images

Get all images for an advertisement

.. endpoint:: POST /v1/advertisements/{itemId}/images

Add or replace images for an advertisement


Examples
--------

.. include:: examples/get-images-example.rst

.. include:: examples/async-add-image-example.rst