0% found this document useful (0 votes)
23 views25 pages

Ad Repository

The Ad Repository API allows users to access Apple-delivered advertising data on the App Store for select European countries, including app and developer names, ad variations, and advertising restrictions. The API supports HTTPS communication and RSQL query patterns, with responses formatted in JSON. Key endpoints include retrieving app and developer names, country lists, and ad metadata, with detailed request and response structures provided for each endpoint.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
23 views25 pages

Ad Repository

The Ad Repository API allows users to access Apple-delivered advertising data on the App Store for select European countries, including app and developer names, ad variations, and advertising restrictions. The API supports HTTPS communication and RSQL query patterns, with responses formatted in JSON. Key endpoints include retrieving app and developer names, country lists, and ad metadata, with detailed request and response structures provided for each endpoint.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 25

Ad Repository API

October 2024
Version 1.0
Contents
Getting Started.................................................................................................................................................3

Versioning ....................................................................................................................................................3

Usability .......................................................................................................................................................3

Get a list of app and developer names .............................................................................................................4

Request example .........................................................................................................................................4

Request parameters ....................................................................................................................................4

Response example .......................................................................................................................................5

Response properties ....................................................................................................................................6

Get a list of countries or regions ......................................................................................................................7

Response example .......................................................................................................................................7

Response properties ....................................................................................................................................8

Get a list of ads ................................................................................................................................................9

Request example .........................................................................................................................................9

Request parameters ....................................................................................................................................9

Response example .....................................................................................................................................10

Response properties...................................................................................................................................11

Get ad variations ............................................................................................................................................14

Request parameters ...................................................................................................................................14

Response example .....................................................................................................................................15

Response properties ..................................................................................................................................17

Get advertising-restrictions ...........................................................................................................................20

Request example .......................................................................................................................................20

Request parameters ..................................................................................................................................20

Response example .....................................................................................................................................21

Response properties ..................................................................................................................................22

Changelog......................................................................................................................................................24

Ad Repository API October 2024 2


Getting Started
Use the Ad Repository API to look up Apple-delivered advertising on the App Store in
select European countries and regions as well as information about qualifying
advertising restrictions. You can manage API calls programmatically using API tools and
programs of your choice.
Versioning
The current version of the API is v1.
Usability
• Communication with the web service must use HTTPS.
• RSQL query patterns are supported in some endpoints.
• The API doesn’t accept headers with */*. Disallow Accept */* in your cURL
commands.

• API responses will have a header Content-Type: application/json.

Ad Repository API October 2024 3


Get a list of app and developer names
GET https://adrepository.apple.com/api/v1/ad-repository-entities

Use this endpoint to return list of app and developer names based on custom query
parameter input. A developer name refers to the developer as identified on the App
Store, which is the entity on whose behalf the subject advertising was presented. Only
apps that have been advertised in countries or regions in the European Union in which
Apple-delivered advertising is available on the App Store are searchable.

Request example

GET ~/api/v1/ad-repository-entities?name={URL encoded search input text}


&types==APP
&offset=0
&limit=10

Request parameters
Parameter Type Required Description

Custom query for app and developer names with a


name string yes
minimum of 2 characters required.

Values are:
APP
types string no DEVELOPER
APP,DEVELOPER (The default value or blank which
returns all types.)

The offset pagination that limits the number of returned


offset integer no
records. The default is 0.

The maximum number of entries to return per page. The


limit integer no
default is 50.

Ad Repository API October 2024 4


Response example
The AdRepositoryEntity object is returned:
{
"data": [
{
"id": 1582276305,
"name": "TripTrek",
"type": "APP"
},
{
"id": 819221,
"name": "Trip Trek, Inc.",
"type": "DEVELOPER"
}
],
"pagination": {
"totalResults": 2,
"startIndex": 0,
"itemsPerPage": 15
}
}

Ad Repository API October 2024 5


Response properties
Parameter Type Description

A unique identifier. If the type is APP, the id will be an appId. If


