add

Creates extensions.

  1. Restrictions
  2. Request
  3. Response

Only one type of extension, the callout, is available at this time.

Restrictions

To get the limit on the number of extensions for an advertiser, use the method Clients.get or AgencyClients.get (see the AD_EXTENSIONS_TOTAL element in the Restrictions array).

Maximum of 1000 extensions per method call.

If there are identical extensions, an error is returned for each of them.

Request

Request structure in JSON format:

{
  "method": "add",
  "params": { /* params */
    "AdExtensions": [{  /* AdExtensionAddItem */
      "Callout": {  /* Callout */
        "CalloutText": (string) /* required */
      }
    }, ... ] /* required */
  }
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / AddRequest structure (for SOAP)
AdExtensionsarray of AdExtensionAddItemExtensions to add.Yes
AdExtensionAddItem structure
CalloutCalloutA callout.No
Callout structure
CalloutTextstringCallout text. Maximum of 25 characters.No

Response

Response structure in JSON format:

{
  "result": { /* result */
    "AddResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ] 
    }, ... ]
  }
}
ParameterTypeDescription
Result structure (for JSON) / AddResponse structure (for SOAP)
AddResultsarray of ActionResultResults of adding extensions.
ActionResult structure
Idlong

ID of the created extension. Returned if there aren't any errors. See the section Operations on object arrays.

Warningsarray of ExceptionNotification

Warnings that occurred during the operation.

Errorsarray of ExceptionNotification

Errors that occurred during the operation.