Method: reports.batchGet

แสดงข้อมูล Analytics

คำขอ HTTP

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet

URL ใช้ไวยากรณ์การแปลง gRPC

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
  "useResourceQuotas": boolean
}
ช่อง
reportRequests[]

object(ReportRequest)

คําขอแต่ละรายการจะมีคําตอบแยกกัน ส่งคำขอได้สูงสุด 5 รายการ คำขอทั้งหมดควรมี dateRanges, viewId, segments, samplingLevel และ cohortGroup เดียวกัน

useResourceQuotas

boolean

เปิดใช้โควต้าตามทรัพยากร (ค่าเริ่มต้นคือ False) หากตั้งค่าช่องนี้เป็น True โควต้าต่อการดู (โปรไฟล์) จะอยู่ภายใต้ต้นทุนการคำนวณของคำขอ โปรดทราบว่าการใช้โควต้าที่อิงตามต้นทุนจะทำให้อัตราการสุ่มตัวอย่างสูงขึ้น (10 ล้านสำหรับ SMALL, 100 ล้านสำหรับ LARGE โปรดดูรายละเอียดในเอกสารประกอบเกี่ยวกับขีดจำกัดและโควต้า

เนื้อหาการตอบกลับ

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

คลาสการตอบกลับหลักซึ่งเป็นที่เก็บรายงานจากการเรียกใช้ Reporting API batchGet

การแสดง JSON 
{
  "reports": [
    {
      object(Report)
    }
  ],
  "queryCost": number,
  "resourceQuotasRemaining": {
    object(ResourceQuotasRemaining)
  }
}
ช่อง
reports[]

object(Report)

การตอบกลับที่เกี่ยวข้องกับแต่ละคำขอ

queryCost

number

จำนวนโทเค็นโควต้าทรัพยากรที่หักออกเพื่อดำเนินการค้นหา รวมคำตอบทั้งหมด

resourceQuotasRemaining

object(ResourceQuotasRemaining)

จำนวนโควต้าทรัพยากรที่เหลือของพร็อพเพอร์ตี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ReportRequest

คลาสคำขอหลักซึ่งระบุคำขอ Reporting API

การแสดง JSON 
{
  "viewId": string,
  "dateRanges": [
    {
      object(DateRange)
    }
  ],
  "samplingLevel": enum(Sampling),
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "metricFilterClauses": [
    {
      object(MetricFilterClause)
    }
  ],
  "filtersExpression": string,
  "orderBys": [
    {
      object(OrderBy)
    }
  ],
  "segments": [
    {
      object(Segment)
    }
  ],
  "pivots": [
    {
      object(Pivot)
    }
  ],
  "cohortGroup": {
    object(CohortGroup)
  },
  "pageToken": string,
  "pageSize": number,
  "includeEmptyRows": boolean,
  "hideTotals": boolean,
  "hideValueRanges": boolean
}
ช่อง
viewId

string

รหัสข้อมูลพร็อพเพอร์ตี้ของ Analytics ที่จะดึงข้อมูล ทุก ReportRequest ภายในเมธอด batchGet ต้องมี viewId เดียวกัน

dateRanges[]

object(DateRange)

ช่วงวันที่ในคำขอ คําขอมีช่วงวันที่ได้สูงสุด 2 ช่วง การตอบกลับจะมีชุดค่าเมตริกสำหรับชุดค่าผสมของมิติข้อมูลแต่ละชุดในช่วงวันที่แต่ละช่วงในคำขอ ดังนั้น หากมีช่วงวันที่สองช่วง จะมีชุดค่าเมตริกสองชุด โดยชุดหนึ่งสำหรับช่วงวันที่เดิมและอีกชุดหนึ่งสำหรับช่วงวันที่ที่สอง ไม่ควรระบุช่อง reportRequest.dateRanges สำหรับกลุ่มประชากรตามรุ่นหรือคำขอมูลค่าตลอดอายุการใช้งาน หากไม่ได้ระบุช่วงวันที่ ช่วงวันที่เริ่มต้นคือ (startDate: วันที่ปัจจุบัน - 7 วัน, endDate: วันที่ปัจจุบัน - 1 วัน) ทุกๆ ReportRequest ภายในเมธอด batchGet ต้องมีคำจำกัดความ dateRanges เหมือนกัน

samplingLevel

enum(Sampling)

ขนาดตัวอย่างของรายงานที่ต้องการ หากไม่ระบุช่อง samplingLevel ระบบจะใช้ระดับการสุ่มตัวอย่าง DEFAULT ทุกๆ ReportRequest ภายในเมธอด batchGet ต้องมีคำจำกัดความ samplingLevel เหมือนกัน ดูรายละเอียดได้จากคู่มือนักพัฒนาซอฟต์แวร์

dimensions[]

object(Dimension)

มิติข้อมูลที่ขอ คําขอมีมิติข้อมูลได้ทั้งหมด 9 รายการ

dimensionFilterClauses[]

object(DimensionFilterClause)

อนุประโยคของตัวกรองมิติข้อมูลสำหรับการกรองค่ามิติข้อมูล ซึ่งจะถูกรวมเข้ากับโอเปอเรเตอร์ AND อย่างมีตรรกะ โปรดทราบว่าการกรองจะเกิดขึ้นก่อนที่จะมีการรวมมิติข้อมูล เพื่อให้เมตริกที่แสดงผลแสดงผลรวมของมิติข้อมูลที่เกี่ยวข้องเท่านั้น

metrics[]

object(Metric)

เมตริกที่ขอ คำขอต้องระบุเมตริกอย่างน้อย 1 รายการ คําขอมีเมตริกทั้งหมดได้ 10 รายการ

metricFilterClauses[]

object(MetricFilterClause)

ข้อความตัวกรองเมตริก ซึ่งจะถูกรวมเข้ากับโอเปอเรเตอร์ AND อย่างมีตรรกะ ตัวกรองเมตริกจะพิจารณาเฉพาะช่วงวันที่แรกเท่านั้น ไม่ใช่ช่วงวันที่เปรียบเทียบ โปรดทราบว่าการกรองเมตริกจะเกิดขึ้นหลังจากรวมเมตริกแล้ว

filtersExpression

string

ตัวกรองมิติข้อมูลหรือเมตริกที่จำกัดข้อมูลที่แสดงผลสำหรับคำขอของคุณ หากต้องการใช้ filtersExpression ให้ระบุมิติข้อมูลหรือเมตริกที่ต้องการกรอง ตามด้วยนิพจน์ตัวกรอง ตัวอย่างเช่น นิพจน์ต่อไปนี้เลือกมิติข้อมูล ga:browser ซึ่งเริ่มต้นด้วย Firefox; ga:browser=~^Firefox ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวกรองมิติข้อมูลและเมตริกได้ที่ข้อมูลอ้างอิงตัวกรอง

orderBys[]

object(OrderBy)

ลำดับการจัดเรียงในแถวเอาต์พุต หากต้องการเปรียบเทียบ 2 แถว ระบบจะใช้องค์ประกอบต่อไปนี้ตามลำดับจนกว่าจะพบความแตกต่าง ช่วงวันที่ทั้งหมดในเอาต์พุตจะได้รับลําดับแถวเดียวกัน

segments[]

object(Segment)

แบ่งกลุ่มข้อมูลที่ส่งกลับมาสำหรับคำขอ คำจำกัดความกลุ่มจะช่วยพิจารณาคำขอกลุ่มชุดย่อย คำขอมีกลุ่มได้สูงสุด 4 กลุ่ม ทุกๆ ReportRequest ภายในเมธอด batchGet ต้องมีคำจำกัดความ segments เหมือนกัน คำขอที่มีกลุ่มต้องมีมิติข้อมูล ga:segment

pivots[]

object(Pivot)

คำจำกัดความของ Pivot คําขอมี Pivot ได้สูงสุด 2 รายการ

cohortGroup

object(CohortGroup)

กลุ่มประชากรตามรุ่นที่เชื่อมโยงกับคำขอนี้ หากมีกลุ่มประชากรตามรุ่นในคำขอ จะต้องมีมิติข้อมูล ga:cohort ทุกๆ ReportRequest ภายในเมธอด batchGet ต้องมีคำจำกัดความ cohortGroup เหมือนกัน

pageToken

string

โทเค็นความต่อเนื่องสำหรับรับผลการค้นหาหน้าถัดไป การเพิ่มข้อมูลนี้ไปยังคําขอจะแสดงแถวต่อจาก pageToken pageToken ควรเป็นค่าที่แสดงผลในพารามิเตอร์ nextPageToken ในการตอบกลับคําขอ reports.batchGet

pageSize

number

ขนาดของหน้าเว็บมีไว้สำหรับการแบ่งหน้าและระบุจำนวนแถวที่ส่งกลับสูงสุด ขนาดหน้าควรมากกว่า= 0 การค้นหาจะแสดงแถวที่เป็นค่าเริ่มต้น 1,000 แถว Analytics Core Reporting API จะส่งกลับแถวสูงสุด 100,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม และอาจแสดงแถวน้อยกว่าที่ขอด้วยหากไม่มีกลุ่มมิติข้อมูลมากเท่ากับที่คาดไว้ ตัวอย่างเช่น ค่าที่เป็นไปได้สำหรับ ga:country มีค่าน้อยกว่า 300 ค่า ดังนั้นเมื่อแบ่งกลุ่มตามประเทศเท่านั้น จะมีแถวได้ไม่เกิน 300 แถว แม้ว่าคุณจะตั้งค่า pageSize เป็นค่าที่สูงกว่าก็ตาม

includeEmptyRows

boolean

หากตั้งค่าเป็น "เท็จ" การตอบกลับจะไม่รวมแถวหากเมตริกที่ดึงมาทั้งหมดเท่ากับ 0 ค่าเริ่มต้นคือ false ซึ่งจะยกเว้นแถวเหล่านี้

hideTotals

boolean

หากตั้งค่าเป็น "จริง" จะซ่อนยอดรวมของเมตริกทั้งหมดสำหรับแถวที่ตรงกันทั้งหมดในทุกช่วงวันที่ ค่าเริ่มต้น false และจะแสดงค่ารวม

hideValueRanges

boolean

หากตั้งค่าเป็น "จริง" จะซ่อนค่าต่ำสุดและสูงสุดในแถวที่ตรงกันทั้งหมด ค่าเริ่มต้นคือ false และจะแสดงผลช่วงค่า

ทดสอบผลิตภัณฑ์

ค่าสำหรับระดับการสุ่มตัวอย่าง

Enum
SAMPLING_UNSPECIFIED หากไม่ระบุช่อง samplingLevel ระบบจะใช้ระดับการสุ่มตัวอย่าง DEFAULT
DEFAULT แสดงผลคำตอบที่มีขนาดตัวอย่างซึ่งรักษาสมดุลระหว่างความเร็วกับความแม่นยำ
SMALL แสดงผลอย่างรวดเร็วด้วยการสุ่มตัวอย่างขนาดเล็กลง
LARGE แสดงผลการตอบสนองที่แม่นยำมากขึ้นโดยใช้การสุ่มตัวอย่างขนาดใหญ่ แต่อาจส่งผลให้การตอบสนองช้าลง

มิติข้อมูล

มิติข้อมูลคือคุณลักษณะของข้อมูล ตัวอย่างเช่น มิติข้อมูล ga:city บ่งบอกถึงเมืองที่เป็นต้นทางของเซสชันหนึ่งๆ เช่น "ปารีส" หรือ "นิวยอร์ก"

การแสดง JSON 
{
  "name": string,
  "histogramBuckets": [
    string
  ]
}
ช่อง
name

string

ชื่อของมิติข้อมูลที่จะดึงข้อมูล เช่น ga:browser

histogramBuckets[]

string (int64 format)

หากไม่ว่างเปล่า เราจะวางค่ามิติข้อมูลลงในที่เก็บข้อมูลหลังสตริงไปยัง int64 ระบบจะแปลงค่ามิติข้อมูลที่ไม่ใช่การแสดงสตริงของค่าปริพันธ์เป็น 0 ค่าของที่เก็บข้อมูลต้องเรียงตามลำดับมากขึ้น ที่เก็บข้อมูลแต่ละชุดจะปิดที่ส่วนล่าง และเปิดที่ส่วนบน ที่เก็บข้อมูล "แรก" จะรวมค่าทั้งหมดที่ต่ำกว่าขอบเขตแรก ส่วนที่เก็บข้อมูล "สุดท้าย" จะรวมค่าทั้งหมดจนถึงค่าอนันต์ ค่ามิติข้อมูลที่อยู่ในที่เก็บข้อมูลจะเปลี่ยนไปเป็นค่ามิติข้อมูลใหม่ ตัวอย่างเช่น ถ้ารายการหนึ่งแสดงรายการเป็น "0, 1, 3, 4, 7" เราจะแสดงที่เก็บข้อมูลต่อไปนี้

  • ที่เก็บข้อมูล #1: ค่า < 0, ค่ามิติข้อมูล "<0"
  • ที่เก็บข้อมูล #2: ค่าใน [0,1), ค่ามิติข้อมูล "0"
  • ที่เก็บข้อมูล #3: ค่าใน [1,3), ค่ามิติข้อมูล "1-2"
  • ที่เก็บข้อมูล #4: ค่าใน [3,4), ค่ามิติข้อมูล "3"
  • ที่เก็บข้อมูล #5: ค่าใน [4,7), ค่ามิติข้อมูล "4-6"
  • ที่เก็บข้อมูล #6: ค่า >= 7, ค่ามิติข้อมูล "7+"

หมายเหตุ: หากคุณใช้การเปลี่ยนแปลงฮิสโตแกรมกับมิติข้อมูลใดๆ และใช้มิติข้อมูลนั้นในการจัดเรียง คุณจะต้องใช้ประเภทการจัดเรียง HISTOGRAM_BUCKET สำหรับวัตถุประสงค์ดังกล่าว หากไม่เป็นเช่นนั้น ค่ามิติข้อมูลจะจัดเรียงตามลำดับของพจนานุกรม (พจนานุกรม) เช่น ลำดับพจนานุกรมจากน้อยไปมากคือ

"<50", "1001+", "121-1,000", "50-120"

และลำดับ HISTOGRAM_BUCKET จากน้อยไปมากคือ

"<50", "50-120", "121-1000", "1,001 ขึ้นไป"

ไคลเอ็นต์ต้องขอ "orderType": "HISTOGRAM_BUCKET" อย่างชัดเจนสำหรับมิติข้อมูลที่เปลี่ยนแปลงฮิสโตแกรม

DimensionFilterClause

กลุ่มตัวกรองมิติข้อมูล ตั้งค่าโอเปอเรเตอร์เพื่อระบุวิธีรวมตัวกรองอย่างสมเหตุสมผล

การแสดง JSON 
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ]
}
ช่อง
operator

