Finding All AG Creatives Statuses

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Jun 15, 2017
Version 3Show Document
  • View in full screen mode

Overview

This API allows you to find all AG Creatives in the PubMatic system. 

Note: Creatives cannot be approved or rejected, therefore, the status of creatives will remain as "pending," regardless of actual status. This feature is expected to be updated in future iterations of Automated Guaranteed.

Request

           

URIHTTP Method

$URI_PREFIX/creatives/status/all

GET

Request Headers

                               

Header NameTypeValueRequiredDescription
pubTokenString${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

resourceId

Integer 

Yes

Resource ID (Owner ID)

resourceTypeId 

Integer 

Yes

Type of Resource (e.g., Publisher = 1)

Request Query Parameters

                           

ParameterTypeRequiredDescription
pageNumberIntegerNoPage number to be fetches in case of multiple pages. Its default value is 100.

pageSize

IntegerNoMaximum number of rows to be included in the response. Its default value is 1.
filtersArray[string]No

Filters list, filter syntax:[field operation value], valid operations: eq noteq like notlike.
Example: To filter list of all creatives by the status APPROVED:
&filters=creativeStatus eq APPROVED

 

See Filter Parameter Details for more information.

Note that multiple Ids can be entered in a filter to retrieve a status for more than one ID.

Request URL

    

GET $URI_PREFIX/creatives/status/all?{pageNumber}&{pageSize}

Response

Response Code

           

TypeDescription
200Success

Response Header

           

Response Header NameType
content-typeapplication/json

Sample Response JSON

    

 

{
  "content": [
    {
      "id": 20,
      "publisherId": 301,
      "creative": {
        "id": 29,
        "externalId": "Advert_101",
        "name": "string",
        "advertiser": "Advert_Company",
        "width": 0,
        "height": 0,
        "tag": "string",
        "url": "string",
        "ownerId": 301,
        "ownerTypeId": 1
      },
      "creativeStatus": "APPROVED"
    },

  ],
  "last": false,
  "totalPages": 11,
  "totalElements": 11
  "sort": [
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false
    }
  ],
  "numberOfElements": 1,
  "first": true,
  "size": 1,
  "number": 0
}

                     

Response Messages

StatusReasonDescription
401UnauthorizedAuthentication or Authorization failure. Check the response body for specific details.
403ForbiddenThe request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404Not FoundThe requested resource could not be found.

Attachments

    Outcomes