ลงชื่อเข้าใช้ด้วยเอกสารอ้างอิง Google JavaScript API

หน้าข้อมูลอ้างอิงนี้อธิบาย Sign-In JavaScript API คุณสามารถใช้ API นี้เพื่อแสดงข้อความแจ้งแบบแตะครั้งเดียวหรือปุ่มลงชื่อเข้าใช้ด้วย Google ในหน้าเว็บ

เมธอด: google.accounts.id.initialize

เมธอด google.accounts.id.initialize จะเริ่มต้นคลีเอนต์การลงชื่อเข้าใช้ด้วย Google ตามออบเจ็กต์การกําหนดค่า ดูตัวอย่างโค้ดของวิธีต่อไปนี้

google.accounts.id.initialize(IdConfiguration)

ตัวอย่างโค้ดต่อไปนี้ใช้เมธอด google.accounts.id.initialize กับฟังก์ชัน onload

<script>
  window.onload = function () {
    google.accounts.id.initialize({
      client_id: 'YOUR_GOOGLE_CLIENT_ID',
      callback: handleCredentialResponse
    });
    google.accounts.id.prompt();
  };
</script>

เมธอด google.accounts.id.initialize จะสร้างอินสแตนซ์ไคลเอ็นต์ "ลงชื่อเข้าใช้ด้วย Google" ที่โมดูลทั้งหมดในหน้าเว็บเดียวกันใช้โดยนัยได้

• คุณต้องเรียกใช้เมธอด google.accounts.id.initialize เพียงครั้งเดียวแม้ว่าคุณจะใช้หลายโมดูล (เช่น การแตะครั้งเดียว ปุ่มที่ปรับเปลี่ยนในแบบของคุณ การเพิกถอน ฯลฯ) ในหน้าเว็บเดียวกันก็ตาม
• หากคุณเรียกใช้เมธอด google.accounts.id.initialize หลายครั้ง ระบบจะจดจำและใช้เฉพาะการกําหนดค่าในการเรียกใช้ครั้งล่าสุด

คุณจะรีเซ็ตการกำหนดค่าทุกครั้งที่เรียกใช้เมธอด google.accounts.id.initialize และเมธอดต่อๆ ไปทั้งหมดในหน้าเว็บเดียวกันจะใช้การกำหนดค่าใหม่ทันที

ประเภทข้อมูล: IdConfiguration

ตารางต่อไปนี้แสดงช่องและคําอธิบายของIdConfigurationประเภทข้อมูล

client_id

ช่องนี้คือรหัสไคลเอ็นต์ของแอปพลิเคชัน ซึ่งอยู่ในคอนโซล Google Cloud ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

auto_select

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

Callback

ช่องนี้เป็นฟังก์ชัน JavaScript ที่จัดการโทเค็นรหัสที่ส่งคืนจากข้อความแจ้งของ One Tap หรือหน้าต่างป๊อปอัป ต้องระบุแอตทริบิวต์นี้หากใช้โหมด UX ของ Google popup One Tap หรือปุ่มลงชื่อเข้าใช้ด้วย Google โปรดดูข้อมูลเพิ่มเติมในตารางต่อไปนี้

login_uri

แอตทริบิวต์นี้เป็น URI ของปลายทางการเข้าสู่ระบบ

ค่าต้องตรงกับ URI การเปลี่ยนเส้นทางที่ได้รับอนุญาตรายการใดรายการหนึ่งสำหรับไคลเอ็นต์ OAuth 2.0 ที่คุณกําหนดค่าในคอนโซล Google Cloud และต้องเป็นไปตามกฎการตรวจสอบ URI การเปลี่ยนเส้นทาง

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

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

โปรดดูข้อมูลเพิ่มเติมในตารางต่อไปนี้

ปลายทางการเข้าสู่ระบบต้องจัดการคําขอ POST ที่มีคีย์ credential ที่มีค่าโทเค็นรหัสในส่วนเนื้อหา

ต่อไปนี้เป็นตัวอย่างคำขอไปยังปลายทางการเข้าสู่ระบบ

POST /login HTTP/1.1
Host: www.example.com
Content-Type: application/x-www-form-urlencoded

