Docs
Пошук документації...⌘K

Update Keyword list

API + MCP
PATCH/v3/management/keyword-lists

Requests to this endpoint are free and do not consume any API units.

Name, location, and keyword changes commit before folder and access changes. If the folder or access update fails, earlier changes are not rolled back.

Параметри запиту

outputstring

Формат виводу.

Дозволені значення:jsonphpxml

Тіло запиту

keyword_list_idintegerRequired

The ID of the keyword list to update.

namestring

The new name. Omit to preserve the current name.

locationstring

The location of the keyword list. Specify a country code for one country, or 'all' for all locations. When using 'all', optionally provide 'countries' to restrict the list to selected countries. All locations and selections of multiple countries require Global Mode.

Дозволені значення:allafaldzasadaoaiagaramauatazbs…
countriesarray<string>

Up to 15 country codes to select when location is 'all'. Omit for all locations.

Дозволені значення:adaeafagaialamaoarasatauawazba…
Макс.:15
keywords

The keyword operation. Omit to preserve the current keywords.

Add keywords not already in the list. Duplicate keywords are ignored.

operationstringrequired
Дозволені значення:add
keywordsarray<string>required
Хв:1
accessstring

The new access setting.

Дозволені значення:privateshared
folder

A folder operation, applied before the access change.

Remove the keyword list from its folder.

operationstringrequired
Дозволені значення:remove

Відповіді

keyword_listobject
accessstring

The access type of the keyword list.

Дозволені значення:privateshared
countriesarray<string>

Up to 15 country codes to select when location is 'all'. Omit for all locations.

folder_idstring or null

The ID of the keyword list's folder, if any.

keyword_countinteger

The number of keywords in the list.

keyword_list_idstring

The ID of the keyword list.

keywordsarray<string>

All current keywords in the list. Empty if the list has no keywords.

locationstring or null

The location of the keyword list. Specify a country code for one country, or 'all' for all locations. When using 'all', optionally provide 'countries' to restrict the list to selected countries. All locations and selections of multiple countries require Global Mode.

Дозволені значення:allafaldzasadaoaiagaramauatazbs…
namestring

The name of the keyword list.

owned_bystring or null

The email of the keyword list owner, if available.