enum(FilterLogicalOperator)

โอเปอเรเตอร์สำหรับรวมตัวกรองมิติข้อมูลหลายรายการ หากไม่ระบุ ระบบจะถือว่าเป็น OR

filters[]

object(DimensionFilter)

ชุดตัวกรองที่ซ้ำกัน ระบบจะรวมตรรกะเหล่านี้เข้าด้วยกันตามโอเปอเรเตอร์ที่ระบุ

FilterLogicalOperator

วิธีรวมตัวกรองอย่างสมเหตุสมผล

Enum
OPERATOR_UNSPECIFIED โอเปอเรเตอร์ที่ไม่ระบุ ระบบจะถือว่าเป็น OR
OR โอเปอเรเตอร์แบบตรรกะ OR
AND โอเปอเรเตอร์แบบตรรกะ AND

DimensionFilter

ตัวกรองมิติข้อมูลระบุตัวเลือกการกรองในมิติข้อมูล

การแสดง JSON 
{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean
}
ช่อง
dimensionName

string

มิติข้อมูลที่จะกรอง DimensionFilter ต้องมีมิติข้อมูล

not

boolean

โอเปอเรเตอร์ตรรกะ NOT หากตั้งค่าบูลีนนี้เป็นจริง ค่ามิติข้อมูลที่ตรงกันจะไม่รวมอยู่ในรายงาน ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ"