credential=ID_TOKEN

native_callback

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

cancel_on_tap_outside

ฟิลด์นี้จะกำหนดว่าจะยกเลิกคำขอการชำระเงินแบบไม่ต้องสัมผัสหรือไม่หากผู้ใช้คลิกนอกพรอมต์ ค่าเริ่มต้นคือ true คุณสามารถปิดใช้ได้โดยตั้งค่าเป็น false ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

prompt_parent_id

แอตทริบิวต์นี้จะตั้งค่ารหัส DOM ขององค์ประกอบคอนเทนเนอร์ หากไม่ได้ตั้งค่าไว้ ระบบจะแสดงข้อความแจ้ง "แตะครั้งเดียว" ที่มุมขวาบนของหน้าต่าง โปรดดูข้อมูลเพิ่มเติมในตารางต่อไปนี้

ค่าที่ได้จากการสุ่ม

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

ความยาวของ Nonce จะจำกัดตามขนาด JWT สูงสุดที่สภาพแวดล้อมของคุณรองรับ และข้อจำกัดขนาด HTTP ของเบราว์เซอร์และเซิร์ฟเวอร์แต่ละรายการ

บริบท

ช่องนี้จะเปลี่ยนข้อความของชื่อและข้อความในพรอมต์การแตะครั้งเดียว ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

ตารางต่อไปนี้แสดงบริบททั้งหมดที่ใช้ได้และคําอธิบาย

state_cookie_domain

หากต้องการแสดง One Tap ในโดเมนหลักและโดเมนย่อย ให้ส่งโดเมนหลักไปยังช่องนี้เพื่อให้ระบบใช้คุกกี้สถานะที่ใช้ร่วมกันรายการเดียว ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

ux_mode

ใช้ช่องนี้เพื่อตั้งค่าขั้นตอน UX ที่ใช้โดยปุ่มลงชื่อเข้าใช้ด้วย Google ค่าเริ่มต้นคือ popup แอตทริบิวต์นี้ไม่มีผลต่อ UX ของ OneTap ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

ตารางต่อไปนี้แสดงโหมด UX ที่มีและคำอธิบาย

allowed_parent_origin

ต้นทางที่ได้รับอนุญาตให้ฝัง iframe ระดับกลาง One Tap จะทำงานในโหมด iframe ระดับกลาง หากมีช่องนี้อยู่ ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

ตารางต่อไปนี้แสดงประเภทค่าที่รองรับและคําอธิบาย

นอกจากนี้ยังรองรับการใช้ไวลด์การ์ดด้วย เช่น "https://*.example.com" จะตรงกับ example.com และโดเมนย่อยของ example.com ทุกระดับ (เช่น news.example.com, login.news.example.com) สิ่งที่ควรทราบเมื่อใช้ไวลด์การ์ด

• สตริงรูปแบบต้องประกอบด้วยไวลด์การ์ดและโดเมนระดับบนสุดเท่านั้น เช่น https://.com และ https://.co.uk ไม่ถูกต้อง ดังที่ระบุไว้ข้างต้น "https://.example.com" จะตรงกับ example.com และโดเมนย่อยของ example.com นอกจากนี้ คุณยังใช้อาร์เรย์เพื่อแสดงโดเมน 2 โดเมนที่แตกต่างกันได้ด้วย ตัวอย่างเช่น ["https://example1.com", "https://.example2.com"] จะตรงกับโดเมน example1.com, example2.com และโดเมนย่อยของ example2.com
• โดเมนไวลด์การ์ดต้องขึ้นต้นด้วยชุดรูปแบบ https:// ที่ปลอดภัย ระบบจึงจะถือว่า "*.example.com" ไม่ถูกต้อง

หากค่าของช่อง allowed_parent_origin ไม่ถูกต้อง โหมดเริ่มต้นของ One Tap สำหรับโหมด iframe ระดับกลางจะล้มเหลวและหยุดทำงาน

intermediate_iframe_close_callback

