get

Returns sets of negative keywords.

Learn more

How the "get" method works

Request

Request structure in JSON format:

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */
    },
    "FieldNames": [( "Id" | "Name" | "NegativeKeywords" | "Associated" ), ... ] /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}

Parameter	Type	Description	Required
params structure (for JSON) / GetRequest (for SOAP)
`SelectionCriteria`	IdsCriteria	Criteria for selecting sets of negative keywords. If omitted, all sets of negative keywords belonging to the advertiser are returned.	No
`FieldNames`	array of NegativeKeywordSharedSetFieldEnum	Names of top-level parameters to get.	Yes
`Page`	LimitOffset	Structure that defines the page for paginated selection of data.	No
IdsCriteria structure
`Ids`	array of long	Selects sets of negative keywords with the specified IDs. Maximum of 30 items in the array.	Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "NegativeKeywordSharedSets": [{  /* NegativeKeywordSharedSetGetItem */
      "Id": (long),
      "Name": (string),
      "NegativeKeywords": [(string), ... ],
      "Associated": ( "YES" | "NO" )
    }, ... ],
    "LimitedBy": (long)
  }
}

Parameter	Type	Description
result structure (for JSON) / GetResponse (for SOAP)
`NegativeKeywordSharedSets`	array of NegativeKeywordSharedSetGetItem	Sets of negative keywords.
`LimitedBy`	long	Sequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection.
NegativeKeywordSharedSetGetItem structure
`Id`	long	ID of the set of negative keywords.
`Name`	string	Name of a set of negative keywords (maximum 255 characters).
`NegativeKeywords`	array of string	Array of negative keywords. A keyword should be specified without the minus sign before the first word. Maximum of 7 words per keyword. The maximum length of each word is 35 characters. The maximum combined length of negative keywords in the array is 4096 characters. Spaces, dashes, and operators are not counted as part of the total length.
`Associated`	YesNoEnum	Whether the set of negative keywords is assigned to at least one ad group.

Was the article helpful?

delete

update