operator

enum(Operator)

วิธีจับคู่มิติข้อมูลกับนิพจน์ ค่าเริ่มต้นคือ REGEXP

expressions[]

string

สตริงหรือนิพจน์ทั่วไปที่จะจับคู่กับ ระบบจะใช้เพียงค่าแรกของรายการในการเปรียบเทียบ เว้นแต่โอเปอเรเตอร์จะเป็น IN_LIST หากเป็นโอเปอเรเตอร์ IN_LIST ระบบจะใช้ทั้งรายการเพื่อกรองมิติข้อมูลตามที่อธิบายไว้ในคำอธิบายของโอเปอเรเตอร์ IN_LIST

caseSensitive

boolean

การจับคู่ควรคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่หรือไม่ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้ที่ false

ผู้ประกอบธุรกิจ

รองรับประเภทการทำงานของคีย์เวิร์ดที่แตกต่างกัน

Enum
OPERATOR_UNSPECIFIED หากไม่ได้ระบุประเภทการทำงานของคีย์เวิร์ด ระบบจะถือว่าเป็น REGEXP
REGEXP ระบบจะถือว่านิพจน์จับคู่เป็นนิพจน์ทั่วไป ประเภทการทำงานของคีย์เวิร์ดทั้งหมดจะไม่ถือว่าเป็นนิพจน์ทั่วไป
BEGINS_WITH จับคู่ค่าที่เริ่มต้นด้วยนิพจน์การจับคู่ที่ระบุ
ENDS_WITH จับคู่ค่าที่ลงท้ายด้วยนิพจน์การจับคู่ที่ระบุ
PARTIAL การจับคู่สตริงย่อย
EXACT ค่าควรตรงกับนิพจน์ที่ตรงกันทั้งหมด
NUMERIC_EQUAL

ตัวกรองการเปรียบเทียบจำนวนเต็ม ระบบจะไม่สนใจตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ของค่าเหล่านี้ และจะถือว่านิพจน์เป็นสตริงที่แสดงจำนวนเต็ม เงื่อนไขความล้มเหลว:

  • หากนิพจน์ไม่ใช่ int64 ที่ถูกต้อง ไคลเอ็นต์จะพบข้อผิดพลาด
  • มิติข้อมูลอินพุตที่ไม่ใช่ค่า int64 ที่ถูกต้องจะไม่จับคู่กับตัวกรอง
NUMERIC_GREATER_THAN ตรวจสอบว่ามิติข้อมูลมีค่ามากกว่านิพจน์การจับคู่หรือไม่ อ่านคำอธิบายของ NUMERIC_EQUALS เพื่อดูข้อจำกัด
NUMERIC_LESS_THAN ตรวจสอบว่ามิติข้อมูลมีตัวเลขน้อยกว่านิพจน์การจับคู่หรือไม่ อ่านคำอธิบายของ NUMERIC_EQUALS เพื่อดูข้อจำกัด
IN_LIST

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

expressions: ["A", "B", "C"]

แถวคำตอบที่มีมิติข้อมูลมีค่าเป็น A, B หรือ C จะตรงกับ DimensionFilter นี้

เมตริก

เมตริกคือการวัดเชิงปริมาณ ตัวอย่างเช่น เมตริก ga:users จะระบุจำนวนผู้ใช้ทั้งหมดในระยะเวลาที่ขอ

การแสดง JSON 
{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType)
}
ช่อง
expression

string

นิพจน์เมตริกในคำขอ นิพจน์สร้างขึ้นจากเมตริกและตัวเลขอย่างน้อย 1 รายการ โอเปอเรเตอร์ที่ยอมรับ ได้แก่ เครื่องหมายบวก (+), เครื่องหมายลบ (-), นิเสธ (Unary -), หารด้วย (/), คูณด้วย (*), วงเล็บ, จํานวนนับที่เป็นบวก (0-9) อาจมีทศนิยมและจํากัดอยู่ที่ 1,024 อักขระ ตัวอย่าง ga:totalRefunds/ga:users ในกรณีส่วนใหญ่ นิพจน์เมตริกเป็นเพียงชื่อเมตริกเดียว เช่น ga:users การเพิ่ม MetricType ผสม (เช่น CURRENCY + PERCENTAGE) จะทำให้ได้รับผลลัพธ์ที่ไม่คาดคิด

alias

string

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

formattingType

enum(MetricType)

ระบุวิธีจัดรูปแบบนิพจน์เมตริก เช่น INTEGER

MetricType

ประเภทของเมตริก

Enum
METRIC_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทเมตริก
INTEGER เมตริกจำนวนเต็ม
FLOAT เมตริกทศนิยม
CURRENCY เมตริกสกุลเงิน
PERCENT เมตริกเปอร์เซ็นต์
TIME เมตริกเวลาในรูปแบบ HH:MM:SS

MetricFilterClause

แสดงกลุ่มตัวกรองเมตริก ตั้งค่าโอเปอเรเตอร์เพื่อระบุวิธีรวมตัวกรองอย่างสมเหตุสมผล

การแสดง JSON 
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ]
}
ช่อง
operator

enum(FilterLogicalOperator)

โอเปอเรเตอร์สําหรับการรวมตัวกรองเมตริกหลายรายการ หากไม่ระบุ ระบบจะถือว่าเป็น OR

filters[]

object(MetricFilter)

ชุดตัวกรองที่ซ้ำกัน ระบบจะรวมตรรกะเหล่านี้เข้าด้วยกันตามโอเปอเรเตอร์ที่ระบุ

MetricFilter

MetricFilter ระบุตัวกรองในเมตริก

การแสดง JSON 
{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string
}
ช่อง
metricName

string

เมตริกที่จะกรอง ตัวกรองเมตริกต้องมีชื่อเมตริก ชื่อเมตริกอาจเป็นชื่อแทนที่กำหนดไว้ก่อนหน้าเป็นเมตริกหรืออาจเป็นนิพจน์เมตริกก็ได้

