Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of de directory te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen de mappen te wijzigen.
Gebruik deze methode in de Microsoft Store Analytics-API om een geaggregeerd overzicht te krijgen van prestatiegegevens voor advertentiecampagnes voor uw toepassingen tijdens een bepaald datumbereik en andere optionele filters. Met deze methode worden de gegevens in JSON-indeling geretourneerd.
Deze methode retourneert dezelfde gegevens die worden verstrekt door het advertentiecampagnerapport in Partnercentrum. Zie Een advertentiecampagne maken voor uw appvoor meer informatie over advertentiecampagnes.
Als u details voor advertentiecampagnes wilt maken, bijwerken of ophalen, kunt u de Advertentiecampagnes beheren methoden in de Api voor promoties van Microsoft Storegebruiken.
Vereiste voorwaarden
Als u deze methode wilt gebruiken, moet u eerst het volgende doen:
- Als u dit nog niet hebt gedaan, moet u alle vereisten voor de Microsoft Store Analytics-API voltooien.
- Haal een Azure AD-toegangstoken op dat moet worden gebruikt in de aanvraagheader voor deze methode. Nadat u een toegangstoken hebt verkregen, hebt u 60 minuten om het te gebruiken voordat het verloopt. Nadat het token is verlopen, kunt u een nieuw token verkrijgen.
Aanvraag
Aanvraagsyntaxis
| Methode | URI-aanvraag |
|---|---|
| TOEVOEGEN | https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion |
Header van het verzoek
| Koptekst | Typologie | Beschrijving |
|---|---|---|
| Autorisatie | touw | Verplicht. Het Azure AD-toegangstoken in de vorm van Bearer<token>. |
Aanvraagparameters
Als u prestatiegegevens voor een advertentiecampagne voor een specifieke app wilt ophalen, gebruikt u de parameter applicationId. Als u gegevens over advertentieprestaties wilt ophalen voor alle apps die zijn gekoppeld aan uw ontwikkelaarsaccount, laat u de parameter applicationId weg.
| Kenmerk | Typologie | Beschrijving | Verplicht |
|---|---|---|---|
| applicationId | touw | De Store-id van de app waarvoor u prestatiegegevens voor advertentiecampagnes wilt ophalen. | Nee. |
| begindatum | datum | De begindatum in het datumbereik van prestatiegegevens van advertentiecampagnes die moeten worden opgehaald, in de notatie JJJJ/MM/DD. De standaardwaarde is de huidige datum minus 30 dagen. | Nee. |
| einddatum | datum | De einddatum in het datumbereik van prestatiegegevens van advertentiecampagnes die moeten worden opgehaald, in de notatie JJJJ/MM/DD. De standaardwaarde is de huidige datum min één dag. | Nee. |
| Bovenaan | int (integer) | Het aantal rijen met gegevens dat moet worden geretourneerd in de aanvraag. De maximumwaarde en de standaardwaarde als deze niet zijn opgegeven, is 10000. Als er meer rijen in de query staan, bevat de hoofdtekst van het antwoord een volgende koppeling die u kunt gebruiken om de volgende pagina met gegevens aan te vragen. | Nee. |
| overslaan | int (integer) | Het aantal rijen dat moet worden overgeslagen in de query. Gebruik deze parameter om door grote gegevenssets te bladeren. Met top=10000 en skip=0 worden bijvoorbeeld de eerste 10000 rijen met gegevens opgehaald, top=10000 en skip=10000 worden de volgende 10000 rijen met gegevens opgehaald, enzovoort. | Nee. |
| filter | touw | Een of meer instructies waarmee de rijen in het antwoord worden gefilterd. Het enige ondersteunde filter is campaignId. Elke instructie kan gebruikmaken van de operatoren eq of ne en instructies kunnen worden gecombineerd met behulp van en of of. Hier volgt een voorbeeld van filter parameter: filter=campaignId eq '100023'. |
Nee. |
| aggregatieniveau | touw | Hiermee geeft u het tijdsbereik op waarvoor geaggregeerde gegevens moeten worden opgehaald. Dit kan een van de volgende tekenreeksen zijn: dag, week of maand. Als dit niet is opgegeven, is de standaardwaarde dag. | Nee. |
| volgorde | touw | Een instructie waarmee de gegevenswaarden van de resultaten voor de prestatiegegevens van de advertentiecampagne worden geordend. De syntaxis is orderby=field [order],field [order],.... De veldparameter kan een van de volgende tekenreeksen zijn:
De orderparameter is optioneel en kan asc of desc zijn om oplopende of aflopende volgorde voor elk veld op te geven. De standaardwaarde is asc. Hier volgt een voorbeeld orderby tekenreeks: orderby=date,campaignId |
Nee. |
| groeperen met groupby | touw | Een instructie die alleen gegevensaggregatie toepast op de opgegeven velden. U kunt de volgende velden opgeven:
De groupby-parameter kan worden gebruikt met de parameter aggregationLevel . Bijvoorbeeld: &groupby=applicationId&aggregationLevel=week |
Nee. |
Vraag om voorbeeld
In het volgende voorbeeld ziet u verschillende aanvragen voor het ophalen van prestatiegegevens voor advertentiecampagnes.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' HTTP/1.1
Authorization: Bearer <your access token>
Reactie
Antwoordlichaam
| Waarde | Typologie | Beschrijving |
|---|---|---|
| Waarde | gegevensreeks | Een matrix met objecten die geaggregeerde prestatiegegevens voor advertentiecampagnes bevatten. Zie de sectie campagneprestatieobject hieronder voor meer informatie over de gegevens in elk object. |
| @nextLink | touw | Als er extra pagina's met gegevens zijn, bevat deze tekenreeks een URI die u kunt gebruiken om de volgende pagina met gegevens aan te vragen. Deze waarde wordt bijvoorbeeld geretourneerd als de bovenste parameter van de aanvraag is ingesteld op 5, maar er meer dan 5 items met gegevens voor de query zijn. |
| Totaalaantal | int (integer) | Het totale aantal rijen in het gegevensresultaat voor de query. |
Campagneprestatieobject
Elementen in de matrix Waarde bevatten de volgende waarden.
| Waarde | Typologie | Beschrijving |
|---|---|---|
| datum | touw | De eerste datum in het datumbereik voor de prestatiegegevens van de advertentiecampagne. Als de aanvraag één dag heeft opgegeven, is deze waarde die datum. Als de aanvraag een week, maand of ander datumbereik heeft opgegeven, is deze waarde de eerste datum in dat datumbereik. |
| applicationId | touw | De Store-id van de app waarvoor u prestatiegegevens voor advertentiecampagnes opzoekt. |
| campagne-ID | touw | De ID van de advertentiecampagne. |
| lineId | touw | De ID van de advertentiecampagne leveringsregel die deze prestatiegegevens heeft gegenereerd. |
| valutacode | touw | De valutacode van het campagnebudget. |
| besteden | touw | Het budgetbedrag dat is besteed aan de advertentiecampagne. |
| Indrukken | lang | Het aantal advertentie-indrukken voor de campagne. |
| Installeert | lang | Het aantal app-installaties dat betrekking heeft op de campagne. |
| Kliks | lang | Het aantal advertentieklikken voor de campagne. |
| iapInstalls | lang | Het aantal invoegtoepassingen (ook wel in-app aankoop of IAP genoemd) worden geïnstalleerd die betrekking hebben op de campagne. |
| actieve gebruikers | lang | Het aantal gebruikers dat op een advertentie heeft geklikt die deel uitmaakt van de campagne en terug is gegaan naar de app. |
Voorbeeld van antwoord
In het volgende voorbeeld ziet u een voorbeeld van een JSON-antwoordtekst voor deze aanvraag.
{
"Value": [
{
"date": "2015-04-12",
"applicationId": "9WZDNCRFJ31Q",
"campaignId": "4568",
"lineId": "0001",
"currencyCode": "USD",
"spend": 700.6,
"impressions": 200,
"installs": 30,
"clicks": 8,
"iapInstalls": 0,
"activeUsers": 0
},
{
"date": "2015-05-12",
"applicationId": "9WZDNCRFJ31Q",
"campaignId": "1234",
"lineId": "0002",
"currencyCode": "USD",
"spend": 325.3,
"impressions": 20,
"installs": 2,
"clicks": 5,
"iapInstalls": 0,
"activeUsers": 0
}
],
"@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
"TotalCount": 1917
}