เวอร์ชันของ API กราฟ

เกณฑ์ชี้วัดข้อมูลเชิงลึกสำหรับ Instant Article

อ็อบเจ็กต์นี้แสดงถึงชุดเกณฑ์ชี้วัดข้อมูลเชิงลึกสำหรับ Instant Article รายการเดียว โดยอิงตาม URL แบบบัญญัติของบทความดังกล่าว คุณสามารถสืบค้นเกณฑ์ชี้วัดที่ระดับบทความได้ รวมถึงเกณฑ์ชี้วัดเกี่ยวกับองค์ประกอบสื่อแต่ละรายการภายในบทความนั้นๆ

โปรดอ่านข้อมูลเพิ่มเติมเกี่ยวกับ Instant Articles ที่เอกสารประกอบสำหรับผู้พัฒนาเกี่ยวกับ Instant Articles ของเรา

ข้อมูลเชิงลึกสำหรับบทความ

ตำแหน่งข้อมูลที่ใช้เพื่อสืบค้นข้อมูลเชิงลึกระดับบทความจะกำหนดจาก URL แบบบัญญัติของบทความที่กำลังได้รับการสืบค้น รวมถึงเกณฑ์ชี้วัดที่กำลังได้รับการค้นหา เราได้แสดงเกณฑ์ชี้วัดที่พร้อมใช้งานทั้งหมดไว้ในรายการด้านล่าง

Graph API Explorer

GET /v21.0/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url} HTTP/1.1
Host: graph.facebook.com

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