not

boolean

โอเปอเรเตอร์ตรรกะ NOT หากบูลีนนี้ตั้งค่าเป็น "จริง" ค่าเมตริกที่ตรงกันจะไม่รวมอยู่ในรายงาน ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ"

operator

enum(Operator)

เมตริก EQUAL, LESS_THAN หรือ GREATER_THAN เป็น conversionValue ค่าเริ่มต้นคือ EQUAL หากโอเปอเรเตอร์คือ IS_MISSING ให้ตรวจสอบว่าเมตริกหายไปหรือไม่และจะไม่สนใจ conversionValue

comparisonValue

string

ค่าที่จะเปรียบเทียบ

ผู้ประกอบธุรกิจ

ตัวเลือกประเภทการเปรียบเทียบที่แตกต่างกัน

Enum
OPERATOR_UNSPECIFIED หากไม่ได้ระบุโอเปอเรเตอร์ ระบบจะถือว่าเป็น EQUAL
EQUAL ค่าของเมตริกควรเท่ากับค่าเปรียบเทียบทุกประการ
LESS_THAN ค่าของเมตริกน้อยกว่าค่าเปรียบเทียบ
GREATER_THAN ค่าของเมตริกมากกว่าค่าเปรียบเทียบ
IS_MISSING ตรวจสอบว่าเมตริกขาดหายไปหรือไม่ ไม่นำการเปรียบเทียบค่ามาพิจารณา

OrderBy

ระบุตัวเลือกการจัดเรียง

การแสดง JSON 
{
  "fieldName": string,
  "orderType": enum(OrderType),
  "sortOrder": enum(SortOrder)
}
ช่อง
fieldName

string

ฟิลด์ที่จะจัดเรียง ลำดับการจัดเรียงเริ่มต้นคือจากน้อยไปมาก ตัวอย่าง: ga:browser โปรดทราบว่าคุณสามารถระบุได้เพียงช่องเดียวเพื่อจัดเรียงที่นี่ ตัวอย่างเช่น ga:browser, ga:city ไม่ถูกต้อง

orderType

enum(OrderType)

ประเภทคำสั่งซื้อ orderType เริ่มต้นคือ VALUE

sortOrder

enum(SortOrder)

ลำดับการจัดเรียงช่อง

OrderType

orderType จะควบคุมวิธีการกำหนดลำดับการจัดเรียง

Enum
ORDER_TYPE_UNSPECIFIED ประเภทคำสั่งซื้อที่ไม่ได้ระบุจะถือเป็นการจัดเรียงตามค่า
VALUE ลำดับการจัดเรียงจะอิงจากค่าของคอลัมน์ที่เลือก โดยดูเฉพาะช่วงวันที่แรกเท่านั้น
DELTA ลำดับการจัดเรียงจะขึ้นอยู่กับความแตกต่างของค่าของคอลัมน์ที่เลือกระหว่างช่วงวันที่ 2 ช่วงแรก ใช้ได้ก็ต่อเมื่อมีช่วงวันที่ 2 ช่วงเท่านั้น
SMART ลำดับการจัดเรียงจะอิงตามค่าถ่วงน้ำหนักของคอลัมน์ที่เลือก หากคอลัมน์มีรูปแบบ n/d ค่าถ่วงน้ำหนักของอัตราส่วนนี้จะเป็น (n + totals.n)/(d + totals.d) ใช้ได้กับเมตริกที่แสดงอัตราส่วนเท่านั้น
HISTOGRAM_BUCKET ประเภทลำดับฮิสโตแกรมใช้ได้กับคอลัมน์มิติข้อมูลที่มีที่เก็บข้อมูลฮิสโตแกรมที่ไม่ว่างเปล่าเท่านั้น
DIMENSION_AS_INTEGER หากขนาดเป็นตัวเลขความยาวคงที่ การจัดเรียงแบบธรรมดาจะคงใช้งานได้ดี สามารถใช้ DIMENSION_AS_INTEGER ได้หากมิติข้อมูลเป็นตัวเลขที่มีความยาวแปรผัน

SortOrder

ลำดับการจัดเรียง

Enum
SORT_ORDER_UNSPECIFIED หากไม่ได้ระบุลำดับการจัดเรียง ค่าเริ่มต้นจะเป็นจากน้อยไปมาก
ASCENDING จัดเรียงจากน้อยไปมาก โดยจะจัดเรียงฟิลด์จากน้อยไปมาก
DESCENDING จัดเรียงจากมากไปน้อย ระบบจะจัดเรียงฟิลด์จากมากไปน้อย

กลุ่ม

คำจำกัดความของกลุ่ม หากจำเป็นต้องแบ่งกลุ่มรายงาน กลุ่มคือชุดย่อยของข้อมูล Analytics ตัวอย่างเช่น จากกลุ่มผู้ใช้ทั้งหมด กลุ่มหนึ่งอาจเป็นผู้ใช้จากประเทศหรือเมืองหนึ่งๆ

การแสดง JSON 
{

  // Union field dynamicOrById can be only one of the following:
  "dynamicSegment": {
    object(DynamicSegment)
  },
  "segmentId": string
  // End of list of possible types for union field dynamicOrById.
}
ช่อง
ฟิลด์สหภาพ dynamicOrById คุณจะกำหนดกลุ่มแบบไดนามิกได้โดยใช้กลุ่มแบบไดนามิกหรือโดยใช้รหัสของกลุ่มในตัวหรือกลุ่มที่กำหนดเอง dynamicOrById ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
dynamicSegment

object(DynamicSegment)

คำจำกัดความกลุ่มแบบไดนามิกในคำขอ

segmentId

string

รหัสกลุ่มของกลุ่มในตัวหรือที่กำหนดเอง เช่น gaid::-3

DynamicSegment

คำจำกัดความกลุ่มแบบไดนามิกสำหรับการกำหนดกลุ่มภายในคำขอ กลุ่มสามารถเลือกผู้ใช้ เซสชัน หรือทั้งคู่

การแสดง JSON 
{
  "name": string,
  "userSegment": {
    object(SegmentDefinition)
  },
  "sessionSegment": {
    object(SegmentDefinition)
  }
}
ช่อง
name

string

ชื่อกลุ่มแบบไดนามิก

userSegment

object(SegmentDefinition)

กลุ่มผู้ใช้เพื่อเลือกผู้ใช้ที่จะรวมไว้ในกลุ่ม

sessionSegment

object(SegmentDefinition)

กลุ่มเซสชันเพื่อเลือกเซสชันที่จะรวมไว้ในกลุ่ม

SegmentDefinition

SegmentDefinition กำหนดให้กลุ่มเป็นชุดของ SegmentFiltered ซึ่งจะรวมเข้าด้วยกันด้วยการดำเนินการ AND เชิงตรรกะ

การแสดง JSON 
{
  "segmentFilters": [
    {
      object(SegmentFilter)
    }
  ]
}
ช่อง
segmentFilters[]

object(SegmentFilter)

กลุ่มจะกำหนดโดยชุดตัวกรองกลุ่มซึ่งรวมเข้าด้วยกันด้วยการดำเนินการ AND เชิงตรรกะ

SegmentFilter

