Find an AG Creative

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

Overview

This API allows you to find an AG Creative.

Request

           
URIHTTP Method

$URI_PREFIX/creatives/find

GET

Request Headers

                               
Header NameTypeValueRequiredDescription
pubTokenString${access_token}Yes

Need to send the access token generating for authentication at the place of ${access_token}.

For more information about access token; please check Before you Start section.

resourceId

Integer 

Yes

Resource ID (Owner ID)

resourceTypeId 

Integer 

Yes

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

Request Query Parameters

                     
Parameter NameTypeRequiredDescription
externalIdStringYesID used by external service
ownerIdLongYesResource ID of the creator of the creative

 

Request URL

    

GET $URI_PREFIX/creatives/find?{externalId}&{ownerId}

Response

Sample JSON Response

    
{
  "id": 33,
  "externalId": "123456",
  "advertiser": " 247Loans.com",
  "width": 728,
  "height": 90,
  "tag": "<>",
  "url": "http://ourdomain.com",
  "ownerId": 31445,
  "ownerTypeId": 1
}

Response Code

           
TypeDescription
200OK

Response Header

             
Response Header Name
Type
Description
content-typeapplication/jsonMedia type that is to be returned in search/sort operation

 

Error Codes

                       

Status

Error Message

Description

401

Unauthorized

Authentication or Authorization failure. Check the response body for specific details.

403

Forbidden

You are not subscribed to this feature of the Platform.
404Not FoundThe requested resource could not be found.

Attachments

    Outcomes