Custom Dimensions: list

يجب تقديم تفويض.

يسرد السمات المخصّصة التي يمكن للمستخدم الوصول إليها. جرِّبه الآن أو اطّلِع على مثال.

الطلب

طلب HTTP

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

المَعلمات

اسم المعلَمة	القيمة	الوصف
مَعلمات المسار
`accountId`	`string`	رقم تعريف الحساب للسمات المخصّصة المطلوب استردادها.
`webPropertyId`	`string`	رقم تعريف الموقع الإلكتروني للسمات المخصّصة المطلوب استردادها.
مَعلمات طلب البحث الاختيارية
`max-results`	`integer`	الحد الأقصى لعدد السمات المخصّصة المطلوب تضمينها في هذا الرد.
`start-index`	`integer`	فهرس الكيان الأول المطلوب استرداده. يمكنك استخدام هذه المَعلمة كآلية تقسيم على صفحات إلى جانب المَعلمة max-results.

التفويض

يتطلب هذا الطلب تفويضًا باستخدام نطاق واحد على الأقل من النطاقات التالية (مزيد من المعلومات عن المصادقة والترخيص).

النطاق
`https://www.googleapis.com/auth/analytics.readonly`
`https://www.googleapis.com/auth/analytics`

نص الطلب

لا توفِّر نص طلب بهذه الطريقة.

الإجابة

إذا نجحت هذه الطريقة، ستعرض هذه الطريقة نص استجابة بالبنية التالية:

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

اسم الموقع	القيمة	الوصف
`kind`	`string`	نوع المجموعة
`username`	`string`	رقم تعريف البريد الإلكتروني للمستخدم الذي تمت المصادقة عليه
`totalResults`	`integer`	إجمالي عدد النتائج لطلب البحث، بغض النظر عن عدد النتائج في الرد.
`startIndex`	`integer`	هو فهرس البدء للموارد، والذي يكون 1 تلقائيًا، أو يتم تحديده بطريقة أخرى من خلال مَعلمة طلب البحث لفهرس البدء.
`itemsPerPage`	`integer`	الحد الأقصى لعدد الموارد التي يمكن أن يحتوي عليها الرد، بغض النظر عن العدد الفعلي للموارد المعروضة. تتراوح قيمتها من 1 إلى 1000 مع قيمة تبلغ 1000 تلقائيًا، أو يتم تحديدها من خلال مَعلمة طلب البحث max-results.
`previousLink`	`string`	أدرِج رابطًا إلى الصفحة السابقة لمجموعة السمات المخصّصة هذه.
`nextLink`	`string`	أدرِج رابطًا يؤدي إلى الصفحة التالية في مجموعة السمات المخصّصة هذه.
`items[]`	`list`	مجموعة من السمات المخصّصة

أمثلة

ملاحظة: إنّ الأمثلة المرتبطة بالرموز والمتوفرة لهذه الطريقة لا تمثّل كل لغات البرمجة المتوافقة (يُرجى مراجعة صفحة مكتبات البرامج للاطّلاع على قائمة باللغات المتوافقة).

Java

تستخدم مكتبة عملاء 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

تستخدم مكتبة برامج Python.

# 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')

تجربة

استخدِم مستكشف واجهات برمجة التطبيقات أدناه لطلب هذه الطريقة على البيانات المباشرة والاطّلاع على الردّ. ويمكنك بدلاً من ذلك تجربة المستكشف المستقل.