SegmentFilter จะกําหนดกลุ่มเป็นกลุ่มแบบง่ายหรือกลุ่มลําดับ เงื่อนไขกลุ่มอย่างง่ายประกอบด้วยเงื่อนไขมิติข้อมูลและเมตริกสำหรับเลือกเซสชันหรือผู้ใช้ เงื่อนไขของกลุ่มลำดับสามารถใช้เพื่อเลือกผู้ใช้หรือเซสชันตามเงื่อนไขที่เรียงตามลำดับ

การแสดง JSON 
{
  "not": boolean,

  // Union field simpleOrSequence can be only one of the following:
  "simpleSegment": {
    object(SimpleSegment)
  },
  "sequenceSegment": {
    object(SequenceSegment)
  }
  // End of list of possible types for union field simpleOrSequence.
}
ช่อง
not

boolean

หากเป็นจริง ให้จับคู่ส่วนเสริมของเซกเมนต์อย่างง่ายหรือเซกเมนต์ตามลำดับ ตัวอย่างเช่น เพื่อจับคู่การเข้าชมทั้งหมดที่ไม่ได้มาจาก "นิวยอร์ก" เราสามารถกำหนดกลุ่มได้ดังนี้:

  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },

ฟิลด์สหภาพ simpleOrSequence นี่เป็นกลุ่มแบบง่ายหรือคำจำกัดความของกลุ่มลำดับ simpleOrSequence ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
simpleSegment

object(SimpleSegment)

เงื่อนไขกลุ่มแบบง่ายประกอบด้วยเงื่อนไขมิติข้อมูล/เมตริกอย่างน้อย 1 ข้อที่รวมกันได้

sequenceSegment

object(SequenceSegment)

เงื่อนไขลำดับประกอบด้วยขั้นตอนอย่างน้อย 1 ขั้นตอน โดยแต่ละขั้นตอนจะได้รับการกำหนดโดยเงื่อนไขมิติข้อมูล/เมตริกอย่างน้อย 1 รายการ และสามารถใช้ร่วมกับโอเปอเรเตอร์ลำดับพิเศษได้หลายขั้นตอน

SimpleSegment

เงื่อนไขกลุ่มแบบง่ายประกอบด้วยเงื่อนไขมิติข้อมูล/เมตริกอย่างน้อย 1 ข้อที่รวมกันได้

การแสดง JSON 
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ]
}
ช่อง
orFiltersForSegment[]

object(OrFiltersForSegment)

รายการของกลุ่มตัวกรองกลุ่มซึ่งรวมกับโอเปอเรเตอร์เชิงตรรกะ AND

OrFiltersForSegment

รายการตัวกรองกลุ่มในกลุ่ม OR จะรวมกันกับโอเปอเรเตอร์ตรรกะ OR

การแสดง JSON 
{
  "segmentFilterClauses": [
    {
      object(SegmentFilterClause)
    }
  ]
}
ช่อง
segmentFilterClauses[]

object(SegmentFilterClause)

รายการตัวกรองกลุ่มที่จะรวมกับโอเปอเรเตอร์ OR

SegmentFilterClause

เงื่อนไขตัวกรองที่จะใช้ในคำจำกัดความกลุ่มสามารถใช้กับเมตริกหรือตัวกรองมิติข้อมูลก็ได้

การแสดง JSON 
{
  "not": boolean,

  // Union field dimensionOrMetricFilter can be only one of the following:
  "dimensionFilter": {
    object(SegmentDimensionFilter)
  },
  "metricFilter": {
    object(SegmentMetricFilter)
  }
  // End of list of possible types for union field dimensionOrMetricFilter.
}
ช่อง
not

boolean

ตรงกับส่วนเสริม (!) ของตัวกรอง

ฟิลด์สหภาพ dimensionOrMetricFilter ตัวกรองมิติข้อมูลหรือเมตริก dimensionOrMetricFilter ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
dimensionFilter

object(SegmentDimensionFilter)

ตัวกรองมิติข้อมูลสำหรับการกำหนดกลุ่ม

metricFilter

object(SegmentMetricFilter)

ตัวกรองเมตริกสำหรับการกำหนดกลุ่ม

SegmentDimensionFilter

ตัวกรองมิติข้อมูลระบุตัวเลือกการกรองในมิติข้อมูล

การแสดง JSON 
{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string
}
ช่อง
dimensionName

string

ชื่อของมิติข้อมูลที่ใช้ตัวกรองอยู่

operator

enum(Operator)

โอเปอเรเตอร์ที่จะใช้จับคู่มิติข้อมูลกับนิพจน์

caseSensitive

boolean

หากการจับคู่จะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ ระบบจะละเว้นสำหรับโอเปอเรเตอร์ IN_LIST

expressions[]

string

รายการนิพจน์ ใช้เฉพาะองค์ประกอบแรกเท่านั้นสําหรับโอเปอเรเตอร์ทั้งหมด

minComparisonValue

string

ค่าการเปรียบเทียบขั้นต่ำสำหรับประเภทการทำงานของคีย์เวิร์ด BETWEEN ประเภท

maxComparisonValue

string

ค่าเปรียบเทียบสูงสุดสำหรับประเภทการทำงานของคีย์เวิร์ด BETWEEN ประเภท

ผู้ประกอบธุรกิจ

รองรับประเภทการทำงานของคีย์เวิร์ดที่แตกต่างกัน

Enum
OPERATOR_UNSPECIFIED หากไม่ได้ระบุประเภทการจับคู่ ระบบจะถือว่าเป็น REGEXP
REGEXP ระบบจะถือว่านิพจน์จับคู่เป็นนิพจน์ทั่วไป ประเภทการทำงานของคีย์เวิร์ดอื่นๆ ทั้งหมดจะไม่ถือว่าเป็นนิพจน์ทั่วไป
BEGINS_WITH จับคู่ค่าที่เริ่มต้นด้วยนิพจน์การจับคู่ที่ระบุ
ENDS_WITH จับคู่ค่าที่ลงท้ายด้วยนิพจน์การจับคู่ที่ระบุ
PARTIAL การจับคู่สตริงย่อย
EXACT ค่าควรตรงกับนิพจน์ที่ตรงกันทั้งหมด
IN_LIST

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

expressions: ["A", "B", "C"]

แถวคำตอบที่มีมิติข้อมูลมีค่าเป็น A, B หรือ C จะตรงกับ DimensionFilter นี้
NUMERIC_LESS_THAN

ตัวกรองการเปรียบเทียบจำนวนเต็ม ระบบจะไม่สนใจตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ของค่าเหล่านี้ และจะถือว่านิพจน์เป็นสตริงที่แสดงจำนวนเต็ม เงื่อนไขความล้มเหลว:

  • หากนิพจน์ไม่ใช่ int64 ที่ถูกต้อง ไคลเอ็นต์จะพบข้อผิดพลาด
  • มิติข้อมูลอินพุตที่ไม่ใช่ค่า int64 ที่ถูกต้องจะไม่จับคู่กับตัวกรอง

ตรวจสอบว่ามิติข้อมูลมีตัวเลขน้อยกว่านิพจน์การจับคู่หรือไม่
NUMERIC_GREATER_THAN ตรวจสอบว่ามิติข้อมูลมีค่ามากกว่านิพจน์การจับคู่หรือไม่
NUMERIC_BETWEEN ตรวจสอบว่ามิติข้อมูลเป็นตัวเลขระหว่างค่าต่ำสุดและสูงสุดของนิพจน์การจับคู่ ซึ่งไม่รวมขอบเขต