id integer
the type is DEVELOPER, the id is a developerId.

name string The entity name on whose behalf the advertising was presented.

type string Values are APP, DEVELOPER

pagination integer Returned pagination results.

totalResults: The total number of entries that return for the


operation.

startIndex: Specifies the position of the first element in the


results. The default is zero.

itemsPerPage: Specifies how many items is displayed per page.

Ad Repository API October 2024 6


Get a list of countries or regions
Use this endpoint to get a list of countries or regions in the European Union in which
Apple-delivered advertising is available on the App Store. Use the country codes
returned in the response in the Get a list of ads call.
Request example
GET https://adrepository.apple.com/api/v1/countries-or-regions

Response example

{
"data": [
{
"name": "Austria",
"code": "AT"
},
{
"name": "Belgium",
"code": "BE"
},
{
"name": "Croatia",
"code": "HR"
},
{
"name": "Czech Republic",
"code": "CZ"
},
{
"name": "Denmark",
"code": "DK"
},
{
"name": "Finland",
"code": "FI"
},
{
"name": "France",
"code": "FR"
},
{
"name": "Germany",
"code": "DE"
},
{
"name": "Greece",
"code": "GR"
},
{
"name": "Hungary",
"code": "HU"
},
{
"name": "Ireland",
"code": "IE"
},
{
"name": "Italy",

Ad Repository API October 2024 7


"code": "IT"
},
{
"name": "Netherlands",
"code": "NL"
},
{
"name": "Poland",
"code": "PL"
},
{
"name": "Portugal",
"code": "PT"
},
{
"name": "Romania",
"code": "RO"
},
{
"name": "Spain",
"code": "ES"
},
{
"name": "Sweden",
"code": "SE"
}
]
}

Response properties
Parameter Type Description

The name of the country or region in the European Union in which


name string Apple-delivered advertising is available on the App Store. For
example: "Sweden".

The ISO 3166-1 alpha-2 two-letter country code of the country or


code string region in the European Union in which Apple-delivered advertising
is available on the App Store. For example: ES, SE, DE.

Ad Repository API October 2024 8


Get a list of ads
Use this endpoint to return ad metadata and an adId to use in the Get Ad Variations call.

GET https://adrepository.apple.com/api/v1/ad-repository-ads

Request example
• Use ql= URL encoded RSQL filter to allow special characters.
• You can have both id or countryOrRegion or either in a request. If id is used
then type must also be present.
GET ~/api/v1/ad-repository-ads
?ql=
type==APP;
id==1582276305;
countryOrRegion=in=(FR,DE);
datePreset==LAST_90_DAYS;
&offset=0
&limit=50

Request parameters
Parameter Type Required Description

type string yes Values are APP, DEVELOPER.

A unique identifier. If the type is APP, the id is an


id string yes appId. If the type is DEVELOPER, the id is a
developerId.

A country or region in the European Union in


which Apple-delivered advertising is available on
countryOrRegion string yes
the App Store, expressed in ISO 3166-1 alpha-2
format. For example: ES, SE, DE.

The date range of the request. Values are


datePreset string no LAST_90_DAYS, LAST_180_DAYS, LAST_YEAR.
The default is LAST_90_DAYS.

The maximum number of entries to return per


limit integer no
page. The default is 50.

The offset pagination that limits the number of


offset integer no
returned records. The default is 0.

Ad Repository API October 2024 9


