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

การให้สิทธิ์

คำขอนี้ต้องได้รับการให้สิทธิ์อย่างน้อย 1 ขอบเขตต่อไปนี้ (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)

ขอบเขต
`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 โดยค่าเริ่มต้น หรือมีการระบุโดยพารามิเตอร์การค้นหาผลลัพธ์สูงสุด
`previousLink`	`string`	ลิงก์ไปยังหน้าก่อนหน้าสำหรับคอลเล็กชันการทดสอบนี้
`nextLink`	`string`	ลิงก์ไปยังหน้าถัดไปของคอลเล็กชันการทดสอบนี้
`items[]`	`list`	รายการการทดสอบ

ตัวอย่าง

หมายเหตุ: ตัวอย่างโค้ดที่มีสำหรับวิธีการนี้ไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด (ดูรายการภาษาที่รองรับได้ในหน้าไลบรารีของไคลเอ็นต์)

Java

ใช้ไลบรารีของไคลเอ็นต์ Java

/*
 * 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;
}

Python

ใช้ไลบรารีของไคลเอ็นต์ Python

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

JavaScript

ใช้ไลบรารีของไคลเอ็นต์ JavaScript

/*
 * 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);
        }
      }
    }
  }
}