Creative Reviewer API

Abstract

Provides publishers with an easy way to control which ads are displayed on their websites.

Overview

This API provides methods for creating and updating creative reviews. It also provides methods for retrieving creatives for a specific supply.

The API allows blocking of ads and product ads per supply.

Fields

The Creative Reviewer contains the following fields:

Name

Description

Type

Add

Update

demandEntityType

The Demand entity type on which review is being performed. AD or PRODUCT_AD.

enum

Required

Required

demandEntityId

The Demand entity ID on which review is being performed. Ad ID or product ad ID.

long

Required

Required

demandEntityEditorialVersion

Editorial version of the demand.

long

Optional

Optional

supplyEntityType

Type of the entity conducting the review, for example, PUBLISHER.

string

Required

Optional

supplyEntityId

The Id of the entity conducting the review, for example, publisher id.

long

Required

Required

supplyContextType

The Type of child entity or itself conducting the review, for example, PUBLISHER/SITE/POLICY_GROUP.

enum

Required

Required

supplyContextEntityRef

Entity reference ie id of a website or publisher ID or POLICY_GROUP name that this creative is being reviewed on.

string

Required

Required

reason

The reason for blocking.

string

Optional

Optional

reviewResult

Review result that tells whether the demand entity being reviewed is REJECTED/ACCEPTED.

enum

Required

Required

reviewStatus

Review status of that tells whether the review is completed or pending. For ex: PENDING, COMPLETED.

enum

Required

Optional

escalationStatus

Escalation status of the review. Valid input values are: ESCALATED, NONE.

enum

Optional

Optional

publisherId

The publisherId that this review belongs to.

long

Required

Required

Endpoint

Resource URI

https://api.gemini.yahoo.com/v3/rest/creativereviewer

Operations

Create/Update a review

Method: To create/update one or more creative reviews, make a POST call to the creativereview endpoint with the required fields. Batch create is supported; either a creativereview or a creativereview array can be passed. The response will be the newly created creativereview, or a list of multiple new reviews if an array is passed.

For example: To create or update a creativereview, make a POST call to this endpoint:

POST https://api.gemini.yahoo.com/v3/rest/creativereviewer


Data passed

{
        "demandEntityType": "AD",
        "demandEntityId": 100,
        "demandEntityEditorialVersion": 1,
        "publisherId": 10,
        "supplyContextType": "POLICY_GROUP",
        "supplyContextEntityRef": "APPLE_NATIVE",
        "reviewResult": "APPROVED",
        "reason": null,
        "reviewStatus": "COMPLETED",
        "escalationStatus": "NONE"
}


Example response

  {
    "errors": null,
    "response": {
      {
           "demandEntityType": "AD",
                "demandEntityId": 100,
                "demandEntityEditorialVersion": 1,
                "publisherId": 10,
                "supplyContextType": "POLICY_GROUP",
                "supplyContextEntityRef": "APPLE_NATIVE",
                "reviewResult": "APPROVED",
                "reason": null,
                "reviewStatus": "COMPLETED",
                "escalationStatus": "NONE"
    }
 }

Read Specific creatives for a supply

Method: To retrieve creatives for a specific supply, make a GET call with the following parameters.

For example: Make a GET call to retrieve a creativereview with ID=5605348

 GET  https://api.gemini.yahoo.com/v3/rest/creativereview?publisherId=10&supplyContextType=POLICY_GROUP&supplyContextRef=APPLE_NATIVE&reviewStatus=COMPLETED&escalationStatus=NONE


 Example response
 [
       {
 "demandEntityType": "AD",
 "demandEntityId": 100,
 "demandEntityEditorialVersion": 1,
 "publisherId": 10,
 "supplyContextType": "POLICY_GROUP",
 "supplyContextEntityRef": "APPLE_NATIVE",
 "reviewResult": "APPROVED",
 "reason": null,
 "reviewStatus": "COMPLETED",
 "escalationStatus": "NONE"
  }
]