ลบล้างลักษณะการทำงานเริ่มต้นของ iframe ระดับกลางเมื่อผู้ใช้ปิด One Tap ด้วยตนเองโดยการแตะปุ่ม "X" ใน UI ของ One Tap การทำงานเริ่มต้นคือการนำ iframe ระดับกลางออกจาก DOM ทันที

ช่อง intermediate_iframe_close_callback จะมีผลเฉพาะในโหมด iframe ระดับกลางเท่านั้น และจะมีผลกับ iframe ระดับกลางเท่านั้น ไม่ใช่ iframe ของ One Tap ระบบจะนำ UI การแตะครั้งเดียวออกก่อนที่จะเรียกใช้การติดต่อกลับ

itp_support

ช่องนี้จะกำหนดว่าควรเปิดใช้ UX การแตะครั้งเดียวที่อัปเกรดแล้วในเบราว์เซอร์ที่รองรับ Intelligent Tracking Prevention (ITP) หรือไม่ ค่าเริ่มต้นคือ false ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

login_hint

หากแอปพลิเคชันทราบล่วงหน้าว่าผู้ใช้รายใดควรลงชื่อเข้าใช้ แอปพลิเคชันจะระบุคำแนะนำในการเข้าสู่ระบบให้ Google ได้ เมื่อดำเนินการเสร็จสิ้น ระบบจะข้ามการเลือกบัญชี ค่าที่ยอมรับ ได้แก่ อีเมลหรือค่าในช่อง sub โทเค็นรหัส

ดูข้อมูลเพิ่มเติมได้ที่ช่อง login_hint ในเอกสารประกอบของ OpenID Connect

HD

เมื่อผู้ใช้มีหลายบัญชีและควรลงชื่อเข้าใช้ด้วยบัญชี Workspace เท่านั้น ให้ใช้แอตทริบิวต์นี้เพื่อระบุคำแนะนำชื่อโดเมนแก่ Google เมื่อดำเนินการเสร็จสิ้นแล้ว บัญชีผู้ใช้ที่แสดงระหว่างการเลือกบัญชีจะจำกัดอยู่ในโดเมนที่ระบุ ค่าไวลด์การ์ด: * เสนอเฉพาะบัญชี Workspace ให้แก่ผู้ใช้และยกเว้นบัญชีผู้ใช้ทั่วไป (user@gmail.com) ในระหว่างการเลือกบัญชี

ดูข้อมูลเพิ่มเติมได้ที่ช่อง hd ในเอกสารประกอบของ OpenID Connect

use_fedcm_for_prompt

อนุญาตให้เบราว์เซอร์ควบคุมข้อความแจ้งให้ผู้ใช้ลงชื่อเข้าใช้และสื่อกลางขั้นตอนการลงชื่อเข้าใช้ระหว่างเว็บไซต์กับ Google ค่าเริ่มต้นคือ False โปรดดูข้อมูลเพิ่มเติมในหน้าย้ายข้อมูลไปยัง FedCM

enable_redirect_uri_validation

เปิดใช้โฟลว์การเปลี่ยนเส้นทางของปุ่มที่เป็นไปตามกฎการตรวจสอบ URI การเปลี่ยนเส้นทาง

วิธีการ: google.accounts.id.prompt

เมธอด google.accounts.id.prompt จะแสดงข้อความแจ้งของ One Tap หรือเครื่องมือจัดการข้อมูลเข้าสู่ระบบแบบเนทีฟของเบราว์เซอร์หลังจากที่เรียกใช้เมธอด initialize() แล้ว ดูตัวอย่างโค้ดต่อไปนี้ของเมธอด

 google.accounts.id.prompt(/**
 @type{(function(!PromptMomentNotification):void)=} */ momentListener)

โดยทั่วไปแล้ว ระบบจะเรียกใช้เมธอด prompt() เมื่อโหลดหน้าเว็บ UI ของข้อความแจ้งแบบแตะครั้งเดียวอาจไม่แสดงเนื่องจากสถานะเซสชันและการตั้งค่าผู้ใช้ในฝั่ง Google หากต้องการรับการแจ้งเตือนเกี่ยวกับสถานะ UI ในช่วงเวลาต่างๆ ให้ส่งผ่านฟังก์ชันเพื่อรับการแจ้งเตือนสถานะ UI