SegmentMetricFilter

ตัวกรองเมตริกที่จะใช้ในวลีตัวกรองกลุ่ม

การแสดง JSON 
{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string
}
ช่อง
scope

enum(Scope)

ขอบเขตสำหรับเมตริกเป็นตัวกำหนดระดับที่มีการกำหนดเมตริกนั้น ขอบเขตเมตริกที่ระบุต้องเท่ากับหรือมากกว่าขอบเขตหลักตามที่ระบุไว้ในโมเดลข้อมูล ขอบเขตหลักจะกําหนดโดยหากกลุ่มเลือกผู้ใช้หรือเซสชัน

metricName

string

เมตริกที่จะกรอง metricFilter ต้องมีชื่อเมตริก

operator

enum(Operator)

ระบุคือการดำเนินการเพื่อเปรียบเทียบเมตริก โดยมีค่าเริ่มต้นเป็น EQUAL

comparisonValue

string

ค่าที่จะเปรียบเทียบ หากโอเปอเรเตอร์คือ BETWEEN ระบบจะถือว่าค่านี้เป็นค่าขั้นต่ำของการเปรียบเทียบ

maxComparisonValue

string

ใช้ค่าเปรียบเทียบสูงสุดกับโอเปอเรเตอร์ BETWEEN เท่านั้น

ขอบเขต

ขอบเขตสำหรับเมตริกจะกำหนดระดับที่มีการกำหนดเมตริกดังกล่าว ได้แก่ PRODUCT, HIT, SESSION หรือ USER นอกจากนี้ ยังสามารถรายงานค่าเมตริกในขอบเขตที่มากกว่าขอบเขตหลักได้ด้วย เช่น คุณสามารถรายงาน ga:pageviews และ ga:transactions ที่ระดับ SESSION และ USER ได้ด้วยการเพิ่มข้อมูลให้กับ Hit แต่ละรายการที่เกิดขึ้นในเซสชันเหล่านั้นหรือสำหรับผู้ใช้เหล่านั้น

Enum
UNSPECIFIED_SCOPE หากไม่ได้กำหนดขอบเขต จะมีค่าเริ่มต้นเป็นขอบเขตของเงื่อนไข USER หรือ SESSION ขึ้นอยู่กับว่ากลุ่มพยายามเลือกผู้ใช้หรือเซสชันหรือไม่
PRODUCT ขอบเขตผลิตภัณฑ์
HIT ขอบเขต Hit
SESSION ขอบเขตเซสชัน
USER ขอบเขตของผู้ใช้

ผู้ประกอบธุรกิจ

ตัวเลือกประเภทการเปรียบเทียบที่แตกต่างกัน

Enum
UNSPECIFIED_OPERATOR โอเปอเรเตอร์ที่ไม่ระบุจะถือเป็นโอเปอเรเตอร์ LESS_THAN
LESS_THAN ตรวจสอบว่าค่าเมตริกน้อยกว่าค่าเปรียบเทียบหรือไม่
GREATER_THAN ตรวจสอบว่าค่าเมตริกมากกว่าค่าเปรียบเทียบหรือไม่
EQUAL เท่ากับโอเปอเรเตอร์
BETWEEN สำหรับโอเปอเรเตอร์ระหว่างโอเปอเรเตอร์ ทั้งจำนวนต่ำสุดและสูงสุดจะไม่รวมอยู่ด้วย เราจะใช้ LT และ GT เพื่อเปรียบเทียบ

SequenceSegment

เงื่อนไขลำดับประกอบด้วยขั้นตอนอย่างน้อย 1 ขั้นตอน โดยแต่ละขั้นตอนจะได้รับการกำหนดโดยเงื่อนไขมิติข้อมูล/เมตริกอย่างน้อย 1 รายการ และสามารถใช้ร่วมกับโอเปอเรเตอร์ลำดับพิเศษได้หลายขั้นตอน

การแสดง JSON 
{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean
}
ช่อง
segmentSequenceSteps[]

object(SegmentSequenceStep)

รายการขั้นตอนในลำดับ

firstStepShouldMatchFirstHit

boolean

หากมีการตั้งค่า เงื่อนไขของขั้นตอนแรกต้องตรงกับ Hit แรกของผู้เข้าชม (ในช่วงวันที่)

SegmentSequenceStep

คำจำกัดความของลำดับกลุ่ม

การแสดง JSON 
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType)
}
ช่อง
orFiltersForSegment[]

object(OrFiltersForSegment)

ระบุลำดับด้วยรายการตัวกรองหรือที่จัดกลุ่มไว้ซึ่งรวมกับโอเปอเรเตอร์ AND

matchType

enum(MatchType)

ระบุว่าขั้นตอนก่อนหน้าจะเกิดขึ้นทันทีหรืออาจเป็นช่วงเวลาใดก็ได้ก่อนขั้นตอนถัดไป

MatchType

ประเภทการทำงานของคีย์เวิร์ดสำหรับลำดับ

Enum
UNSPECIFIED_MATCH_TYPE ประเภทการทำงานของคีย์เวิร์ดที่ไม่ระบุจะถือเป็นลำดับก่อนหน้า
PRECEDES โอเปอเรเตอร์ระบุว่าขั้นตอนก่อนหน้าอยู่ก่อนขั้นตอนถัดไป
IMMEDIATELY_PRECEDES โอเปอเรเตอร์ระบุว่าขั้นตอนก่อนหน้าอยู่ก่อนขั้นตอนถัดไปทันที

Pivot

Pivot จะอธิบายส่วน Pivot ในคำขอ Pivot ช่วยจัดเรียงข้อมูลในตารางสำหรับบางรายงาน โดยทำการ Pivot ข้อมูลของคุณในมิติข้อมูลรอง

การแสดง JSON 
{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number
}
ช่อง
dimensions[]

object(Dimension)

รายการมิติข้อมูลที่จะแสดงเป็นคอลัมน์ Pivot Pivot มีขนาดได้สูงสุด 4 ขนาด มิติข้อมูล Pivot เป็นส่วนหนึ่งของข้อจำกัดของจำนวนมิติข้อมูลทั้งหมดที่อนุญาตในคำขอ

dimensionFilterClauses[]

object(DimensionFilterClause)

DimensionFilterCsections จะรวมเข้าด้วยกันอย่างมีเหตุผลกับโอเปอเรเตอร์ AND นั่นคือ เฉพาะข้อมูลที่รวมอยู่ในพื้นที่ Pivot เหล่านี้ทั้งหมดเท่านั้นที่ส่งผลต่อค่าในภูมิภาค Pivot นี้ คุณสามารถใช้ตัวกรองมิติข้อมูลเพื่อจำกัดคอลัมน์ที่แสดงในภูมิภาค Pivot เช่น หากคุณมี ga:browser เป็นมิติข้อมูลที่ขอในภูมิภาค Pivot และคุณระบุตัวกรองคีย์ให้จำกัด ga:browser ไว้ที่ "IE" หรือ "Firefox" เท่านั้น ระบบจะแสดงเป็นคอลัมน์เฉพาะเบราว์เซอร์ 2 เบราว์เซอร์นี้

metrics[]

object(Metric)

เมตริก Pivot เมตริก Pivot เป็นส่วนหนึ่งของการจำกัดจำนวนเมตริกทั้งหมดที่อนุญาตในคำขอ

startGroup

number

