Requiere autorización
Enumera las audiencias de remarketing a las que tiene acceso el usuario. Consulta un ejemplo.
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences
Parámetros
Nombre de parámetro | Valor | Descripción |
---|---|---|
Parámetros de ruta | ||
accountId |
string |
ID de cuenta de las audiencias de remarketing que se deben recuperar. |
webPropertyId |
string |
ID de propiedad web de las audiencias de remarketing que se deben recuperar. |
Parámetros de consulta opcionales | ||
max-results |
integer |
Número máximo de audiencias de remarketing que se incluirán en esta respuesta. |
start-index |
integer |
Índice de la primera entidad que se debe recuperar. Utiliza este parámetro como un mecanismo de paginación junto con el parámetro max-results. |
type |
string |
Autorización
Esta solicitud requiere autorización con al menos uno de los ámbitos siguientes. Más información sobre la autenticación y la autorización
Alcance |
---|
https://www.googleapis.com/auth/analytics.edit |
https://www.googleapis.com/auth/analytics.readonly |
Cuerpo de la solicitud
No proporciones un cuerpo de solicitud con este método.
Respuesta
Si este método se realiza correctamente, el cuerpo de respuesta tendrá la siguiente estructura:
{ "kind": "analytics#remarketingAudiences", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.remarketingAudience Resource ] }
Nombre de propiedad | Valor | Descripción | Notas |
---|---|---|---|
kind |
string |
Tipo de colección. | |
username |
string |
ID de correo electrónico del usuario autenticado. | |
totalResults |
integer |
Número total de resultados de la consulta, independientemente del número de resultados en la respuesta. | |
startIndex |
integer |
Índice inicial de los recursos, que es 1 de forma predeterminada o lo especificado por el parámetro de consulta start-index. | |
itemsPerPage |
integer |
Número máximo de recursos que puede contener la respuesta, independientemente del número real de recursos devueltos. Su valor está entre 1 y 1000, siendo 1000 el valor predeterminado o el especificado por el parámetro de consulta max-results. | |
previousLink |
string |
Enlace a la página anterior de esta colección de vistas (perfiles). | |
nextLink |
string |
Enlace a la página siguiente de esta colección de audiencias de remarketing. | |
items[] |
list |
Lista de audiencias de remarketing. |
Ejemplos
Nota: Los ejemplos de código disponibles para este método no representan todos los lenguajes de programación admitidos (consulta la página de bibliotecas de cliente para obtener una lista de los lenguajes admitidos).
Java
Utiliza la biblioteca de cliente Java.
/* * Note: This code assumes you have an authorized Analytics service object. * See the Remarketing Audiences Developer Guide for details. */ /* * This request lists existing Remarketing Audience instances. */ try { RemarketingAudiences audiences = analytics.management().remarketingAudience().list(accountId, propertyId).execute(); /* * The results of the list method are stored in the audiences object. * The following code shows how to iterate through them. */ for (RemarketingAudience audience : audiences.getItems()) { System.out.println("Audience Id: " + audience.getId()); System.out.println("Audience Name: " + audience.getName()); // Get the linked accounts. for (LinkedForeignAccount link : audience.getLinkedAdAccounts()) { System.out.println("Linked Account ID: " + link.getLinkedAccountId()); System.out.println("Linked Account Type: " + link.getType()); } // Get the audience type. for (String linkedView : audience.getLinkedViews()) { System.out.println("Linked View ID: " + linkedView); } // Get audience type. String audienceType = audience.getAudienceType(); System.out.println("Audience Type: " + audienceType); // Get the audience definition. if (audienceType.equals("SIMPLE")) { AudienceDefinition audienceDefinition = audience.getAudienceDefinition(); // Get the inclusion conditions. IncludeConditions conditions = audienceDefinition.getIncludeConditions(); System.out.println("Condition daysToLookBack: " + conditions.getDaysToLookBack()); System.out.println( "Condition membershipDurationDays: " + conditions.getMembershipDurationDays()); System.out.println("Condition Segment: " + conditions.getSegment()); } else if (audienceType.equals("STATE_BASED")) { StateBasedAudienceDefinition stateBasedAudienceDefinition = audience.getStateBasedAudienceDefinition(); // Get the inclusion conditions. IncludeConditions includeConditions = stateBasedAudienceDefinition.getIncludeConditions(); System.out.println( "Inclusion conditions daysToLookBack: " + includeConditions.getDaysToLookBack()); System.out.println( "Inclusion conditions membershipDurationDays: " + includeConditions.getMembershipDurationDays()); System.out.println("Inclusion conditions segment: " + includeConditions.getSegment()); // Get the exclusion conditions. ExcludeConditions excludeConditions = stateBasedAudienceDefinition.getExcludeConditions(); System.out.println( "Exclusion conditions exclusionDuration: " + excludeConditions.getExclusionDuration()); System.out.println("Exclusion conditions segment: " + excludeConditions.getSegment()); } } } catch (GoogleJsonResponseException e) { System.err.println( "There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); }
PHP
Utiliza la biblioteca de cliente PHP.
/* * Note: This code assumes you have an authorized Analytics service object. * See the Remarketing Audiences Developer Guide for details. */ /* * This request lists existing Remarketing Audience instances. */ try { $audiences = $analytics->management_remarketingAudience->listManagementRemarketingAudience($accountId, $propertyId); /* * The results of the list method are stored in the audiences object. * The following code shows how to iterate through them. */ foreach ($audiences->getItems() as $audience) { $html = <<<HTML <pre> Audience Id: = {$audience->getId()} Audience Name: = {$audience->getName()} HTML; // Get the linked accounts. foreach ($audience->getLinkedAdAccounts() as $link) { $html .=<<<HTML Linked Account ID: = {$link->getLinkedAccountId()} Linked Account Type: = {$link->getType()} HTML; } // Get the linked views. foreach ($audience->getLinkedViews() as $linkedView) { $html .=<<<HTML Linked View ID: = {$linkedView} HTML; } // Get audience type. $audienceType = $audience->getAudienceType(); $html .==<<<HTML Audience Type: = {$audienceType} HTML; // Get the audience definition. if ($audienceType == "SIMPLE") { Google_Service_Analytics_RemarketingAudienceAudienceDefinition $audienceDefinition = $audience->getAudienceDefinition(); // Get the inclusion conditions. IncludeConditions conditions = $audienceDefinition->getIncludeConditions(); $html .=<<<HTML Condition daysToLookBack: = {conditions->getDaysToLookBack()} Condition membershipDurationDays: = {conditions}getMembershipDurationDays()); Condition Segment: = {conditions->getSegment()} HTML; } else if ($audienceType == "STATE_BASED") { StateBasedAudienceDefinition $stateBasedAudienceDefinition = $audience->getStateBasedAudienceDefinition(); // Get the inclusion conditions. Google_Service_Analytics_IncludeConditions $includeConditions = $stateBasedAudienceDefinition->getIncludeConditions(); $html .=<<<HTML Inclusion conditions daysToLookBack: = {$includeConditions->getDaysToLookBack()} Inclusion conditions membershipDurationDays: = {$includeConditions->getMembershipDurationDays()} Inclusion conditions segment: = {$includeConditions->getSegment()} HTML; // Get the exclusion conditions. Google_Service_Analytics_RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions $excludeConditions = $stateBasedAudienceDefinition->getExcludeConditions(); $html .=<<<HTML Exclusion conditions exclusionDuration: {$excludeConditions->getExclusionDuration()} Exclusion conditions segment: = {$excludeConditions->getSegment()} HTML; } $html .= '</pre>'; print $html; } } 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(); }
Python
Utiliza la biblioteca de cliente Python.
# Note: This code assumes you have an authorized Analytics service object. # See the Remarketing Audiences Developer Guide for details. # This request lists existing Remarketing Audience. try: audiences = analytics.management().remarketingAudience().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)) # The results of the list method are stored in the audiences object. # The following code shows how to iterate through them. for audience in audiences.get('items', []): print 'Audience Id = %s' % audience.get('id') print 'Audience name = %s' % audience.get('name') for view in audience.get('linkedViews'): print 'linkedView = %s' % view # Get the linked accounts. for link in audience.get('linkedAdAccounts', []): print 'Link type = %s' % link.get('type') print 'Link linkedAccountId = %s' % link.get('linkedAccountId') # Get the audience type. audienceType = audience.get('type') print 'Audience type = %s' % audienceType # Get the audience definition. if audienceType == 'SIMPLE': definition = audience.get('audienceDefinition', {}) # Get the include conditions. condition = definition.get('includeConditions', {}) print 'Condition daysToLookBack = %s' % condition.get('daysToLookBack') print 'Condition membershipDurationDays = %s' % condition.get( 'membershipDurationDays') print 'Condition segment = %s' % condition.get('segment') elif audienceType == 'STATE_BASED': definition = audience.get('stateBasedAudienceDefinition', {}) # get the include conditions condition = definition.get('includeConditions', {}) print 'Condition daysToLookBack = %s' % condition.get('daysToLookBack') print 'Condition membershipDurationDays = %s' % condition.get( 'membershipDurationDays') print 'Condition segment = %s' % condition.get('segment') # get the exclude condition condition = definition.get('excludeConditions', {}) print 'Condition exclusionDuration = %s' % condition.get( 'exclusionDuration') print 'Condition segment = %s' % condition.get('segment')
JavaScript
Utiliza la biblioteca de cliente JavaScript.
/** * Note: This code assumes you have an authorized Analytics client object. * See the Unsampled Reports Developer Guide for details. */ /** * This request lists existing Remarketing Audiences. */ function listRemarketingAudiences(accountId, propertyId) { let request = gapi.client.analytics.management.remarketingAudience.list( { 'accountId': accountId, 'webPropertyId': propertyId, } ).then(printResults); } /** * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printResults(results) { if (results && !results.error) { let audiences = results.items; for (let i = 0, audience; audience = audiences[i]; i++) { console.log('Audience Id ' + audience.id); console.log('Audience name ' + audience.name); } for (let j = 0, view; audience.linkedViews[j]; j++) { console.log('linkedView ' + view); } // Get the linked accounts. let linkedAccounts = audience.linkedAdAccounts; for (let j = 0, link; link = linkedAccounts[i]; i++) { console.log('Link type ' + link.type); console.log('Link linkedAccountId ' + link.linkedAccountId); } // Get the audience type. let audienceType = audience.type; console.log('Audience type ' + audienceType); // Get the audience definition. if (audienceType == 'SIMPLE') { let definition = audience.audienceDefinition; // Get the include conditions. let condition = definition.includeConditions; console.log('Condition daysToLookBack ' + condition.daysToLookBack); console.log('Condition membershipDurationDays ' + condition.membershipDurationDays); console.log('Condition segment ' + condition.segment); } else if (audienceType == 'STATE_BASED') { let definition = audience.stateBasedAudienceDefinition; // Get the include conditions. let condition = definition.includeConditions; console.log('Condition daysToLookBack ' + condition.daysToLookBack); console.log('Condition membershipDurationDays ' + condition.membershipDurationDays); console.log('Condition segment ' + condition.segment); // Get the exclude condition let excludeCondition = definition.excludeConditions; console.log('Condition exclusionDuration ' + excludeCondition.exclusionDuration); console.log('Condition segment ' + excludeCondition.segment); } } }