การแจ้งเตือนจะแสดงในลักษณะต่อไปนี้

• แสดงช่วงเวลา: จะเกิดขึ้นหลังจากเรียกเมธอด prompt() การแจ้งเตือนมีค่าบูลีนเพื่อระบุว่า UI แสดงอยู่หรือไม่

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

  ในกรณีเหล่านี้ เราขอแนะนำให้คุณเปลี่ยนไปใช้ผู้ให้บริการข้อมูลประจำตัวรายถัดไป หากมี

• ช่วงเวลาที่ปิด: เกิดขึ้นเมื่อ Google ดึงข้อมูลเข้าสู่ระบบได้สําเร็จหรือผู้ใช้ต้องการหยุดขั้นตอนการดึงข้อมูลเข้าสู่ระบบ ตัวอย่างเช่น เมื่อผู้ใช้เริ่มป้อนชื่อผู้ใช้และรหัสผ่านในกล่องโต้ตอบการเข้าสู่ระบบ คุณสามารถเรียกใช้เมธอด google.accounts.id.cancel() เพื่อปิดข้อความแจ้งแบบแตะครั้งเดียวและทริกเกอร์ช่วงเวลาที่ปิด

ตัวอย่างโค้ดต่อไปนี้ใช้ช่วงเวลาที่ข้าม

<script>
  window.onload = function () {
    google.accounts.id.initialize(...);
    google.accounts.id.prompt((notification) => {
      if (notification.isNotDisplayed() || notification.isSkippedMoment()) {
        // continue with another identity provider.
      }
    });
  };
</script>

ประเภทข้อมูล: PromptMomentNotification

ตารางต่อไปนี้แสดงเมธอดและคําอธิบายของประเภทข้อมูล PromptMomentNotification

ประเภทข้อมูล: CredentialResponse

เมื่อเรียกใช้ฟังก์ชัน callback ระบบจะส่งออบเจ็กต์ CredentialResponse เป็นพารามิเตอร์ ตารางต่อไปนี้แสดงรายการช่องที่อยู่ในออบเจ็กต์การตอบกลับข้อมูลเข้าสู่ระบบ

ข้อมูล เข้าสู่ระบบ

ช่องนี้เป็นโทเค็นระบุตัวตนในรูปแบบสตริง JSON Web Token (JWT) ที่เข้ารหัสฐาน 64

เมื่อถอดรหัสแล้ว JWT จะมีลักษณะดังตัวอย่างต่อไปนี้

header
{
  "alg": "RS256",
  "kid": "f05415b13acb9590f70df862765c655f5a7a019e", // JWT signature
  "typ": "JWT"
}
payload
{
  "iss": "https://accounts.google.com", // The JWT's issuer
  "nbf":  161803398874,
  "aud": "314159265-pi.apps.googleusercontent.com", // Your server's client ID
  "sub": "3141592653589793238", // The unique ID of the user's Google Account
  "hd": "gmail.com", // If present, the host domain of the user's GSuite email address
  "email": "elisa.g.beckett@gmail.com", // The user's email address
  "email_verified": true, // true, if Google has verified the email address
  "azp": "314159265-pi.apps.googleusercontent.com",
  "name": "Elisa Beckett",
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/e2718281828459045235360uler",
  "given_name": "Elisa",
  "family_name": "Beckett",
  "iat": 1596474000, // Unix timestamp of the assertion's creation time
  "exp": 1596477600, // Unix timestamp of the assertion's expiration time
  "jti": "abc161803398874def"
}

ช่อง sub เป็นตัวระบุที่ไม่ซ้ำกันทั่วโลกสำหรับบัญชี Google ใช้ช่อง sub เป็นตัวระบุผู้ใช้เท่านั้น เนื่องจากเป็นค่าที่ไม่ซ้ำกันสำหรับบัญชี Google ทั้งหมดและจะไม่นำกลับมาใช้ซ้ำ อย่าใช้อีเมลเป็นตัวระบุเนื่องจากบัญชี Google อาจมีอีเมลหลายรายการในช่วงเวลาต่างๆ

