Search for iOS apps
Searches for iOS apps to promote in a campaign.
URL
GET https://api.searchads.apple.com/api/v5/search/appsQuery Parameters
| Name | Type | Description |
|---|---|---|
limit Optional | int32 | The number of items to return per request. The maximum is 1000. |
offset Optional | int32 | The offset pagination that limits the number of records returned. The start of each page is offset by the number specified. You can apply |
query Required | string | The query for a list of iOS apps using a matching prefix. The query search pattern uses a prefix-matching algorithm. You can use spaces in search patterns. Prefixes require a minimum of three characters. If you’re sending a quoted search string, use HTML encoding. |
returnOwnedApps Optional | boolean | The list of apps belonging to your organization. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AppInfoListResponse | If the call succeeds, the API returns the AppInfo object in the response payload with an HTTP status code of |
| 400 | Bad Request Content-Type: application/json | ApiErrorResponse | An invalid query or missing required parameters. |
| 401 | Unauthorized Content-Type: application/json | ApiErrorResponse | An unauthenticated call fails to get the requested response. |
| 403 | Forbidden Content-Type: application/json | ApiErrorResponse | Insufficient rights to the resource. |
| 404 | Not Found Content-Type: application/json | ApiErrorResponse | The API can’t locate the resource. |
| 429 | Content-Type: application/json | ApiErrorResponse | The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API. |
| 500 | Internal Server Error Content-Type: application/json | ApiErrorResponse | The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later. |
Discussion
Use this endpoint to search for iOS apps that you can promote in a campaign. You can use query parameters to fetch data. For more information, see the Use Query Parameters section of Using Apple Ads API Functionality.
An app search returns your adamId, which you can use in Create a Campaign in addition to the AppDownloaderCriteria in the TargetingDimensions payload. You can apply targeting dimensions to ad groups using Create an Ad Group or Update an Ad Group endpoints.
[Image]