get

Returns images that meet the specified criteria.

  1. Restrictions
  2. Request
  3. Response

Restrictions

The method returns a maximum of 10,000 objects.

Request

Request structure in JSON format:

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* AdImageSelectionCriteria */
      "AdImageHashes": [(string), ... ],
      "Associated": ( "YES" | "NO" )
    },
    "FieldNames": [( "AdImageHash" | "OriginalUrl" | "PreviewUrl" | "Name" | "Type" | "Subtype" | "Associated" )], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
Parameter Type Description Required
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteria AdImageSelectionCriteria

Criteria for selecting images. If omitted, all the advertiser's images are returned.

No
FieldNames array of AdImageFieldEnum

Names of parameters of images to get.

Yes
Page LimitOffset

Structure that defines the page for paginated selection of data.

No
AdImageSelectionCriteria structure
AdImageHashes array of string Selects images with the specified hashes. Maximum of 10,000 items in the array. No
Associated YesNoEnum Selects images based on whether they are assigned to ads: YES — assigned; NO — unassigned. No

Response

Response structure in JSON format:

{
  "result": { /* result */
    "AdImages": [{  /* AdImageGetItem */
      "AdImageHash": (string),
      "Name": (string),
      "Associated": ( "YES" | "NO" ),
      "Type": ( "SMALL" | "REGULAR" | "WIDE" | "FIXED_IMAGE" | "UNFIT" ),
      "Subtype": ( "IMG_240_400" | "IMG_300_250" | "IMG_300_500" | "IMG_300_600" | "IMG_336_280" | "IMG_640_100" | "IMG_640_200" | "IMG_640_960" | "IMG_728_90" | "IMG_960_640" | "IMG_970_250" | "NONE" ),
      "OriginalUrl": (string), /* nillable */
      "PreviewUrl": (string) /* nillable */
    }, ... ],
    "LimitedBy": (long)
  }
}
Parameter Type Description
Result structure (for JSON) / GetResponse (for SOAP)
AdImages array of AdImageGetItem Images.
LimitedBy long Sequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection.
AdImageGetItem structure
AdImageHash string Hash of the image.
Name string Caption for the image. Maximum of 255 characters.
Associated YesNoEnum Whether the image is assigned to at least one of the client's ads.
Type AdImageTypeEnum The type of image. See Image type.
Subtype AdImageSubtypeEnum The image size for the FIXED_IMAGE type. For images with a type other than FIXED_IMAGE, the value NONE is returned.
OriginalUrl string, nillable A link to the full-size image.
PreviewUrl string, nillable A link to the image preview.