Custom Dimensions: list

Wymaga autoryzacji

Zawiera listę wymiarów niestandardowych, do których użytkownik ma dostęp. Wypróbuj teraz lub zobacz przykład.

Prośba

Żądanie HTTP

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDimensions

Parametry

Nazwa parametru	Wartość	Opis
Parametry ścieżki
`accountId`	`string`	Identyfikator konta, na które wymiary niestandardowe mają być pobierane.
`webPropertyId`	`string`	Identyfikator usługi internetowej na potrzeby wymiarów niestandardowych do pobrania.
Opcjonalne parametry zapytania
`max-results`	`integer`	Maksymalna liczba wymiarów niestandardowych, które mają być uwzględnione w tej odpowiedzi.
`start-index`	`integer`	Indeks pierwszej encji do pobrania. Użyj tego parametru jako mechanizmu podziału na strony razem z parametrem max-results.

Upoważnienie

To żądanie wymaga autoryzacji z użyciem co najmniej jednego z tych zakresów (więcej informacji o uwierzytelnianiu i autoryzacji).

Zakres
`https://www.googleapis.com/auth/analytics.readonly`
`https://www.googleapis.com/auth/analytics`

Treść żądania

Nie podawaj treści żądania za pomocą tej metody.

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:

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

nazwa usługi,	Wartość	Opis
`kind`	`string`	Typ kolekcji.
`username`	`string`	Identyfikator e-mail uwierzytelnionego użytkownika.
`totalResults`	`integer`	Łączna liczba wyników zapytania, niezależnie od liczby wyników w odpowiedzi.
`startIndex`	`integer`	Początkowy indeks zasobów, który ma domyślnie wartość 1 lub jest określony przez parametr zapytania start-index.
`itemsPerPage`	`integer`	Maksymalna liczba zasobów, które może zawierać odpowiedź, niezależnie od rzeczywistej liczby zwróconych zasobów. Ma ona zakres od 1 do 1000 i domyślnie przyjmuje wartość 1000 lub jest określona w inny sposób przez parametr zapytania „max-results”.
`previousLink`	`string`	Link do poprzedniej strony dla tej kolekcji wymiarów niestandardowych.
`nextLink`	`string`	Link do następnej strony dotyczącej tej kolekcji wymiarów niestandardowych.
`items[]`	`list`	Kolekcja wymiarów niestandardowych.

Przykłady

Uwaga: dostępne dla tej metody przykłady kodu nie odzwierciedlają wszystkich obsługiwanych języków programowania. Listę obsługiwanych języków znajdziesz na stronie z bibliotekami klienta.

Java

Używa biblioteki klienta Java.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 */

/**
 * This request lists all custom dimensions for the authorized user.
 */
try {
  CustomDimensions dimensions = analytics.management.customDimensions
      .list("12345", "UA-12345-1").execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}


/**
 * The results of the list method are stored in the dimensions object.
 * The following code shows how to iterate through them.
 */
for (CustomDimension dimension : dimensions.getItems()) {
  System.out.println("Dimension Kind: " + dimension.getKind());
  System.out.println("Dimension Id: " + dimension.getId());
  System.out.println("Account ID: " + dimension.getAccountId());
  System.out.println("Property ID: " + dimension.getWebPropertyId());
  System.out.println("Dimension Name: " + dimension.getName());
  System.out.println("Dimension Index: " + dimension.getIndex());
  System.out.println("Dimension Scope: " + dimension.getScope());
  System.out.println("Dimension Active: " + dimension.getActive());
  System.out.println("Dimension Created: " + dimension.getCreated());
  System.out.println("Dimension Updated: " + dimension.getUpdated());
}

Python

Używa biblioteki klienta Pythona.

# Note: This code assumes you have an authorized Analytics service object.

# This request lists all custom dimensions for the authorized user.
try:
  dimensions = analytics.management().customDimensions().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 dimensions object.
# The following code shows how to iterate through them.
for dimension in dimensions.get('items', []):
  print 'Dimension Kind = %s' % dimension.get('kind')
  print 'Dimension Id = %s' % dimension.get('id')
  print 'Account ID = %s' % dimension.get('accountId')
  print 'Property ID = %s' % dimension.get('webPropertyId')
  print 'Dimension Name = %s' % dimension.get('name')
  print 'Dimension Index = %s' % dimension.get('index')
  print 'Dimension Scope = %s' % dimension.get('scope')
  print 'Dimension Active = %s' % dimension.get('active')
  print 'Dimension Created = %s' % dimension.get('created')
  print 'Dimension Updated = %s' % dimension.get('updated')

Wypróbuj

Użyj eksploratora interfejsów API poniżej, aby wywołać tę metodę na aktywnych danych i zobaczyć odpowiedź. Możesz też wypróbować samodzielny eksplorator.