suspend

Suspends displays for dynamic text ad targets.

Learn more

Restrictions

A maximum of ids-select dynamic text ad targets per method call.

Request

Request structure in JSON format:

{
  "method": "suspend",
  "params": { /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long)] /* required */
    } /* required */
  }
}

Parameter	Type	Description	Required
params structure (for JSON) / SuspendRequest structure (for SOAP)
`SelectionCriteria`	IdsCriteria	Criteria for selecting dynamic text ad targets to suspend displays for.	Yes
IdsCriteria structure
`Ids`	array of long	IDs of the dynamic text ad targets that you want to stop (a maximum of `ids-select`).	Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "SuspendResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...  ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ]
    }, ...  ] /* required */
  }
}

Parameter	Type	Description
result structure (for JSON) / SuspendResponse structure (for SOAP)
`SuspendResults`	array of ActionResult	Results of suspending displays for dynamic text ad targets.
ActionResult structure
`Id`	long	ID of a dynamic text ad target. Returned if there aren't any errors. See the section Operations on object arrays.
`Warnings`	array of ExceptionNotification	Warnings that occurred during the operation.
`Errors`	array of ExceptionNotification	Errors that occurred during the operation.

Was the article helpful?

setBids

DynamicTextAdTargets: managing dynamic text ad targets