Experiments: list

نیاز به مجوز دارد

آزمایش هایی را که کاربر به آنها دسترسی دارد فهرست می کند. یک نمونه ببینید .

علاوه بر پارامترهای استاندارد ، این روش از پارامترهای فهرست شده در جدول پارامترها پشتیبانی می کند.

درخواست

درخواست HTTP

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments

مولفه های

نام پارامتر ارزش شرح
پارامترهای مسیر
accountId string شناسه حساب برای بازیابی آزمایش‌ها.
profileId string مشاهده شناسه (نمایه) برای بازیابی آزمایش‌ها.
webPropertyId string شناسه ویژگی وب برای بازیابی آزمایش‌ها.
پارامترهای پرس و جو اختیاری
max-results integer حداکثر تعداد آزمایشی که باید در این پاسخ گنجانده شود.
start-index integer شاخصی از اولین آزمایش برای بازیابی. از این پارامتر به عنوان مکانیزم صفحه بندی به همراه پارامتر max-results استفاده کنید.

مجوز

این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).

محدوده
https://www.googleapis.com/auth/analytics
https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

درخواست بدن

با این روش بدنه درخواستی ارائه نکنید.

واکنش

در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:

{
  "kind": "analytics#experiments",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.experiments Resource
  ]
}
نام ملک ارزش شرح یادداشت
kind string نوع مجموعه
username string شناسه ایمیل کاربر احراز هویت شده
totalResults integer تعداد کل نتایج برای پرس و جو، صرف نظر از تعداد منابع موجود در نتیجه.
startIndex integer شاخص شروع منابع که به طور پیش‌فرض 1 است یا توسط پارامتر جستجوی start-index مشخص می‌شود.
itemsPerPage integer حداکثر تعداد منابعی که پاسخ می تواند داشته باشد، صرف نظر از تعداد واقعی منابع برگشتی. مقدار آن از 1 تا 1000 با مقدار 1000 به طور پیش فرض متغیر است، یا در غیر این صورت توسط پارامتر query max-results مشخص شده است.
items[] list لیستی از آزمایشات

مثال ها

توجه: نمونه‌های کد موجود برای این روش همه زبان‌های برنامه‌نویسی پشتیبانی‌شده را نشان نمی‌دهند (برای فهرست زبان‌های پشتیبانی‌شده به صفحه کتابخانه‌های سرویس گیرنده مراجعه کنید).

جاوا

از کتابخانه سرویس گیرنده جاوا استفاده می کند.

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

/*
 * Example #1
 * This example requests a list of all Experiments for the authorized user.
 */
try {
  Experiments experiments = analytics.management().experiments().list("123456",
      "UA-123456-1", "7654321").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 experiments object.
 * The following code shows how to iterate through them.
 */
for (Experiment experiment : experiments.getItems()) {
  System.out.println("Experiment Id     = " + experiment.getId());
  System.out.println("Experiment Name   = " + experiment.getName());
  System.out.println("Experiment Status = " + experiment.getStatus());

  // Loop through the variations.
  for (Variations variations : experiment.getVariations()) {
    System.out.println("Variation Name   = " + variations.getName());
    System.out.println("Variation Status = " + variations.getStatus());
    System.out.println("Variation Won    = " + variations.getWon() + "\n");
  }
}

PHP

از کتابخانه مشتری PHP استفاده می کند.

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

/**
 * Example #1:
 * Requests a list of all Experiments for the authorized user.
 */
try {
  $experiments = $analytics->management_experiments
      ->listManagementExperiments('123456', 'UA-123456-1', '7654321');

} 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 experiments object.
 * The following code shows how to iterate through them.
 */
foreach ($experiments->getItems() as $experiment) {

  $html = <<<HTML
<pre>
Experiment id     = {$experiment->getId()}
Experiment name   = {$experiment->getName()}
Experiment status = {$experiment->getStatus()}

HTML;
  foreach ($experiment->getVariations() as $variation) {
    $html .= <<< HTML
Variation name   = {$variation->getName()}
Variation status = {$variation->getStatus()}
Variation won    = {$variation->getWon()}

HTML;
  }
  $html .= '</pre>';
  print $html;
}

پایتون

از کتابخانه کلاینت پایتون استفاده می کند.

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

# Example #1:
# Requests a list of all experiments for the authorized user.
try:
  experiments = analytics.management().experiments().list(
      accountId='123456',
      webPropertyId='UA-123456-1',
      profileId='98765432'
  ).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 experiments object.
# The following code shows how to iterate through them.
for experiment in experiments.get('items', []):
  print 'Experiment Id     = %s' % experiment.get('id')
  print 'Experiment Name   = %s' % experiment.get('name')
  print 'Experiment Status = %s\n' % experiment.get('status')
  variations = experiment.get('variations', [])
  for variation in variations:
    print 'Variation Name   = %s' % variation.get('name')
    print 'Variation Status = %s' % variation.get('status')
    print 'Variation Won    = %s' % variation.get('won')

جاوا اسکریپت

از کتابخانه سرویس گیرنده جاوا اسکریپت استفاده می کند.

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

/*
 * Example 1:
 * Requests a list of all experiments for the authorized user.
 */
function listExperiements() {
  var request = gapi.client.analytics.management.experiments.list({
    'accountId': '123456',
    'webPropertyId': 'UA-123456-1',
    'profileId': '7654321'
  });
  request.execute(printExperiments);
}

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

      // Iterate through the variations.
      var variations = experiment.variations;
      if (variations) {
        for (var j = 0, variation; variation = variations[j]; j++) {
          console.log('Variation Name: ' + variation.name);
          console.log('Variation Status: ' + variation.status);
          console.log('Variation URL: ' + variation.url);
          console.log('Variation Won: ' + variation.won);
        }
      }
    }
  }
}