หากมีการขอเมตริก k การตอบกลับจะมีคอลัมน์ k หลายคอลัมน์ที่ขึ้นอยู่กับข้อมูลในรายงาน เช่น หากทำการ Pivot ในมิติข้อมูล ga:browser คุณจะได้ k คอลัมน์สำหรับ "Firefox", k คอลัมน์สำหรับ "IE", k คอลัมน์สำหรับ "Chrome" เป็นต้น การจัดลำดับกลุ่มคอลัมน์จะกำหนดโดยลำดับจากมากไปน้อยของค่า "total" สำหรับค่า k แรก การเชื่อมโยงจะแบ่งโดยลำดับแบบพจนานุกรมของมิติข้อมูล Pivot แรก จากนั้นเรียงลำดับแบบพจนานุกรมของมิติข้อมูล Pivot ที่ 2 เป็นต้น เช่น หากผลรวมของค่าแรกของ Firefox, IE และ Chrome คือ 8, 2, 8 ตามลำดับ ลำดับของคอลัมน์จะเป็น Chrome, Firefox, IE

รายการต่อไปนี้ช่วยให้คุณเลือกกลุ่มของคอลัมน์ k ที่จะรวมไว้ในการตอบกลับ
maxGroupCount

number

ระบุจำนวนกลุ่มสูงสุดที่จะส่งคืน ค่าเริ่มต้นคือ 10 และค่าสูงสุดคือ 1,000

CohortGroup

กำหนดกลุ่มประชากรตามรุ่น เช่น

"cohortGroup": {
  "cohorts": [{
    "name": "cohort 1",
    "type": "FIRST_VISIT_DATE",
    "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
  },{
    "name": "cohort 2"
     "type": "FIRST_VISIT_DATE"
     "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
  }]
}
การแสดง JSON 
{
  "cohorts": [
    {
      object(Cohort)
    }
  ],
  "lifetimeValue": boolean
}
ช่อง
cohorts[]

object(Cohort)

คำจำกัดความของกลุ่มประชากรตามรุ่น

lifetimeValue

boolean

เปิดใช้มูลค่าตลอดอายุการใช้งาน (LTV) LTV จะวัดมูลค่าตลอดอายุการใช้งานสำหรับผู้ใช้ที่ได้รับผ่านแชแนลต่างๆ โปรดดูที่การวิเคราะห์ตามการได้มาและมูลค่าตลอดอายุการใช้งาน หากค่าของมูลค่าตลอดอายุการใช้งานเป็น "เท็จ" ให้ทำดังนี้

  • ค่าเมตริกจะคล้ายกับค่าในรายงานกลุ่มประชากรตามรุ่นของอินเทอร์เฟซเว็บ
  • ช่วงวันที่ของการกำหนดกลุ่มประชากรตามรุ่นต้องสอดคล้องกับสัปดาห์และเดือนตามปฏิทิน เช่น ขณะที่ส่งคำขอ ga:cohortNthWeek startDate ในคำจำกัดความกลุ่มประชากรตามรุ่นควรเป็นวันอาทิตย์ และ endDate ควรเป็นวันเสาร์ถัดไป และสำหรับ ga:cohortNthMonth วันที่ startDate ควรเป็นวันที่ 1 ของเดือน และ endDate ควรเป็นวันสุดท้ายของเดือน

เมื่อมูลค่าตลอดอายุการใช้งานเป็นจริง

  • ค่าเมตริกจะสอดคล้องกับค่าในรายงานค่า LifeTime ของอินเทอร์เฟซเว็บ
  • รายงานมูลค่าตลอดอายุการใช้งานแสดงให้เห็นมูลค่าของผู้ใช้ (รายได้) และการมีส่วนร่วม (การดูแอป เป้าหมายที่สำเร็จ เซสชัน และระยะเวลาเซสชัน) เพิ่มขึ้นในช่วง 90 วันหลังจากที่ผู้ใช้ได้ผู้ใช้ใหม่
  • ระบบจะคํานวณเมตริกเป็นค่าเฉลี่ยสะสมต่อผู้ใช้ต่อเวลาที่เพิ่มขึ้น
  • ช่วงวันที่ของคำจำกัดความของกลุ่มประชากรตามรุ่นไม่จำเป็นต้องสอดคล้องกับขอบเขตสัปดาห์และเดือนในปฏิทิน
  • viewId ต้องเป็นรหัสข้อมูลพร็อพเพอร์ตี้แอป

กลุ่มประชากรตามรุ่น

กำหนดกลุ่มประชากรตามรุ่น กลุ่มประชากรตามรุ่นคือกลุ่มผู้ใช้ที่มีลักษณะอย่างหนึ่งเหมือนกัน เช่น ผู้ใช้ทั้งหมดที่คุณได้มาในวันเดียวกันจะถือว่าเป็นกลุ่มประชากรตามรุ่นกลุ่มเดียวกัน

การแสดง JSON 
{
  "name": string,
  "type": enum(Type),
  "dateRange": {
    object(DateRange)
  }
}
ช่อง
name

string

ชื่อที่ไม่ซ้ำกันของกลุ่มประชากรตามรุ่น ระบบจะสร้างชื่อที่ไม่ได้กำหนดขึ้นโดยอัตโนมัติด้วยค่ากลุ่มประชากรตามรุ่น_[1234...]

type

enum(Type)

ประเภทกลุ่มประชากรตามรุ่น ประเภทที่รองรับในขณะนี้คือ FIRST_VISIT_DATE หากไม่ได้ระบุช่องนี้ กลุ่มประชากรตามรุ่นจะถือว่าเป็นกลุ่มประชากรตามรุ่นประเภท FIRST_VISIT_DATE

dateRange

object(DateRange)

ซึ่งใช้สำหรับกลุ่มประชากรตามรุ่น FIRST_VISIT_DATE กลุ่ม โดยกลุ่มประชากรตามรุ่นจะเลือกผู้ใช้ที่มีวันที่เข้าชมครั้งแรกอยู่ระหว่างวันที่เริ่มต้นกับวันที่สิ้นสุดที่กำหนดไว้ในช่วงวันที่ ช่วงวันที่ควรสอดคล้องกันสำหรับคำขอกลุ่มประชากรตามรุ่น หากคำขอมี ga:cohortNthDay คำขอควรมีความยาว 1 วันพอดี หาก ga:cohortNthWeek ควรสอดคล้องกับขอบเขตสัปดาห์ (เริ่มต้นที่วันอาทิตย์และสิ้นสุดวันเสาร์) และสำหรับ ga:cohortNthMonth ช่วงวันที่ควรสอดคล้องกับเดือน (เริ่มต้นที่แรกและสิ้นสุดในวันสุดท้ายของเดือน) สำหรับคำขอ LTV ไม่มีข้อจำกัดดังกล่าว คุณไม่จำเป็นต้องระบุช่วงวันที่สำหรับช่อง reportsRequest.dateRanges

ประเภท

ประเภทกลุ่มประชากรตามรุ่น

Enum
UNSPECIFIED_COHORT_TYPE หากไม่ระบุ ระบบจะถือว่าเป็น FIRST_VISIT_DATE
FIRST_VISIT_DATE กลุ่มประชากรตามรุ่นที่เลือกโดยอิงตามวันที่เข้าชมครั้งแรก

รายงาน

ข้อมูลตอบกลับที่เกี่ยวข้องกับคำขอ

การแสดง JSON 
{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string
}
ช่อง
columnHeader