Response example
The AdRepositoryAd object is returned.
{
"data": [
{
"adId": "76324182",
"appId": 1582276305,
"appName": "TripTrek - travel app",
"developerId": 819221,
"developerName": "Apple Inc",
"legalName": "Apple Inc.",
"placement": "APPSTORE_SEARCH_RESULT",
"format": "Icon Ad",
"subFormat": "condensed_1",
"countryOrRegion": "ES",
"audienceRefinement": {
"ageTarget": "false",
"genderTarget": "false",
"locationTarget": "true",
"customerTypeTarget": "false"
},
"firstImpressionDate": "2022-08-25",
"lastImpressionDate": "2023-04-01",
"defaultLanguageTag": "es-ES",
"defaultLanguageDisplayName": "Spanish (Spain)",
"defaultPreviewDevice": "iPhone_6.5",
"adBanner": {
"joeColor": "b:ff4c00p:040404s:171c01t:361303q:452501",
"iconPictureUrl": "",
"subtitle": "Planifique sus viajes con confianza.",
"primaryCategory": "viajar",
"inAppPurchases": "false",
"promotionalText": "Descripción de la aplicación mostrada en la App
Store.",
"editorialBadge": "false"
"shortDescription": "una descripción de la aplicación asociada con el
anuncio."
},
"adAssets": [
{
"videoUrl": "https://...x.png",
"pictureUrl": "null",
"order": 1,
"height": 1920,
"width": 1080,
"orientation": "LANDSCAPE"
}
],
"appIconVariations": [],
"adLocaleVariations": []
}
],
"dataStartDate": "2023-01-01",
"dataEndDate": "2023-04-01",
"pagination": {
"totalResults": 330,
"startIndex": 0,
"itemsPerPage": 15
}
}

Ad Repository API October 2024 10


Response properties
Parameter Type Description

A unique ad identifier. Use adId as a resource in


adId string
the ad variations call.

The unique identifier of the app associated with


appId integer
an ad.

appName string The name of the app associated with an ad.

The unique identifier of the developer identified


developerId integer
on the App Store.

The developer name refers to the developer as


identified on the App Store which is the entity on
whose behalf the subject advertising was
developerName string
presented. In some instances, the
developerName may be different from the
legalName field for the same entity.

The legal name of the person or entity identified


under the seller field on the App Store. In some
legalName string
instances, the legalName may be different from
the developerName for the same entity.

The placement of the ad on the App Store.


placement string Values are APPSTORE_SEARCH_RESULTS,
APPSTORE_TODAY_TAB, APPSTORE_SEARCH_TAB

The format of the ad. Values are Icon Ad, Icon


format string
+ Asset Ad.

The type of ad format followed by a numeric


sequence indicating the version of ad variations.
subFormat string This field will only be populated when a new ad
format or variation is introduced, otherwise it is
null. Examples: medium_1, condensed_1.

A country or region in the European Union in


which Apple-delivered advertising is available on
countryOrRegion string
the App Store, expressed in ISO 3166-1 alpha-2
format. For example: ES, SE, DE.

Audience refinement criteria used in an ad


audienceRefinement object
campaign.

Indicates if age parameters are used in an ad


ageTarget boolean
campaign.

Indicates if gender parameters are used in an ad


genderTarget boolean
campaign.

Indicates if country or region parameters are


locationTarget boolean
used in an ad campaign.

Ad Repository API October 2024 11


Indicates app downloader type. Values are:
ALL_USERS
customerTypeTarget boolean NEW_USERS
RETURNING_USERS
USERS_OF_MY_OTHER_APPS

The first date of the first recorded delivered


firstImpressionDate string impression for the subject advertising up to one
year prior.

The last recorded delivered impression for the


subject advertising. This date will also
lastImpressionDate string correspond to the last impression date for
advertising that was restricted but not
suspended, stopped, or removed.

The locale code and default language used in the


defaultLanguageTag string advertiser's App Store geoterritory. For example,
es-ES.

The default language used in the advertiser's


defaultLanguageDisplay
string App Store geoterritory. For example, "Spanish
Name
(Spain)".

The default device model used in the advertiser's


defaultPreviewDevice string App Store geoterritory. For example,
"iPhone_6.5".

adBanner object The ad's App Store properties.

An encoded value that defines colors for text and


joeColor string background of the app as it appears on the App
Store.

iconPictureUrl string A resolved URL of the ad icon.

The subtitle of the app that appears on the App


subtitle string
Store.

primaryCategory string The app category on the App Store.

