Skip to main content

image_link

Required Field

This field is required and must not be omitted

Description​

Add it to improve search results and listing. If you have more then one image you can use the additional_image_link attribute to include more.

Effects When Used​

  • Adding image helps us indexing the product
  • In case of new products we can present the offer along with it's image. This makes it easier for users to find the product in the product listing.

Validation Rules​

  • Url length is limited to 2047 characters
  • Must be valid RFC 3986 uri
  • Must have a protocol (eg. https)
  • Must have a path (eg. .../my-product)
  • Must be shorter than 2047 characters
  • Unicode characters must be url encoded

Best Practices​

Do​

  • Make sure the url is encoded
  • If product has variants, make sure the image presents the proper product variant
  • Prefer using high resolution images at least 300x300 pixels size, the bigger size the better
  • The product should be in the center of the image
  • Prefer a white background without added content
  • Prefer professional images, shadows from the camera flash or bad image setup is often an indicator of amateur images, although any image is better than no image

Don't​

  • Supply URIs to other things than images
  • Don't put "stickers" in the images, eg. with "30% off" "new" or "SALE"
  • Don't watermark the images eg. with the store logo or name

Example Values​

Here are examples of how a valid image_link value should look like in XML and CSV (with header) respectively.

Valid Value
<g:image_link>http://example.com/link</g:image_link>
Click to show more valid XML examples
<g:image_link>http://example.com/link</g:image_link>
<g:image_link>https://example.com/link</g:image_link>
<g:image_link>https://example.com/link(black)_(large)</g:image_link>
<g:image_link>https://example.com/link#foo</g:image_link>
<g:image_link><![CDATA[https://example.com/link?utm_source=1&utm_medium=2]]></g:image_link>
<g:image_link>http://example.com/link-%E2%84%A2-mu-20%C2%B5m</g:image_link>
<g:image_link>ftp://example.com/link</g:image_link>

Error Codes​

Below you will find possible error codes generated when validating this field alongside with an example in XML and CSV that would trigger the code. Please refer to the validation rules to understand the cause.

validation_invalid_length
<g:image_link>https://example.com/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa (more than 2047 characters value)</g:image_link>
validation_invalid_url
<g:image_link>http://bar</g:image_link>
validation_invalid_url_fragment
<g:image_link>https://example.com/link##</g:image_link>
validation_invalid_url_host
<g:image_link>http://example%.com/link</g:image_link>
validation_invalid_url_path
<g:image_link>https://example.com/link[12-34]</g:image_link>
validation_invalid_url_port
<g:image_link>http://example.com:foo/link</g:image_link>
validation_invalid_url_query
<g:image_link>https://example.com/link?param=value^up-arrow</g:image_link>
validation_url_scheme_not_allowed
<g:image_link>foo://example.com/link</g:image_link>
<g:image_link>ftps://example.com/link</g:image_link>
<g:image_link>sftp://example.com/link</g:image_link>

Properties​

PropertyValueDescription
Data TypestringClosest data type in code
NestedFalseDefines if this field consists of one or more sub-fields
Case SensitiveTrueIf small or large letters matter for this field
RepeatableFalseIf you can supply multiple items of this field (it´s a list)
Repeatable limit0If a list, this specifices the max number of items

Changelog​

📅 2024-03-30

Added

Initial definition

References​