add
Creates extensions.
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 */
}
}
Parameter | Type | Description | Required |
Params structure (for JSON) / AddRequest structure (for SOAP) | |||
---|---|---|---|
AdExtensions | array of AdExtensionAddItem | Extensions to add. | Yes |
AdExtensionAddItem structure | |||
Callout | Callout | A callout. | No |
Callout structure | |||
CalloutText | string | Callout text. Maximum of 25 characters. | No |
Parameter | Type | Description | Required |
Params structure (for JSON) / AddRequest structure (for SOAP) | |||
---|---|---|---|
AdExtensions | array of AdExtensionAddItem | Extensions to add. | Yes |
AdExtensionAddItem structure | |||
Callout | Callout | A callout. | No |
Callout structure | |||
CalloutText | string | Callout 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)
}, ... ]
}, ... ]
}
}
Parameter | Type | Description |
Result structure (for JSON) / AddResponse structure (for SOAP) | ||
---|---|---|
AddResults | array of ActionResult | Results of adding extensions. |
ActionResult structure | ||
Id | long | ID of the created extension. 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. |
Parameter | Type | Description |
Result structure (for JSON) / AddResponse structure (for SOAP) | ||
---|---|---|
AddResults | array of ActionResult | Results of adding extensions. |
ActionResult structure | ||
Id | long | ID of the created extension. 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. |