การใช้ฟิลด์ email, email_verified และ hd ช่วยให้คุณระบุได้ว่า Google โฮสต์และเป็นผู้กำหนดสิทธิ์สำหรับอีเมลหรือไม่ ในกรณีที่ Google ให้สิทธิ์ เราจะยืนยันว่าผู้ใช้เป็นเจ้าของบัญชีที่ถูกต้อง

กรณีที่ Google เป็นผู้ให้ข้อมูล

• email มีนามสกุล @gmail.com แสดงว่าเป็นบัญชี Gmail
• email_verified เป็นจริงและมีการตั้งค่า hd แสดงว่าเป็นบัญชี Google Workspace

ผู้ใช้สามารถลงทะเบียนบัญชี Google ได้โดยไม่ต้องใช้ Gmail หรือ Google Workspace เมื่อ email ไม่มีส่วนต่อท้าย @gmail.com และไม่มี hd แสดงว่า Google ไม่มีสิทธิ์ในการตรวจสอบ และขอแนะนำให้ใช้รหัสผ่านหรือวิธีการยืนยันตัวตนอื่นๆ เพื่อยืนยันตัวตนผู้ใช้ email_verfied อาจเป็นจริงได้ในขณะที่ Google ยืนยันผู้ใช้ในตอนแรกเมื่อสร้างบัญชี Google อย่างไรก็ตาม การเป็นเจ้าของบัญชีอีเมลของบุคคลที่สามอาจมีการเปลี่ยนแปลงหลังจากนั้น

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

select_by

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

• ผู้ใช้กดปุ่ม One Tap หรือ "ลงชื่อเข้าใช้ด้วย Google" หรือใช้กระบวนการลงชื่อเข้าใช้อัตโนมัติแบบไร้สัมผัส

• พบเซสชันที่มีอยู่ หรือผู้ใช้เลือกและลงชื่อเข้าใช้บัญชี Google เพื่อสร้างเซสชันใหม่

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

  • กดปุ่ม "ยืนยัน" เพื่อให้ความยินยอมในการแชร์ข้อมูลเข้าสู่ระบบ หรือ
  • เคยให้ความยินยอมและใช้ "เลือกบัญชี" เพื่อเลือกบัญชี Google

ค่าของช่องนี้จะตั้งค่าเป็นประเภทใดประเภทหนึ่งต่อไปนี้

รัฐ

ช่องนี้จะกำหนดเฉพาะเมื่อผู้ใช้คลิกปุ่มลงชื่อเข้าใช้ด้วย Google เพื่อลงชื่อเข้าใช้ และระบุแอตทริบิวต์ state ของปุ่มที่คลิก ค่าของช่องนี้คือค่าเดียวกับที่คุณระบุไว้ในแอตทริบิวต์ state ของปุ่ม

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

วิธีการ: google.accounts.id.renderButton

เมธอด google.accounts.id.renderButton จะแสดงปุ่ม "ลงชื่อเข้าใช้ด้วย Google" ในหน้าเว็บ

ดูตัวอย่างโค้ดของเมธอดต่อไปนี้

google.accounts.id.renderButton(
      /** @type{!HTMLElement} */ parent,
      /** @type{!GsiButtonConfiguration} */ options
    )

ประเภทข้อมูล: GsiButtonConfiguration

ตารางต่อไปนี้แสดงช่องและคําอธิบายของประเภทข้อมูล GsiButtonConfiguration

ประเภทแอตทริบิวต์

ส่วนต่อไปนี้มีรายละเอียดเกี่ยวกับประเภทของแอตทริบิวต์แต่ละรายการและตัวอย่าง

ประเภท

ประเภทปุ่ม ค่าเริ่มต้นคือ standard

ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

ตารางต่อไปนี้แสดงประเภทปุ่มที่ใช้ได้และคำอธิบาย

ประเภท
standard
icon

ธีม [theme]

ธีมปุ่ม ค่าเริ่มต้นคือ outline โปรดดูข้อมูลเพิ่มเติมในตารางต่อไปนี้

ตารางต่อไปนี้แสดงธีมที่มีและคำอธิบายธีม

ธีม
outline
filled_blue
filled_black

ขนาด