Indicates if the app has in-app purchases


inAppPurchases boolean
enabled.

promotionalText string The app description on the App Store.

The app's App Store metadata approval shown


editorialBadge boolean
alongside the app icon.

If promotionalText is not present, a


shortDescription string shortDescription matching the default
product page is displayed.

adAssets object A array of ad assets.

videoUrl string The resolved URL for a video asset.

pictureUrl string The resolved URL for the image asset.

The order of the ad asset that was uploaded to


order integer
App Store Connect.

Ad Repository API October 2024 12


The height of the ad asset that was uploaded to
height integer
App Store Connect.

The width of the ad asset that was uploaded to


width integer
App Store Connect.

The orientation of the ad asset that was


orientation string uploaded to App Store Connect. Values are
LANDSCAPE, PORTRAIT, UNKNOWN.

appIconVariations object The URL of the app icon on the App Store.

object The language metadata of ad variations on the


adLocaleVariations
App Store.

Returned data is delayed by 7 days. For example,


If your datePreset is the LAST_90_DAYS, the
system will fetch matching ads by factoring
dataStartDate string
today (UTC) as the dataEndDate minus 7 days.
The dataStartDate is reported as the
dataEndDate minus 90 days.

Returned data is delayed by 7 days. For example,


If your datePreset is the LAST_90_DAYS, the
system will fetch matching ads by factoring
dataEndDate string
today (UTC) as the dataEndDate minus 7 days.
The dataStartDate is reported as the
dataEndDate minus 90 days.

Returned pagination results.

totalResults: The total number of entries that


return for the operation.
pagination integer
startIndex: Specifies the position of the first
element in the results. The default is zero.

itemsPerPage: Specifies how many items is


displayed per page.

Ad Repository API October 2024 13


Get ad variations
Use this endpoint to return ad variations by date range. Use the adId returned in
the Get a list of ads call as a resource identifier in the URI.

GET https://adrepository.apple.com/api/v1/ad-repository-ads/{adId}?
datePreset=LAST_90_DAYS

Request parameters
Parameter Type Required Description

adId string yes A unique resource ad identifier.

The date range of the request. Values are


datePreset string no LAST_90_DAYS, LAST_180_DAYS, LAST_YEAR.
The default is LAST_90_DAYS.

Ad Repository API October 2024 14


Response example
The AdRepositoryAd object is returned.
{
"data": {
"adId": "397563857",
"appId": 1582276305,
"appName": "TripTrek - travel app",
"developerId": 819221,
"developerName": "Apple Inc.",
"legalName": "Apple Inc.",
"placement": "APPSTORE_SEARCH_RESULTS",
"format": " Icon Ad",
"subFormat": "condensed_1",
"countryOrRegion": "Spain",
"audienceRefinement": {
"ageTarget": "true",
"genderTarget": "false",
"locationTarget": "true",
"customerTypeTarget": "false"
},
"firstImpressionDate": "2022-08-25",
"lastImpressionDate": "2023-04-01",
"defaultLanguageTag": "es-ES",
"defaultLanguageDisplayName": "Spanish (Spain)",
"defaultPreviewDevice": "iPhone_6.5",
"adBanner": {
"joeColor": "b:ff4c00p:040404s:171c01t:361303q:452501",
"iconPictureUrl": "https://...x_.png/x.png",
"subtitle": "Planifique sus viajes con confianza.",
"primaryCategory": "viajar",
"inAppPurchases": "false",
"promotionalText": "Texto promocional que se muestra en la App Store.",
"editorialBadge": "false"
"shortDescription": "una descripción de la aplicación asociada con el
anuncio."
},
"adAssets": [
{
"videoUrl": "https://...x_.png/x.png",
"pictureUrl": "null",
"order": "1",
"height": "1920",
"width": "1080",
"orientation": "PORTRAIT"
}
],
"appIconVariations": [
"https://..._.png/x.png, https://..._x_.png/x.png"
],
"adLocaleVariations": [
{
"languageTag": "en-GB",
"languageDisplayName": "English (Great Britain)",
"appName": "TripTrek",
"subTitle": "Plan your trips with confidence.",
"primaryCategory": "travel",
"promotionalText": "App description shown on the App Store.",
"deviceAssets": [
{
"previewDevice": "iphone_6_5",

Ad Repository API October 2024 15


"adAssets": [
{
"videoUrl": "https…_.png/x.png",
"pictureUrl": "null",
"order": "1",
"height": "1920",
"width": "1080",
"orientation": "PORTRAIT"
}
]
}
]
}
]
}
}