/* make the API call */
FB.api(
    "/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

สิทธิ์การอนุญาต

โทเค็นการเข้าถึงเพจที่มีสิทธิ์การอนุญาตread_insights จะสามารถเรียกดูเกณฑ์ชี้วัดสำหรับเพจนั้นๆ ได้ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับโทเค็นการเข้าถึงเพจที่เอกสารประกอบเรื่องโทเค็นการเข้าถึงเพจของเรา

พารามิเตอร์

ชื่อ	คำอธิบาย	ประเภท	จำเป็นต้องระบุ
`id`	URL แบบบัญญัติของ Instant Article	`url`	`yes`
`metric`	เกณฑ์ชี้วัดที่กำลังได้รับการขอ	โปรดดูที่เกณฑ์ชี้วัดที่พร้อมใช้งานด้านล่าง	`yes`
`period`	ระยะเวลาที่มีการรวบรวมเกณฑ์ชี้วัด	`enum{day, week, days_28, month, lifetime}`	`yes`
`since`	ขอบเขตล่างของช่วงเวลาที่จะพิจารณา ค่าเริ่มต้น: `2 weeks ago`	`datetime`	`no`
`until`	ขอบเขตบนของช่วงเวลาที่จะพิจารณา ค่าเริ่มต้น: `Current time`	`datetime`	`no`
`breakdown`	แยกผลลัพธ์ตามแพลตฟอร์ม (iOS หรือ Android) ที่มีเกณฑ์ชี้วัดนั้นเกิดขึ้น หากไม่ได้ระบุไว้ ผลลัพธ์จะรวมข้อมูลของทั้ง 2 แพลตฟอร์ม	`enum{platform}`	`no`

ช่อง

การอ่านจากจุดเชื่อมโยงนี้จะส่งคืนผลลัพธ์ที่มีการจัดรูปแบบ JSON ดังนี้

{
  "data": []
}

data

รายการอ็อบเจ็กต์ InsightsQueryResult ระบบจะเพิ่มช่องต่อไปนี้ไปยังแต่ละอ็อบเจ็กต์ที่ได้รับการส่งคืนมา

ชื่อ คำอธิบาย ประเภท

ชื่อ	คำอธิบาย	ประเภท
เวลา	จุดเริ่มต้นของช่วงเวลา หรือเวลาสิ้นสุดของช่วงระยะเวลา	`datetime`
ค่า	จำนวนของเกณฑ์ชี้วัด ค่าเฉลี่ย อัตราส่วน หรือเปอร์เซ็นต์ในช่วงเวลานั้นๆ	`numeric`
ข้อมูลแยกย่อย	บักเก็ตซึ่งมีค่านั้นๆ อยู่ (กล่าวคือ เมื่อมีการใช้เกณฑ์ชี้วัด `all_view_durations` หรือหากพารามิเตอร์ `breakdown(platform)` มีการระบุไว้อย่างชัดเจน)	`map<string, string>`

เวลา

จุดเริ่มต้นของช่วงเวลา หรือเวลาสิ้นสุดของช่วงระยะเวลา

datetime

ค่า

จำนวนของเกณฑ์ชี้วัด ค่าเฉลี่ย อัตราส่วน หรือเปอร์เซ็นต์ในช่วงเวลานั้นๆ

numeric

ข้อมูลแยกย่อย

บักเก็ตซึ่งมีค่านั้นๆ อยู่ (กล่าวคือ เมื่อมีการใช้เกณฑ์ชี้วัด

all_view_durations

หรือหากพารามิเตอร์

breakdown(platform)

มีการระบุไว้อย่างชัดเจน)

map<string, string>

เกณฑ์ชี้วัดที่พร้อมใช้งาน

รายการด้านล่างนี้คือช่วงการรวบรวมที่พร้อมใช้งานสำหรับเกณฑ์ชี้วัดต่างๆ ระบบจะรวบรวมเกณฑ์ชี้วัดจากอุปกรณ์ทั้ง iOS และ Android

ชื่อ	คำอธิบาย	ค่าสำหรับช่วงเวลา
`all_views`	จำนวนการดู	`day`
`all_view_durations`	ระยะเวลาของการดูพร้อมข้อมูลแยกย่อย	`week`
`all_view_durations_average`	ระยะเวลาโดยเฉลี่ยของการดู	`week`
`all_scrolls`	ปริมาณเนื้อหาที่เลื่อนอ่านพร้อมข้อมูลแยกย่อย	`week`
`all_scrolls_average`	ปริมาณเนื้อหาที่เลื่อนอ่านโดยเฉลี่ย	`week`

ตัวอย่าง

การดูบทความในแต่ละวันตลอดช่วง 7 วันที่ผ่านมา

หากต้องการสืบค้นข้อมูลแยกย่อยรายวันเกี่ยวกับจำนวนการดู Instant Articles รายการใดรายการหนึ่งของคุณตลอดช่วง 7 วันที่ผ่านมา ให้ส่งคำขอ GET ดังต่อไปนี้

GET /v21.0/?fields=instant_article{insights.metric(all_views).period(day).since(7 day ago).until(now)}&id=http://www.example.com/my-test-page.html&access_token={your-page-access-token} HTTP/1.1
Host: graph.facebook.com

คำขอนี้จะส่งคืนการตอบกลับดังต่อไปนี้

{
   "instant_article": {
      "insights": {
         "data": [
            {
               "time": "2015-10-28T08:00:00+0000",
               "value": "3"
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "3"
            },
            {
               "time": "2015-10-30T08:00:00+0000",
               "value": "3"
            },
            {
               "time": "2015-10-31T08:00:00+0000",
               "value": "3"
            },
            {
               "time": "2015-11-01T08:00:00+0000",
               "value": "2"
            },
            {
               "time": "2015-11-02T08:00:00+0000",
               "value": "6"
            },
            {
               "time": "2015-11-03T08:00:00+0000",
               "value": "4"
            }
         ]
      },
      "id": "<article-id>"
   },
   "id": "http://www.example.com/my-test-page.com"
}

การดูบทความในแต่ละวันตลอดช่วง 7 วันที่ผ่านมาพร้อมข้อมูลแยกย่อยของแพลตฟอร์ม

หากต้องการสืบค้นข้อมูลแยกย่อยรายวันเกี่ยวกับจำนวนการดู Instant Articles รายการใดรายการหนึ่งของคุณตลอดช่วง 7 วันที่ผ่านมา โดยมีการจำแนกเพิ่มเติมตามแพลตฟอร์มที่ใช้ดู ให้ส่งคำขอ GET ดังต่อไปนี้

GET /v21.0/?fields=instant_article{insights.metric(all_views).breakdown(platform).period(day).since(7 day ago).until(now)}&id=http://www.example.com/my-test-page.html&access_token={your-page-access-token} HTTP/1.1
Host: graph.facebook.com

คำขอนี้จะส่งคืนการตอบกลับดังต่อไปนี้

{
   "instant_article": {
      "insights": {
         "data": [
            {
              "time": "2015-10-28T08:00:00+0000",
              "value": "1",
              "breakdowns": {
                "platform": "ANDROID"
              }
            },
            {
              "time": "2015-10-28T08:00:00+0000",
              "value": "2",
              "breakdowns": {
                "platform": "IOS"
              }
            },
            {
              "time": "2015-10-29T08:00:00+0000",
              "value": "1",
              "breakdowns": {
                "platform": "ANDROID"
              }
            },
            {
              "time": "2015-10-29T08:00:00+0000",
              "value": "2",
              "breakdowns": {
                "platform": "IOS"
              }
            },
            {
              "time": "2015-10-30T08:00:00+0000",
              "value": "1",
              "breakdowns": {
                "platform": "ANDROID"
              }
            },
            {
              "time": "2015-10-30T08:00:00+0000",
              "value": "2",
              "breakdowns": {
                "platform": "IOS"
              }
            }
         ]
      },
      "id": "<article-id>"
   },
   "id": "http://www.example.com/my-test-page.com"
}

ระยะเวลาการดูบทความเป็นรายสัปดาห์ตลอดช่วง 7 วันที่ผ่านมา

หากต้องการสืบค้นข้อมูลแยกย่อยรายสัปดาห์เกี่ยวกับระยะเวลาการดูที่จัดเก็บแบบบักเก็ตไว้สำหรับ Instant Articles รายการใดรายการหนึ่งของคุณตลอดช่วง 7 วันที่ผ่านมา ให้ส่งคำขอ GET ดังต่อไปนี้

GET /v21.0/?fields=instant_article{insights.metric(all_view_durations).period(week).since(7 day ago).until(now)}&id=http://www.example.com/my-test-page.html&access_token={your-page-access-token} HTTP/1.1
Host: graph.facebook.com

คำขอนี้จะส่งคืนการตอบกลับดังต่อไปนี้ โปรดทราบว่าข้อมูลที่ส่งคืนมาในการตอบกลับนี้จะได้รับการจัดเก็บแบบบักเก็ตไว้ดังนี้

{
   "instant_article": {
      "insights": {
         "data": [
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "8",
               "breakdowns": {
                  "bucket": "15"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "2",
               "breakdowns": {
                  "bucket": "225"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "2",
               "breakdowns": {
                  "bucket": "90"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "360"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "240"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "165"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "120"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "75"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "60"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "45"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "30"
               }
            }
         ]
      },
      "id": "<article-id>"
   },
   "id": "http://www.example.com/my-test-page.com"
}