ขนาดปุ่ม ค่าเริ่มต้นคือ large ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

ตารางต่อไปนี้แสดงขนาดปุ่มที่ใช้ได้และคําอธิบาย

ขนาด
large
medium
small

ข้อความ

ข้อความบนปุ่ม ค่าเริ่มต้นคือ signin_with ข้อความของปุ่มไอคอนที่มีแอตทริบิวต์ text ต่างกันไม่มีความแตกต่างทางภาพ ยกเว้นในกรณีที่อ่านข้อความเพื่อความสามารถในการเข้าถึงหน้าจอเท่านั้น

โปรดดูข้อมูลเพิ่มเติมในตารางต่อไปนี้

ตารางต่อไปนี้แสดงข้อความทั้งหมดของปุ่มที่ใช้ได้และคำอธิบาย

ข้อความ
signin_with
signup_with
continue_with
signin

รูปร่าง

รูปร่างของปุ่ม ค่าเริ่มต้นคือ rectangular ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

ตารางต่อไปนี้แสดงรูปร่างของปุ่มที่ใช้ได้และคำอธิบาย

รูปร่าง
rectangular
pill
circle
square

logo_alignment

การจัดแนวโลโก้ Google ค่าเริ่มต้นคือ left แอตทริบิวต์นี้มีผลกับปุ่มประเภท standard เท่านั้น ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

ตารางต่อไปนี้แสดงการจัดแนวที่ใช้ได้และคำอธิบาย

logo_alignment
left
center

ความกว้าง

ความกว้างขั้นต่ำของปุ่มในหน่วยพิกเซล ความกว้างสูงสุดคือ 400 พิกเซล

ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

ภาษา

ไม่บังคับ แสดงข้อความปุ่มโดยใช้ภาษาที่ระบุ มิเช่นนั้นจะใช้การตั้งค่าบัญชี Google หรือเบราว์เซอร์ของผู้ใช้โดยค่าเริ่มต้น เพิ่มพารามิเตอร์ hl และโค้ดภาษาลงในคําสั่ง src เมื่อโหลดไลบรารี เช่น gsi/client?hl=<iso-639-code>

หากไม่ได้ตั้งค่าไว้ ระบบจะใช้ภาษาเริ่มต้นของเบราว์เซอร์หรือค่ากําหนดของผู้ใช้เซสชัน Google ผู้ใช้แต่ละรายจึงอาจเห็นปุ่มที่แปลแล้วเวอร์ชันต่างๆ และอาจมีขนาดต่างกัน

ดูข้อมูลเพิ่มเติมได้ในตารางต่อไปนี้

click_listener

คุณสามารถกําหนดฟังก์ชัน JavaScript ให้เรียกใช้เมื่อมีการคลิกปุ่มลงชื่อเข้าใช้ด้วย Google โดยใช้แอตทริบิวต์ click_listener

  google.accounts.id.renderButton(document.getElementById("signinDiv"), {
      theme: 'outline',
      size: 'large',
      click_listener: onClickHandler
    });

  
  function onClickHandler(){
    console.log("Sign in with Google button clicked...")
  }
  

ในตัวอย่างนี้ ระบบจะบันทึกข้อความ คลิกปุ่มลงชื่อเข้าใช้ด้วย Google... ลงในคอนโซลเมื่อมีการคลิกปุ่มลงชื่อเข้าใช้ด้วย Google

รัฐ

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

โปรดดูข้อมูลเพิ่มเติมในตารางต่อไปนี้

ประเภทข้อมูล: ข้อมูลเข้าสู่ระบบ

เมื่อเรียกใช้ฟังก์ชัน native_callback ระบบจะส่งออบเจ็กต์ Credential เป็นพารามิเตอร์ ตารางต่อไปนี้แสดงช่องที่มีอยู่ในออบเจ็กต์

เมธอด: google.accounts.id.disableAutoSelect

เมื่อผู้ใช้ออกจากระบบเว็บไซต์ คุณจะต้องเรียกใช้เมธอด google.accounts.id.disableAutoSelect เพื่อบันทึกสถานะในคุกกี้ วิธีนี้ช่วยป้องกันไม่ให้ UX วนซ้ำ ดูข้อมูลโค้ดต่อไปนี้ของเมธอด