Ad Repository API October 2024 16


Response properties
Parameter Type Description

A unique ad identifier. Use adId as a resource in


adId string
the ad variations call.

The unique identifier of the app associated with


appId integer
an ad.

appName string The name of the app associated with an ad.

The unique identifier of the developer as


developerId integer
identified on the App Store.

The developer name refers to the developer as


identified on the App Store which is the entity on
whose behalf the subject advertising was
developerName string
presented. In some instances, the
developerName may be different from the
legalName field for the same entity.

The legal name of the person or entity identified


under the seller field on the App Store. In some
legalName string
instances, the legalName may be different from
the developerName for the same entity.

The placement of the ad on the App Store.


placement string Values are APPSTORE_SEARCH_RESULTS,
APPSTORE_TODAY_TAB, APPSTORE_SEARCH_TAB

The format of the ad. Values are Icon Ad, Icon


format string
+ Asset Ad.

The type of ad format followed by a numeric


sequence indicating the version of ad variations.
subFormat string This field will only be populated when a new ad
format or variation is introduced, otherwise it is
null. Examples: medium_1, condensed_1.

A country or region in the European Union in


which Apple-delivered advertising is available on
countryOrRegion string
the App Store, expressed in ISO 3166-1 alpha-2
format. Examples: ES, SE, DE.

Audience refinement criteria used in an ad


audienceRefinement object
campaign.

Indicates if age parameters are used in an ad


ageTarget boolean
campaign.

Indicates if gender parameters are used in an ad


genderTarget boolean
campaign.

Indicates if country or region parameters are


locationTarget boolean
used in an ad campaign.

Ad Repository API October 2024 17


Indicates app downloader type. Values are:
ALL_USERS
customerTypeTarget boolean NEW_USERS
RETURNING_USERS
USERS_OF_MY_OTHER_APPS

The first date of the first recorded delivered


firstImpressionDate string impression for the subject advertising up to one
year prior.

The last recorded delivered impression for the


subject advertising. This date will also
lastImpressionDate string correspond to the last impression date for
advertising that was restricted but not
suspended, stopped, or removed.

The locale code and default language used in the


defaultLanguageTag string advertiser's App Store geoterritory. For example,
es-ES.

The default language used in the advertiser's


defaultLanguageDisplayN
string App Store geoterritory. For example, "Spanish
ame
(Spain)".

The default device model used in the advertiser's


defaultPreviewDevice string App Store geoterritory. For example,
"iPhone_6.5".

adBanner object The ad's App Store metadata properties.

An encoded value that defines colors for text and


joeColor string background of the app as it appears on the App
Store.

iconPictureUrl string A resolved URL of the ad icon.

The subtitle of the app as it appears on the App


subtitle string
Store.

primaryCategory string The app category on the App Store.

Indicates if the app has in-app purchases


inAppPurchases boolean
enabled.

promotionalText string The app description on the App Store.

The app's App Store metadata approval shown


editorialBadge boolean
next to the app icon.

If promotionalText is not present, a


shortDescription string shortDescription matching the default
product page is displayed.

adAssets object A array of ad assets.

videoUrl string The resolved URL for a video asset.

pictureUrl string The resolved URL for the image asset.

Ad Repository API October 2024 18


The order of the ad asset that was uploaded to
order integer
App Store Connect.

