GOgoogle
customers

POST /v23/customers/{customersId}:generateKeywordIdeas

Returns a list of keyword ideas. List of thrown errors: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError KeywordPlanIdeaError QuotaError RequestError

Request

  • Base URL
    https://searchads360.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/doubleclicksearch
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/doubleclicksearch
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

customersIdstring required

Request body

geoTargetConstantsstring[]

The resource names of the location to target. Maximum is 10. An empty list MAY be used to specify all targeting geos.

includeAdultKeywordsboolean

If true, adult keywords will be included in response. The default value is false.

keywordAnnotationstring[]

The keyword annotations to include in response.

keywordPlanNetwork'UNSPECIFIED' | 'UNKNOWN' | 'GOOGLE_SEARCH' | 'GOOGLE_SEARCH_AND_PARTNERS'

Targeting network. If not set, Google Search And Partners Network will be used.

languagestring

The resource name of the language to target. Each keyword belongs to some set of languages; a keyword is included if language is one of its languages. If not set, all keywords will be included.

pageSizeinteger

Number of results to retrieve in a single page. A maximum of 10,000 results may be returned, if the page_size exceeds this, it is ignored. If unspecified, at most 10,000 results will be returned. The server may decide to further limit the number of returned resources. If the response contains fewer than 10,000 results it may not be assumed as last page of results.

pageTokenstring

Token of the page to retrieve. If not specified, the first page of results will be returned. To request next page of results use the value obtained from next_page_token in the previous response. The request fields must match across pages.

Response

Successful response

nextPageTokenstring

Pagination token used to retrieve the next page of results. Pass the content of this string as the page_token attribute of the next request. next_page_token is not returned for the last page.

totalSizestring int64

Total number of results available.

Changes

No recorded changes to this operation across all 4 revisions of this API.