get

Returns the parameters of creatives that match 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": {
    "SelectionCriteria": { /* CreativesSelectionCriteria */ 
      "Ids": [(long), ... ],
      "Types": [( "IMAGE_CREATIVE" | "HTML5_CREATIVE" | "VIDEO_EXTENSION_CREATIVE" | "CPC_VIDEO_CREATIVE" ), ... ]
    }, /* required */
    "FieldNames": [( "Id" | "Type" | "Name" | "PreviewUrl" | "Width" | "Height" | "ThumbnailUrl" | "Associated" ), ... ], /* required */ 
    "VideoExtensionCreativeFieldNames": [( "Duration" ), ... ],
    "CpcVideoCreativeFieldNames": [( "Duration" ), ... ],
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}

Parameters are described below.

ParameterTypeDescriptionRequired
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteriaCreativesSelectionCriteria

Criteria for selecting creatives.

To get all of an advertiser's creatives, leave SelectionCriteria empty.

Yes
FieldNamesarray of AdFieldEnum

Names of top-level parameters to get.

Yes
VideoExtensionCreativeFieldNamesarray of VideoExtensionCreativeFieldNamesThe names of the parameters for video extension creatives to get. See Type of creative.
Note. If a different type of ad is selected according to SelectionCriteria, parameters from VideoExtensionCreativeFieldNames are not returned.
No
CpcVideoCreativeFieldNamesarray of CpcVideoCreativeFieldEnumNames of parameters to get for video ad creatives in “Text & Image Ads” campaigns.
Note. If a different type of ad is selected according to SelectionCriteria, parameters from CpcVideoCreativeFieldNames are not returned.
No
PageLimitOffset

Structure that defines the page for paginated selection of data.

No
CreativesSelectionCriteria structure
Idsarray of longSelects creatives with the specified IDs. From 1 to 10,000 items in the array.No
Typesarray of CreativeTypeEnum

Selects creatives of the specified types. See Type of creative.

No

Response

Response structure in JSON format:

{
  "result": { /* result */
    "Creatives": [{  /* CreativeGetItem */
      "Id": (long),
      "Type": ( "IMAGE_CREATIVE" | "HTML5_CREATIVE" | "VIDEO_EXTENSION_CREATIVE" | "CPC_VIDEO_CREATIVE" ), 
      "Name": (string),
      "PreviewUrl": (string),
      "Width": (int),
      "Height": (int),
      "ThumbnailUrl": (string),
      "Associated": ( "YES" | "NO" )
      "VideoExtensionCreative": {  /* VideoExtensionCreativeGet */
        "Duration": (int) /* required */
      },
      "CpcVideoCreative": {  /* CpcVideoCreativeGet */
        "Duration": (int) /* required */
      }
    }, ... ],
    "LimitedBy": (long)
  }
}

Parameters are described below.

ParameterTypeDescription
Result structure (for JSON) / GetResponse (for SOAP)
Creativesarray of CreativeGetItemAds.
LimitedBylongSequential 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.
CreativeGetItem structure
IdlongID of the creative.
TypeCreativeTypeEnumType of creative. See Type of creative.
NamestringName of the video creative or group of image creatives.
PreviewUrlstringLink for previewing.
WidthintWidth of the creative.
HeightintHeight of the creative.
ThumbnailUrlstringURL for the preview thumbnail.
AssociatedYesNoEnumWhether the creative is assigned to at least one of the client's ads.
VideoExtensionCreativeVideoExtensionCreativeGetParameters of the video extension creative.
CpcVideoCreativeCpcVideoCreativeGetParameters for video ad creatives in “Text & Image Ads” campaigns.
VideoExtensionCreativeGet structure
DurationintThe length of the video in seconds.
CpcVideoCreativeGet structure
DurationintThe length of the video in seconds.