Segments: list

Requer autorização

Lista os segmentos aos quais o usuário tem acesso. Faça um teste agora ou veja um exemplo.

Além dos parâmetros padrão, esse método é compatível com os parâmetros listados na tabela correspondente.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/analytics/v3/management/segments

Parâmetros

Nome do parâmetro	Valor	Descrição
Parâmetros de consulta opcionais
`max-results`	`integer`	O número máximo de segmentos a serem incluídos nessa resposta.
`start-index`	`integer`	Um índice do primeiro segmento a ser recuperado. Use esse parâmetro como um mecanismo de paginação juntamente com o parâmetro "max-results".

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais sobre autenticação e autorização).

Escopo
`https://www.googleapis.com/auth/analytics`
`https://www.googleapis.com/auth/analytics.edit`
`https://www.googleapis.com/auth/analytics.readonly`

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

A resposta contém um recurso de segmento referente a cada segmento avançado disponível para o usuário.

{
  "kind": "analytics#segments",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.segments Resource
  ]
}

Nome da propriedade	Valor	Descrição
`kind`	`string`	Tipo de conjunto para os segmentos.
`username`	`string`	ID do e-mail do usuário autenticado
`totalResults`	`integer`	Número total de resultados da consulta, independentemente do número de resultados na resposta.
`startIndex`	`integer`	O índice inicial dos recursos, que é 1 por padrão ou outro especificado pelo parâmetro de consulta `start-index`.
`itemsPerPage`	`integer`	Número máximo de recursos que a resposta pode conter, independentemente do número real de recursos retornados. O valor varia de 1 a 1.000, sendo que o valor padrão é 1.000 ou outro valor especificado pelo parâmetro de consulta `max-results`.
`previousLink`	`string`	Link para a página anterior desse conjunto de segmentos.
`nextLink`	`string`	Link para a próxima página desse conjunto de segmentos.
`items[]`	`list`	Uma lista de segmentos.

Exemplos

Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.

PHP

Usa a biblioteca cliente de PHP.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Segments Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of all Segments for the authorized user.
 */
try {
  $segments = $analytics->management_segments->listManagementSegments();
} 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 segments object.
 * The following code shows how to iterate through them.
 */
foreach ($segments->getItems() as $segment) {
  $html .= <<<HTML
<pre>

Segment ID = {$segment->getId()}
Kind       = {$segment->getKind()}
Self Link  = {$segment->getSelfLink()}
Name       = {$segment->getName()}
Definition = {$segment->getDefinition()}
Created    = {$segment->getCreated()}
Updated    = {$segment->getUpdated()}

</pre>
HTML;
  print $html;
}

Python

Usa a biblioteca cliente de Python.

# Note: This code assumes you have an authorized Analytics service object.
# See the Segments Developer Guide for details.

# Example #1:
# Requests a list of segments to which the user has access.
try:
  segments = analytics.management().segments().list().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 segments object.
# The following code shows how to iterate through them.
for segment in segments.get('items', []):
  print 'Segment Id         = %s' % segment.get('id')
  print 'Segment kind       = %s' % segment.get('kind')
  print 'Segment segmentId  = %s' % segment.get('segmentId')
  print 'Segment Name       = %s' % segment.get('name')
  print 'Segment Definition = %s' % segment.get('definition')
  if segment.get('created'):
    print 'Created    = %s' % segment.get('created')
    print 'Updated    = %s' % segment.get('updated')
  print

JavaScript

Usa a biblioteca cliente de JavaScript.

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Segment Developer Guide for details.
 */

/*
 * Example 1:
 * Requests a list of all Segments for the authorized user.
 */
function listSegments() {
  var request = gapi.client.analytics.management.segments.list();
  request.execute(printSegments);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printSegments(results) {
  if (results && !results.error) {
    var segments = results.items;
    for (var i = 0, segment; segment = segments[i]; i++) {
      console.log('Segment Id: ' + segment.id);
      console.log('Segment Kind: ' + segment.kind);
      console.log('Segment Name: ' + segment.name);
      console.log('Segment Definition: ' + segment.definition);

      // These fields are only set for custom segments and not default segments.
      if (segment.created) {
        console.log('Created: ' + segment.created);
        console.log('Updated: ' + segment.updated);
      }
    }
  }
}

Confira!

Use o APIs Explorer abaixo para chamar esse método para dados ativos e ver a resposta. Se você preferir, teste o Explorador independente.