Autorisation requise
Répertorie les liens webProperty-Google Ads pour une propriété Web donnée. Essayez maintenant ou consultez un exemple.
Requête
Requête HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks
Paramètres
Nom du paramètre | Valeur | Description |
---|---|---|
Paramètres de chemin d'accès | ||
accountId |
string |
Identifiant du compte auquel appartient la propriété Web donnée. |
webPropertyId |
string |
ID de la propriété Web pour laquelle récupérer les associations Google Ads. |
Paramètres de requête facultatifs | ||
max-results |
integer |
Nombre maximal de liens webProperty-Google Ads à inclure dans cette réponse. |
start-index |
integer |
Index du premier lien webProperty-Google Ads à 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
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#entityAdWordsLinks", "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.webPropertyAdWordsLinks Resource ] }
Nom de propriété | Valeur | Description | Notes |
---|---|---|---|
kind |
string |
Type de collection. | |
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 entrées, égal à 1 par défaut ou spécifié par le paramètre de requête "start-index". | |
itemsPerPage |
integer |
Nombre maximal d'entrées que la réponse peut contenir, quel que soit le nombre réel d'entrées renvoyées. Sa valeur est comprise entre 1 et 1 000, avec une valeur de 1 000 par défaut. Sinon, elle est spécifiée par le paramètre de requête "max-results". | |
previousLink |
string |
Lien précédent de cette collection de liens Google Ads. | |
nextLink |
string |
Lien suivant pour cette collection d'associations Google Ads. | |
items[] |
list |
Liste d'entités Google Ads associées. |
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 Google Ads Links Developer Guide for details. */ /* * Example #1: * Requests a list of all Google Ads links for the authorized user. */ try { EntityAdWordsLinks adWordsLinks = analytics.management(). webPropertyAdWordsLinks().list("123456", "UA-123456-1").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 adWordsLinks object. * The following code shows how to iterate through them. */ for (EntityAdWordsLink link : adWordsLinks.getItems()) { System.out.println("Link Id = " + link.getId()); System.out.println("Link Kind = " + link.getKind()); System.out.println("Link Name = " + link.getName()); // Get the web property reference from the entity. WebPropertyRef property = link.getEntity().getWebPropertyRef(); System.out.println("Property Id = " + property.getId()); System.out.println("Property Kind = " + property.getKind()); System.out.println("Property Name = " + property.getName()); System.out.println("Property Account Id = " + property.getAccountId()); // Get the Google Ads accounts. List<AdWordsAccount> adWordsAccounts = link.getAdWordsAccounts(); for (AdWordsAccount account : adWordsAccounts) { System.out.println("Account Kind = " + account.getKind()); System.out.println("Account Id = " + account.getCustomerId()); System.out.println("Auto Tagging Enabled = " + account.getAutoTaggingEnabled()); } }
PHP
Utilise la bibliothèque cliente PHP
/** * Note: This code assumes you have an authorized Analytics service object. * See the Google Ads Links Developer Guide for details. */ /** * Example #1: * Requests a list of all Google Ads links for the authorized user. */ try { $adWordsLinks = $analytics->management_webPropertyAdWordsLinks ->listManagementwebPropertyAdWordsLinks('123456', 'UA-123456-1'); } catch (apiServiceException $e) { print 'There was an Analytics API service error ' . $e->getCode() . ':' . $e->getMessage(); } catch (apiException $e) { print 'There was a general API error ' . $e->getCode() . ':' . $e->getMessage(); } /** * Example #2: * The results of the list method are stored in the adWordsLinks object. * The following code shows how to iterate through them. */ foreach ($adWordsLinks->getItems() as $link) { $html = <<<HTML <pre> Link Id = {$link->getId()} Link Kind = {$link->getKind()} Link Name = {$link->getName()} HTML; // Get the web property reference from the entity. $property = $link->getEntity()->getWebPropertyRef(); $html = <<<HTML Property Id = {$property->getId()} Property Kind = {$property->getKind()} Property Name = {$property->getName()} Property Account Id = {$property->getAccountId()} HTML; // Get the Google Ads accounts. foreach ($link->getAdWordsAccounts as $account) { $html = <<<HTML Account Kind = {$account->getKind()} Account Id = {$account->getCustomerId()} Auto Tagging Enabled = {$account->getAutoTaggingEnabled()} HTML; } $html .= '</pre>'; print $html; }
Python
Utilise la bibliothèque cliente Python
# Note: This code assumes you have an authorized Analytics service object. # See the Google Ads Links Developer Guide for details. # Example #1: # Requests a list of all Google Ads links for the authorized user. try: adWordsLinks = analytics.management().webPropertyAdWordsLinks().list( accountId='123456', webPropertyId='UA-123456-1' ).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 adWordsLinks object. # The following code shows how to iterate through them. for link in adWordsLinks.get('items', []): print 'Link Id = %s' % link.get('id') print 'Link Kind = %s' % link.get('kind') print 'Link Name = %s' % link.get('name') # Get the property reference from the entity. property = link.get('entity', {}).get('webPropertyRef', {}) print 'Property Id = %s' % property.get('id') print 'Property Kind = %s' % property.get('kind') print 'Property Name = %s' % property.get('name') print 'Property Account id = %s' % property.get('accountId') # Get the Google Ads accounts. adWordsAccounts = link.get('adWordsAccounts', []) for account in adWordsAccounts: print 'Account Id = %s' % account.get('id') print 'Account Kind = %s' % account.get('kind') print 'Auto Tagging Enabled = %s' % account.get('autoTaggingEnabled')
JavaScript
Utilise la bibliothèque cliente JavaScript.
/* * Note: This code assumes you have an authorized Analytics client object. * See the Google Ads Links Developer Guide for details. */ /* * Example 1: * Requests a list of all Google Ads links for the authorized user. */ function listAdWordsLinks() { var request = gapi.client.analytics.management.webPropertyAdWordsLinks.list({ 'accountId': '123456', 'webPropertyId': 'UA-123456-1' }); request.execute(printViews); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printViews(results) { if (results && !results.error) { var adWordsLinks = results.items; for (var i = 0, link; link = adWordsLinks[i]; i++) { console.log('Link Id: ' + link.id); console.log('Link Kind: ' + link.kind); console.log('Link Name: ' + link.name); // Get the property reference from the entity. var property = link.entity.webPropertyRef; console.log('Property Id: ' + property.id); console.log('Property Kind: ' + property.kind); console.log('Property Name: ' + property.name); console.log('Property Account id: ' + property.accountId); // Get the Google Ads accounts. var adWordsAccounts = link.adWordsAccounts; for (var j = 0, account; account = adWordsAccounts[j]; j++) { console.log('Account Id: ' + account.customerId); console.log('Account Kind: ' + account.kind); console.log('Auto Tagging Enabled: ' + account.autoTaggingEnabled); } } } }
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 la version autonome de l'explorateur.