The height of the ad asset that was uploaded to


height integer
App Store Connect.

The width of the ad asset that was uploaded to


width integer
App Store Connect.

The orientation of the ad asset that was


orientation string uploaded to App Store Connect. Values are
LANDSCAPE, PORTRAIT, UNKNOWN.

appIconVariations object The URL of the app icon on the App Store.

object The language metadata of ad variations on the


adLocaleVariations
App Store.

The locale code of the language used in the ad


languageTag string variation on the advertiser's App Store
geoterritory. For example, es-ES.

The language used in the ad variation on the


languageDisplayName string advertiser's App Store geoterritory. "Spanish
(Spain)"

appName string The name of the app associated with an ad.

The subtitle of the app that appears on the App


subTitle string
Store.

primaryCategory string The app category on the App Store.

promotionalText string The app description on the App Store.

deviceAssets object The device properties used in an ad campaign.

previewDevice string The device displaying the ad.

adAssets string The resolved URL for an ad assset.

videoUrl string The resolved URL for a video asset.

The resolved URL for the screenshot or a


pictureUrl string
screenshot of the image asset.

The order of the ad asset that was uploaded to


order integer
App Store Connect.

The height of the ad asset that was uploaded to


height integer
App Store Connect.

The width of the ad asset that was uploaded to


width integer
App Store Connect.

The orientation of the ad asset that was


orientation string uploaded to App Store Connect. Values are
LANDSCAPE, PORTRAIT, UNKNOWN

Ad Repository API October 2024 19


Get advertising-restrictions
Use this endpoint to return details of advertising-restrictions applied during a date
range. Ads must have at least one advertising impression to be included in the
response.

GET https://adrepository.apple.com/api/v1/restrictions

Request example
Use ql= URL encoded RSQL filter to allow special characters.
GET ~/api/v1/restrictions
?ql=
actionTaken==ACTION_ADVERTISING_REMOVED;
datePreset==LAST_90_DAYS
&offset=0
&limit=50

Request parameters
Parameter Type Required Description

The action taken on the restriction, Values are:


actionTaken string yes ACTION_ACCOUNT_SUSPENDED
ACTION_ADVERTISING_REMOVED

The date range of the request. Values are


datePreset string no LAST_90_DAYS, LAST_180_DAYS, LAST_YEAR. The
default is LAST_90_DAYS.

The maximum number of entries to return per page.


limit integer no
The default is 50.

The offset pagination that limits the number of


offset integer no
returned records. The default is 0.

Ad Repository API October 2024 20


Response example
The restriction object is returned.
{
"data": [
{
"actionDate": "2022-08-26",
"actionTaken": "ACTION_ADVERTISING_REMOVED",
"reason": "REASON_TOS_INCOMPATABILITY",
"basis": "Government order.",
"details": "Incompatible with Terms and Conditions.",
"firstImpressionDate": "2022-08-25",
"affectedPlacements": [
{
"placement": "APPSTORE_TODAY_TAB",
"countriesOrRegions": [
"BE",
"FR"
]
}
],
"audienceRefinement": {
"ageTarget": true,
"genderTarget": false,
"locationTarget": true,
"customerTypeTarget": false
}
}
],
"dataStartDate": "2022-01-01",
"dataEndDate": "2022-09-01",
"pagination": {
"totalResults": 2,
"startIndex": 0,
"itemsPerPage": 50
}
}

Ad Repository API October 2024 21


Response properties
Parameter Type Description

actionDate string The date the restriction was enforced.

The action taken on the restriction, Values are:


actionTaken string ACTION_ACCOUNT_SUSPENDED
ACTION_ADVERTISING_REMOVED

The reason on the basis of which the advertising


restriction was imposed. For example:
REASON_GOVERNMENT_ORDER
reason string REASON_THIRD_PARTY_REPORT
REASON_POLICY_RESTRICTION_AGE
REASON_POLICY_RESTRICTION
REASON_TOS_INCOMPATABILITY

