keywords

Save the keyword field of one localization

Replaces the keyword field of one App Store localization with the normalized, deduplicated phrases of text, ships the localization when it is not shipped yet, and tracks every phrase in each market of trackIn. trackIn may be empty and must name only markets of the app whose storefront reads the localization. A phrase removed from the field stops being tracked as a keyword field phrase in every market that reads the localization, unless another saved field read there holds it. Answers 400 when the text runs past 100 characters, when trackIn names a country that is not a market of the app or a storefront that does not read the localization, and for a Google Play or competitor app. Answers 403 with quota and writes nothing when the keyword markets would pass the plan limit. Answers 404 for a missing app, and for an empty save of a localization the app does not ship. Saves to one app are written one at a time, so the last save wins.

PUT

/

apps

/

{id}

/

keyword-fields

/

{localization}

Save the keyword field of one localization

curl --request PUT \
  --url http://localhost:3000/api/backend/apps/{id}/keyword-fields/{localization} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "habit,tracker,streak",
  "trackIn": [
    "us",
    "mx"
  ]
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({text: 'habit,tracker,streak', trackIn: ['us', 'mx']})
};

fetch('http://localhost:3000/api/backend/apps/{id}/keyword-fields/{localization}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:3000/api/backend/apps/{id}/keyword-fields/{localization}"

payload = {
    "text": "habit,tracker,streak",
    "trackIn": ["us", "mx"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id

string

required

localization

enum<string>

required

Available options:

id,

ru,

th,

de,

fr,

ar,

pa,

sv,

it,

pl,

bn,

ca,

zh-Hans,

zh-Hant,

hr,

cs,

da,

nl,

en-AU,

en-CA,

en-GB,

en-US,

fi,

fr-CA,

el,

gu,

he,

hi,

hu,

ja,

kn,

ko,

ms,

ml,

mr,

no,

or,

pt-BR,

pt-PT,

ro,

sk,

sl,

es-MX,

es-ES,

ta,

te,

tr,

uk,

ur,

vi

Body

application/json

text

string

required

Maximum string length: 1000

Example:

"habit,tracker,streak"

trackIn

string[]

required

The markets of the app that track the phrases of this field. Every one must be a market of the app whose storefront reads the localization. An empty list stores the field and tracks nothing.

Maximum array length: 200

Example:

["us", "mx"]

Response

200 - application/json

The response is of type object.

Save the keyword field of one localization

curl --request PUT \
  --url http://localhost:3000/api/backend/apps/{id}/keyword-fields/{localization} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "habit,tracker,streak",
  "trackIn": [
    "us",
    "mx"
  ]
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({text: 'habit,tracker,streak', trackIn: ['us', 'mx']})
};

fetch('http://localhost:3000/api/backend/apps/{id}/keyword-fields/{localization}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:3000/api/backend/apps/{id}/keyword-fields/{localization}"

payload = {
    "text": "habit,tracker,streak",
    "trackIn": ["us", "mx"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{}