object(ColumnHeader)

ส่วนหัวของคอลัมน์

data

object(ReportData)

ข้อมูลการตอบกลับ

nextPageToken

string

โทเค็นหน้าเพื่อเรียกหน้าถัดไปของผลลัพธ์ในรายการ

ColumnHeader

ส่วนหัวคอลัมน์

การแสดง JSON 
{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  }
}
ช่อง
dimensions[]

string

ชื่อมิติข้อมูลในคำตอบ

metricHeader

object(MetricHeader)

ส่วนหัวเมตริกสำหรับเมตริกในการตอบกลับ

MetricHeader

ส่วนหัวของเมตริก

การแสดง JSON 
{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ]
}
ช่อง
metricHeaderEntries[]

object(MetricHeaderEntry)

ส่วนหัวของเมตริกในคำตอบ

pivotHeaders[]

object(PivotHeader)

ส่วนหัวของ Pivot ในคำตอบ

MetricHeaderEntry

ส่วนหัวของเมตริก

การแสดง JSON 
{
  "name": string,
  "type": enum(MetricType)
}
ช่อง
name

string

ชื่อของส่วนหัว

type

enum(MetricType)

ประเภทของเมตริก เช่น INTEGER

PivotHeader

ส่วนหัวของแต่ละหัวข้อ Pivot ที่กำหนดไว้ในคำขอ

การแสดง JSON 
{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number
}
ช่อง
pivotHeaderEntries[]

object(PivotHeaderEntry)

ส่วนหัวของส่วน Pivot รายการเดียว

totalPivotGroupsCount

number

จำนวนกลุ่มทั้งหมดสำหรับ Pivot นี้

PivotHeaderEntry

ส่วนหัวของคอลัมน์เมตริกแต่ละคอลัมน์ที่เกี่ยวข้องกับเมตริกที่ขอในส่วน Pivot ของการตอบกลับ

การแสดง JSON 
{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  }
}
ช่อง
dimensionNames[]

string

ชื่อของมิติข้อมูลในการตอบกลับ Pivot

dimensionValues[]

string

ค่าสำหรับมิติข้อมูลใน Pivot

metric

object(MetricHeaderEntry)

ส่วนหัวของเมตริกสำหรับเมตริกใน Pivot

ReportData

ส่วนข้อมูลของรายงาน

การแสดง JSON 
{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
  "dataLastRefreshed": string
}
ช่อง
rows[]

object(ReportRow)

มี ReportRow หนึ่งรายการสำหรับชุดค่าผสมของมิติข้อมูลที่ไม่ซ้ำกันแต่ละชุด

totals[]

object(DateRangeValues)

ในช่วงวันที่ที่ขอแต่ละช่วง สำหรับชุดของแถวทั้งหมดที่ตรงกับคำค้นหา รูปแบบค่าที่ขอทั้งหมดจะได้รับค่ารวม ผลรวมสำหรับรูปแบบค่าจะคำนวณโดยการรวมเมตริกที่กล่าวถึงในรูปแบบค่าก่อน จากนั้นจึงประเมินรูปแบบค่าเป็นนิพจน์สเกลาร์ เช่น "ผลรวม" สำหรับ 3 / (ga:sessions + 2) ที่เราคำนวณ 3 / ((sum of all relevant ga:sessions) + 2) ระบบจะคำนวณผลรวมก่อนการใส่เลขหน้า

rowCount

number

จำนวนแถวที่ตรงกันทั้งหมดสำหรับการค้นหานี้

minimums[]

object(DateRangeValues)

ค่าต่ำสุดและสูงสุดที่เห็นในแถวที่ตรงกันทั้งหมด ค่าทั้งสองนี้จะว่างเปล่าเมื่อ hideValueRanges ในคำขอเป็นเท็จ หรือเมื่อ rowsCount เป็น 0

maximums[]

object(DateRangeValues)

ค่าต่ำสุดและสูงสุดที่เห็นในแถวที่ตรงกันทั้งหมด ค่าทั้งสองนี้จะว่างเปล่าเมื่อ hideValueRanges ในคำขอเป็นเท็จ หรือเมื่อ rowsCount เป็น 0

samplesReadCounts[]

string (int64 format)

หากผลลัพธ์เป็นแบบสุ่มตัวอย่าง จะแสดงเป็นจำนวนตัวอย่างทั้งหมดที่อ่าน โดย 1 รายการต่อหนึ่งช่วงวันที่ หากไม่ได้สุ่มตัวอย่างผลลัพธ์ ฟิลด์นี้จะไม่ถูกกำหนด ดูรายละเอียดได้จากคู่มือนักพัฒนาซอฟต์แวร์

samplingSpaceSizes[]

string (int64 format)

หากผลลัพธ์เป็นแบบสุ่มตัวอย่าง จะแสดงจํานวนตัวอย่างทั้งหมดที่แสดง 1 รายการต่อช่วงวันที่ หากไม่ได้สุ่มตัวอย่างผลลัพธ์ ฟิลด์นี้จะไม่ถูกกำหนด ดูรายละเอียดได้จากคู่มือนักพัฒนาซอฟต์แวร์

isDataGolden

boolean

ระบุว่าการตอบสนองต่อคำขอนี้เป็นทองหรือไม่ ข้อมูลจะมีมูลค่าทองเมื่อคำขอเดียวกันจะไม่สร้างผลลัพธ์ใหม่หากมีการถามในภายหลัง

dataLastRefreshed

string (Timestamp format)

ครั้งล่าสุดที่มีการรีเฟรชข้อมูลในรายงาน Hit ทั้งหมดที่ได้รับก่อนการประทับเวลานี้จะรวมอยู่ในการคำนวณรายงาน

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่แม่นยำเป็นหน่วยนาโนวินาที ตัวอย่าง: "2014-10-02T15:01:23.045123456Z"

ReportRow

แถวในรายงาน

การแสดง JSON 
{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ]
}
ช่อง
dimensions[]

string

รายการมิติข้อมูลที่ขอ

metrics[]

object(DateRangeValues)

รายการเมตริกสำหรับแต่ละช่วงวันที่ที่ขอ

DateRangeValues

ใช้เพื่อแสดงรายการของเมตริกสำหรับชุดค่าผสมช่วงวันที่ / มิติข้อมูลเดียว

การแสดง JSON 
{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ]
}
ช่อง
values[]

string

แต่ละค่าจะสอดคล้องกับเมตริกแต่ละรายการในคำขอ

pivotValueRegions[]

object(PivotValueRegion)

ค่าของแต่ละเขต Pivot

PivotValueRegion

ค่าเมตริกในภูมิภาค Pivot

การแสดง JSON 
{
  "values": [
    string
  ]
}
ช่อง
values[]

string

ค่าของเมตริกในภูมิภาค Pivot แต่ละเขต

ResourceQuotasRemaining

โทเค็นโควต้าทรัพยากรที่เหลืออยู่สำหรับพร็อพเพอร์ตี้หลังจากที่คำขอเสร็จสมบูรณ์

การแสดง JSON 
{
  "dailyQuotaTokensRemaining": number,
  "hourlyQuotaTokensRemaining": number
}
ช่อง
dailyQuotaTokensRemaining

number

โควต้าทรัพยากรรายวันที่เหลือ

hourlyQuotaTokensRemaining

number

โทเค็นโควต้าทรัพยากรรายชั่วโมงที่เหลือ

ลองใช้เลย