The basis of the restriction. For example,


basis string
"Incompatible with Terms and Conditions".

Details of the restriction. For example, "Removed due


details string
to governmental order".

The first date of the first recorded delivered impression


firstImpressionDate string
for the subject advertising up to one year prior.

affectedPlacements object Metadata of the ad restriction’s App Store placement.

The placement of the ad on the App Store. Values are


placement string APPSTORE_SEARCH_RESULTS, APPSTORE_TODAY_TAB,
APPSTORE_SEARCH_TAB.

Countries or regions in the European Union in which


Apple-delivered advertising is available on the App
countriesOrRegions string
Store, expressed in ISO 3166-1 alpha-2 format.
Examples: ES, SE, DE.

object Audience refinement criteria used in an ad campaign.


audienceRefinement
array

Indicates if age parameters are used in the ad


ageTarget boolean
campaign.

Indicates if gender parameters are used in the ad


genderTarget boolean
campaign.

Indicates if country or region parameters are used in


locationTarget boolean
the ad campaign.

Indicates app downloader type. Values are:


ALL_USERS
customerTypeTarget boolean NEW_USERS
RETURNING_USERS
USERS_OF_MY_OTHER_APPS

Returned data is delayed by 7 days. For example, if


your datePreset is the LAST_90_DAYS, the system will
dataStartDate string fetch matching ads by factoring today (UTC) as the
dataEndDate minus 7 days. The dataStartDate is
reported as the dataEndDate minus 90 days.

Ad Repository API October 2024 22


Returned data is delayed by 7 days. For example, If
your datePreset is the LAST_90_DAYS, the system will
dataEndDate string fetch matching ads by factoring today (UTC) as the
dataEndDate minus 7 days. The dataStartDate is
reported as the dataEndDate minus 90 days.

Returned pagination results.

totalResults: The total number of entries that return


for the operation.
pagination integer
startIndex: Specifies the position of the first element
in the results. The default is zero.

itemsPerPage: Specifies how many items is displayed


per page.

Ad Repository API October 2024 23


Changelog
Date Notes

Added subFormat field to Get a list of ads response and Get ad variations
October, 2024
response.

March, 2024 Updated description of firstImpressionDate parameter.

Added joecolor to Get a list of ads response, Get ad variations response


January, 2024
and Get advertising-restrictions response.

Added short description field. See Get a list of ads Response properties
November, 2023
and Get ad variations Response properties.

August, 2023 Initial version.

Ad Repository API October 2024 24


Apple Inc.
Copyright © 2024 Apple Inc.
All rights reserved.

No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, mechanical,
electronic, photocopying, recording, or otherwise, without prior written permission of Apple Inc., with the following exceptions: Any person
is hereby authorized to store documentation on a single computer or device for personal use only and to print copies of documentation for
personal use provided that the documentation contains Apple’s copyright notice. No licenses, express or implied, are granted with respect
to any of the technology described in this document. Apple retains all intellectual property rights associated with the technology
described in this document. This document is intended to assist publishers and partners with trafficking Advertising on Apple News.

Apple Inc.
Ad Platforms
One Apple Park Way
Cupertino, CA 95014, USA

APPLE MAKES NO WARRANTY OR REPRESENTATION, EITHER EXPRESS OR IMPLIED, WITH RESPECT TO THIS DOCUMENT, ITS
QUALITY, ACCURACY, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. AS A RESULT, THIS DOCUMENT IS PROVIDED
“AS IS,” AND YOU, THE READER, ARE ASSUMING THE ENTIRE RISK AS TO ITS QUALITY AND ACCURACY. IN NO EVENT WILL APPLE BE
LIABLE FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES RESULTING FROM ANY DEFECT, ERROR OR
INACCURACY IN THIS DOCUMENT, even if advised of the possibility of such damages. Some jurisdictions do not allow the exclusion of
implied warranties or liability, so the above exclusion may not apply to you.

Ad Repository API October 2024 25

You might also like