ResponseEnvelope

The standard response envelope for all Recommendations and Suggestions API endpoints.

Declaration

object RecommendationResponseBody

Properties

Name	Type	Description
`result`	`RecommendationResponseBody.Result`	Usually an array of recommendation, suggestion, or history objects returned by the endpoint. A single object for the Target CPA suggestion query response. Read-only.
`pagination`	`RecommendationResponsePagination`	Pagination metadata for the result set. See ResponsePagination. Read-only.
`error`	`RecommendationResponseError`	Error information when the request fails. Absent on success. See ResponseError. Read-only.

Discussion

The response envelope is the standard wrapper returned by all Recommendations and Suggestions endpoints.

The result field contains the response payload. It’s usually an array, but for the Target CPA suggestion query response (RecommendationQueryTargetCpaSuggestionResponse) specifically, it’s a single object, since that endpoint always returns one suggestion rather than a list.

The pagination field describes the current page position and is null for apply and dismiss responses.

Example

{
  "result": [
    {
      "id": "rec-budget-001",
      "recommendationType": "DAILYCAP",
      "campaignId": 789012,
      "state": "AVAILABLE"
    }
  ],
  "pagination": {
    "offset": 0,
    "pageSize": 20,
    "totalCount": 1
  }
}

Topics

Dictionaries

RecommendationResponseBody.Result