Autorisation requise
Répertorie tous les liens de filtre de profil pour un profil. Essayez maintenant ou consultez un exemple.
Requête
Requête HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks
Paramètres
Nom du paramètre | Valeur | Description |
---|---|---|
Paramètres de chemin d'accès | ||
accountId |
string |
ID du compte pour lequel récupérer les liens de filtre de profil. |
profileId |
string |
ID du profil pour lequel récupérer les liens de filtre. Il peut s'agir d'un ID de profil spécifique ou de "~all", qui fait référence à tous les profils auxquels l'utilisateur a accès. |
webPropertyId |
string |
ID de site Web pour les liens de filtre de profil. Il peut s'agir d'un ID de propriété Web spécifique ou de "~all", qui fait référence à toutes les propriétés Web auxquelles l'utilisateur a accès. |
Paramètres de requête facultatifs | ||
max-results |
integer |
Nombre maximal de liens de filtre de profil à inclure dans cette réponse. |
start-index |
integer |
Index de la première entité à récupérer. Utilisez ce paramètre comme mécanisme de pagination avec le paramètre max-results. |
Autorisation
Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation
Définition du champ d'application |
---|
https://www.googleapis.com/auth/analytics.edit |
https://www.googleapis.com/auth/analytics.readonly |
Corps de la requête
Ne spécifiez pas de corps de requête pour cette méthode.
Réponse
Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :
{ "kind": "analytics#profileFilterLinks", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.profileFilterLinks Resource ] }
Nom de propriété | Valeur | Description | Remarques |
---|---|---|---|
kind |
string |
Type de collection. | |
username |
string |
ID d'adresse e-mail de l'utilisateur authentifié. | |
totalResults |
integer |
Nombre total de résultats de la requête, quel que soit le nombre de résultats dans la réponse. | |
startIndex |
integer |
Index de départ des ressources, défini sur 1 par défaut ou spécifié par le paramètre de requête "start-index". | |
itemsPerPage |
integer |
Nombre maximal de ressources que la réponse peut contenir, quel que soit le nombre réel de ressources renvoyées. Sa valeur est comprise entre 1 et 1 000, avec une valeur de 1 000 par défaut. Elle est également spécifiée par le paramètre de requête "max-results". | |
previousLink |
string |
Lien vers la page précédente de cette collection de liens de filtre de profil. | |
nextLink |
string |
Lien vers la page suivante pour cette collection de liens de filtre de profil. | |
items[] |
list |
Une liste de liens de filtre de profil. |
Exemples
Remarque : Les langages de programmation compatibles ne figurent pas tous dans les exemples de code présentés pour cette méthode (consultez la page Bibliothèques clientes pour obtenir la liste des langages compatibles).
Java
Utilise la bibliothèque cliente Java.
/* * Note: This code assumes you have an authorized Analytics service object. * See the Filters Developer Guide for details. */ /* * Example #1: * Requests a list of all profile filter links for the authorized user. */ try { ProfileFilterLinks filterLinks = analytics.management(). profileFilterLinks().list("123456", "UA-123456-1", "7654321").execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /* * Example 2: * The results of the list method are stored in the filterLinks object. * The following code shows how to iterate through them. */ for (ProfileFilterLink link : filterLinks.getItems()) { System.out.println("Link Id = " + link.getId()); System.out.println("Link Kind = " + link.getKind()); // Get the profile reference. ProfileRef profileRef = link.getProfileRef(); System.out.println("Profile Id = " + profileRef.getId()); System.out.println("Profile Kind = " + profileRef.getKind()); System.out.println("Profile Account Id = " + profileRef.getAccountId()); System.out.println("Profile Property Id = " + profileRef.getWebPropertyId()); System.out.println("Profile Name = " + profileRef.getName()); // Get the filter reference. FilterRef filterRef = link.getFilterRef(); System.out.println("Filter Id = " + filterRef.getId()); System.out.println("Filter Account Id = " + filterRef.getAccountId()); System.out.println("Filter Name = " + filterRef.getName()); }
Python
Utilise la bibliothèque cliente Python.
# Note: This code assumes you have an authorized Analytics service object. # See the Filters Developer Guide for details. # Example #1: # Requests a list of all profile filter links for the authorized user. try: filterLinks = analytics.management().profileFilterLinks().list( accountId='123456' webPropertyId='UA-123456-1', profileId='7654321' ).execute() except TypeError, error: # Handle errors in constructing a query. print 'There was an error in constructing your query : %s' % error except HttpError, error: # Handle API errors. print ('There was an API error : %s : %s' % (error.resp.status, error.resp.reason)) # Example #2: # The results of the list method are stored in the filterLinks object. # The following code shows how to iterate through them. for link in filterLinks.get('items', []): print 'Link Id = %s' % link.get('id') print 'Link Kind = %s' % link.get('kind') # Get the profile reference. profileRef = link.get('profileRef', {}) print 'Profile Id = %s' % profileRef.get('id') print 'Profile Kind = %s' % profileRef.get('kind') print 'Profile Account Id = %s' % profileRef.get('accountId') print 'Profile Property Id = %s' % profileRef.get('webPropertyId') print 'Profile Name = %s' % profile.get('name') # Get the filter reference. filterRef = link.get('filterRef', {}) print 'Filter Id = %s' % filterRef.get('id') print 'Filter Account Id = %s' % filterRef.get('accountId') print 'Filter Name = %s' % filterRef.get('name')
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse. Vous pouvez également utiliser l'explorateur autonome.