Get

Returns keyword productivity values. The keywords may be for different campaigns or ad groups.

Attention.

Disabled method. Use version 5 of the API.

For information about the compatibility of methods between versions Live 4 and 5, see the Migration guide.

Restrictions

Attention. This method only supports campaigns with the “Text & Image Ads” type. To manage keywords in all types of campaigns, use the Keywords service in version 5 of the API.

Input data

The input data structure in JSON is shown below.

{
   "method": "Keyword",
   "param": {
      /* KeywordRequest */
      "Action": (string),
      "Login": (string),
      "KeywordIDS": [
         (long)
         ...
      ]
   }
}

Parameters are described below.

Parameter Description Required
KeywordRequest object
Action Action: Get. Yes
Login

The username of the client to perform the operation for.

A direct advertiser can optionally specify the username of a chief representative.

For agencies
KeywordIDS Array of keywords IDs (maximum 10,000). Yes

Output data

The output data structure in JSON is shown below.

{
   "data": {
      /* KeywordResponse */
      "ActionsResult": [
         {  /* KeywordActionResult */
            "KeywordID": (long),
            "QualityIndex": {
               /* QualityIndex */
               "Value": (decimal),
               "References": [
                  (int)
                  ...
               ]
            },
            "Errors": [
               {  /* Error */
                  "FaultCode": (int),
                  "FaultString": (string),
                  "FaultDetail": (string)
               }
               ...
            ]
         }
         ...
      ]
   }
}

Parameters are described below.

Parameter Description
KeywordResponse object
ActionsResult
Array of KeywordActionResult objects. Each object corresponds to an item in the KeywordIDS input array and contains:
  • Keyword ID.
  • Keyword productivity.
  • An array of Errors if data could not be obtained for the keyword.
KeywordActionResult object
KeywordID Keyword ID.
QualityIndex An object containing the keyword's productivity value and recommendations for improving it.
Errors Array of Error objects with errors that occurred while performing the operation.
QualityIndex object
Value Productivity value for the keyword (to the first decimal place).
References Array of numbers of recommendations for this keyword. To get the list of recommendations, use the Dictionaries.get method for the API version 5.
Error object
FaultCode Error code.
FaultString Textual message about the error.
FaultDetail Detailed description of the reason for the error.

Examples of input data

Python

{
   'Action': 'Get',
   'Login': 'agrom',
   'KeywordIDS': [199381759,199482870,200725193]
}

PHP

array(
   'Action' => 'Get',
   'Login' => 'agrom',
   'KeywordIDS' => array(199381759,199482870,200725193)
)

Perl

{
   'Action' => 'Get',
   'Login' => 'agrom',
   'KeywordIDS' => [199381759,199482870,200725193]
}