google.accounts.id.disableAutoSelect()

ตัวอย่างโค้ดต่อไปนี้ใช้google.accounts.id.disableAutoSelect เมธอดกับฟังก์ชัน onSignout()

<script>
  function onSignout() {
    google.accounts.id.disableAutoSelect();
  }
</script>

เมธอด: google.accounts.id.storeCredential

เมธอดนี้คือ Wrapper สำหรับเมธอด store() ของ API เครื่องมือจัดการข้อมูลเข้าสู่ระบบแบบเนทีฟของเบราว์เซอร์ จึงใช้ได้เฉพาะกับการจัดเก็บข้อมูลเข้าสู่ระบบที่เป็นรหัสผ่านเท่านั้น ดูตัวอย่างโค้ดของเมธอดต่อไปนี้

google.accounts.id.storeCredential(Credential, callback)

ตัวอย่างโค้ดต่อไปนี้จะใช้เมธอด google.accounts.id.storeCredential กับฟังก์ชัน onSignIn()

<script>
  function onSignIn() {
    let cred = {id: '...', password: '...'};
    google.accounts.id.storeCredential(cred);
  }
</script>

เมธอด: google.accounts.id.cancel

คุณสามารถยกเลิกขั้นตอนการแตะครั้งเดียวได้หากนำข้อความแจ้งออกจาก DOM ฝ่ายที่เกี่ยวข้อง ระบบจะไม่สนใจการดำเนินการยกเลิกหากเลือกข้อมูลเข้าสู่ระบบไว้แล้ว ดูตัวอย่างโค้ดของเมธอดต่อไปนี้

google.accounts.id.cancel()

ตัวอย่างโค้ดต่อไปนี้ใช้เมธอด google.accounts.id.cancel() กับฟังก์ชัน onNextButtonClicked()

<script>
  function onNextButtonClicked() {
    google.accounts.id.cancel();
    showPasswordPage();
  }
</script>

การเรียกกลับการโหลดคลัง: onGoogleLibraryLoad

คุณลงทะเบียนการติดต่อกลับของ onGoogleLibraryLoad ได้ และจะได้รับการแจ้งเตือนหลังจากโหลดไลบรารี JavaScript ของฟีเจอร์ลงชื่อเข้าใช้ด้วย Google แล้ว

window.onGoogleLibraryLoad = () => {
    ...
};

Callback นี้เป็นเพียงทางลัดสำหรับ Callback window.onload ไม่มีความแตกต่างในลักษณะการทํางาน

ตัวอย่างโค้ดต่อไปนี้ใช้ onGoogleLibraryLoad callback

<script>
  window.onGoogleLibraryLoad = () => {
   google.accounts.id.initialize({
     ...
   });
   google.accounts.id.prompt();
  };
</script>

วิธีการ: google.accounts.id.revoke

เมธอด google.accounts.id.revoke จะเพิกถอนการให้สิทธิ์ OAuth ที่ใช้เพื่อแชร์โทเค็นรหัสผู้ใช้สำหรับผู้ใช้ที่ระบุ ดูข้อมูลโค้ดต่อไปนี้ของเมธอด javascript google.accounts.id.revoke(login_hint, callback)

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีใช้เมธอด revoke ที่มีรหัส

  google.accounts.id.revoke('1618033988749895', done => {
    console.log(done.error);
  });

ประเภทข้อมูล: RevocationResponse

เมื่อเรียกใช้ฟังก์ชัน callback ระบบจะส่งออบเจ็กต์ RevocationResponse เป็นพารามิเตอร์ ตารางต่อไปนี้แสดงรายการช่องที่อยู่ในออบเจ็กต์การตอบกลับการเพิกถอน

สำเร็จ

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

ข้อผิดพลาด

ช่องนี้เป็นค่าสตริงและมีข้อความแสดงข้อผิดพลาดโดยละเอียดหากการเรียกใช้เมธอดเพิกถอนไม่สำเร็จ ช่องนี้จะไม่มีการกําหนดหากสําเร็จ