Google Sign-In for the Assistant ساده ترین و آسان ترین تجربه کاربری را برای کاربران و توسعه دهندگان برای پیوند دادن حساب و ایجاد حساب فراهم می کند. Action شما می‌تواند درخواست دسترسی به نمایه Google کاربر شما را در طول مکالمه کند، از جمله نام کاربر، آدرس ایمیل، و تصویر نمایه.
از اطلاعات نمایه می توان برای ایجاد یک تجربه کاربری شخصی شده در Action خود استفاده کرد. اگر برنامه‌هایی در پلتفرم‌های دیگر دارید و از Google Sign-In استفاده می‌کنند، می‌توانید حساب کاربری موجود را پیدا کرده و به آن پیوند دهید، یک حساب جدید ایجاد کنید و یک کانال ارتباطی مستقیم با کاربر ایجاد کنید.
برای انجام پیوند دادن حساب با Google Sign-In، از کاربر می‌خواهید که رضایت خود را برای دسترسی به نمایه Google خود اعلام کند. سپس از اطلاعات نمایه آنها، به عنوان مثال آدرس ایمیل آنها، برای شناسایی کاربر در سیستم خود استفاده می کنید.
پیوند حساب Google Sign-In را پیاده سازی کنید
برای افزودن پیوند حساب Google Sign-In به Action خود، مراحل زیر را دنبال کنید.
پروژه را پیکربندی کنید
برای پیکربندی پروژه خود برای استفاده از پیوند حساب Google Sign-In، این مراحل را دنبال کنید:
- Actions Console را باز کنید و یک پروژه را انتخاب کنید.
- روی تب Develop کلیک کنید و Account linking را انتخاب کنید.
- سوئیچ کنار Account linking را فعال کنید.
- در بخش ایجاد حساب ، بله را انتخاب کنید.
در نوع پیوند ، Google Sign In را انتخاب کنید.
اطلاعات مشتری را باز کنید و به ارزش شناسه مشتری صادر شده توسط Google برای Actions خود توجه داشته باشید.
روی ذخیره کلیک کنید.
جریان احراز هویت را شروع کنید
از هدف کمکی ورود به حساب کاربری برای شروع جریان احراز هویت استفاده کنید.
پس از اینکه کاربر اقدام شما را برای دسترسی به نمایه Google خود مجاز کرد، یک نشانه Google ID دریافت خواهید کرد که حاوی اطلاعات نمایه Google کاربر در هر درخواست بعدی برای اقدام شما است.
برای دسترسی به اطلاعات پروفایل کاربر، ابتدا باید توکن را با انجام مراحل زیر تایید و رمزگشایی کنید:
- از یک کتابخانه رمزگشایی JWT برای زبان خود برای رمزگشایی رمز استفاده کنید و از کلیدهای عمومی Google (در قالب JWK یا PEM موجود است) برای تأیید امضای رمز استفاده کنید.
- بررسی کنید که صادرکننده نشانه (فیلد
issدر رمز رمزگشایی شده) https://accounts.google.com باشد و مخاطب (فیلدaudدر نشانه رمزگشایی شده) مقدار Client ID صادر شده توسط Google برای Actions شما باشد. در Actions on Google کنسول به پروژه شما اختصاص داده شده است.
نمونه زیر نمونه ای از رمزگشایی شده است:
{
"sub": 1234567890, // The unique ID of the user's Google Account
"iss": "https://accounts.google.com", // The token's issuer
"aud": "123-abc.apps.googleusercontent.com", // Client ID assigned to your Actions project
"iat": 233366400, // Unix timestamp of the token's creation time
"exp": 233370000, // Unix timestamp of the token's expiration time
"name": "Jan Jansen",
"given_name": "Jan",
"family_name": "Jansen",
"email": "jan@gmail.com", // If present, the user's email address
"locale": "en_US"
}اگر از کتابخانه سرویس گیرنده Actions on Google برای Node.js یا کتابخانه سرویس گیرنده جاوا استفاده می‌کنید، این کار از اعتبارسنجی و رمزگشایی رمز برای شما مراقبت می‌کند و به شما امکان دسترسی به محتوای نمایه را می‌دهد، همانطور که در قطعه کد زیر نشان داده شده است. توجه داشته باشید که JSON زیر به ترتیب درخواست webhook را برای Dialogflow و Actions SDK توضیح می‌دهد.
قطعه‌های زیر از Dialogflow برای ورود به سیستم استفاده می‌کنند:
const {dialogflow, SignIn} = require('actions-on-google');
const app = dialogflow({
// REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('Start Signin', (conv) => {
conv.ask(new SignIn('To get your account details'));
});
// Create a Dialogflow intent with the `actions_intent_SIGN_IN` event.
app.intent('Get Signin', (conv, params, signin) => {
if (signin.status === 'OK') {
const payload = conv.user.profile.payload;
conv.ask(`I got your account details, ${payload.name}. What do you want to do next?`);
} else {
conv.ask(`I won't be able to save your data, but what do you want to do next?`);
}
});
private String clientId = "<your_client_id>";
@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
ResponseBuilder rb = getResponseBuilder(request);
return rb.add(new SignIn().setContext("To get your account details")).build();
}
@ForIntent("actions.intent.SIGN_IN")
public ActionResponse getSignInStatus(ActionRequest request) {
ResponseBuilder responseBuilder = getResponseBuilder(request);
if (request.isSignInGranted()) {
GoogleIdToken.Payload profile = getUserProfile(request.getUser().getIdToken());
responseBuilder.add(
"I got your account details, "
+ profile.get("given_name")
+ ". What do you want to do next?");
} else {
responseBuilder.add("I won't be able to save your data, but what do you want to do next?");
}
return responseBuilder.build();
}
private GoogleIdToken.Payload getUserProfile(String idToken) {
GoogleIdToken.Payload profile = null;
try {
profile = decodeIdToken(idToken);
} catch (Exception e) {
LOGGER.error("error decoding idtoken");
LOGGER.error(e.toString());
}
return profile;
}
private GoogleIdToken.Payload decodeIdToken(String idTokenString)
throws GeneralSecurityException, IOException {
HttpTransport transport = GoogleNetHttpTransport.newTrustedTransport();
JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();
GoogleIdTokenVerifier verifier =
new GoogleIdTokenVerifier.Builder(transport, jsonFactory)
// Specify the CLIENT_ID of the app that accesses the backend:
.setAudience(Collections.singletonList(clientId))
.build();
GoogleIdToken idToken = verifier.verify(idTokenString);
return idToken.getPayload();
}
{
"responseId": "",
"queryResult": {
"queryText": "",
"action": "",
"parameters": {},
"allRequiredParamsPresent": true,
"fulfillmentText": "",
"fulfillmentMessages": [],
"outputContexts": [],
"intent": {
"name": "Get Signin",
"displayName": "Get Signin"
},
"intentDetectionConfidence": 1,
"diagnosticInfo": {},
"languageCode": ""
},
"originalDetectIntentRequest": {
"source": "google",
"version": "2",
"payload": {
"isInSandbox": true,
"surface": {
"capabilities": [
{
"name": "actions.capability.SCREEN_OUTPUT"
},
{
"name": "actions.capability.AUDIO_OUTPUT"
},
{
"name": "actions.capability.MEDIA_RESPONSE_AUDIO"
},
{
"name": "actions.capability.WEB_BROWSER"
}
]
},
"inputs": [
{
"rawInputs": [],
"intent": "",
"arguments": [
{
"name": "SIGN_IN",
"extension": {
"@type": "type.googleapis.com/google.actions.v2.SignInValue",
"status": "OK"
}
}
]
}
],
"user": {
"idToken": "peJaCGci..."
},
"conversation": {},
"availableSurfaces": [
{
"capabilities": [
{
"name": "actions.capability.SCREEN_OUTPUT"
},
{
"name": "actions.capability.AUDIO_OUTPUT"
},
{
"name": "actions.capability.MEDIA_RESPONSE_AUDIO"
},
{
"name": "actions.capability.WEB_BROWSER"
}
]
}
]
}
},
"session": ""
}قطعه‌های زیر از Actions SDK برای ورود به سیستم استفاده می‌کنند:
const {actionssdk, SignIn} = require('actions-on-google');
const app = actionssdk({
// REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('actions.intent.TEXT', (conv) => {
conv.ask(new SignIn('To get your account details'));
});
// Create an Actions SDK intent with the `actions_intent_SIGN_IN` event.
app.intent('actions.intent.SIGN_IN', (conv, params, signin) => {
if (signin.status === 'OK') {
const payload = conv.user.profile.payload;
conv.ask(`I got your account details, ${payload.name}. What do you want to do next?`);
} else {
conv.ask(`I won't be able to save your data, but what do you want to do next?`);
}
});
private String clientId = "<your_client_id>";
@ForIntent("actions.intent.TEXT")
public ActionResponse text(ActionRequest request) {
ResponseBuilder rb = getResponseBuilder(request);
return rb.add(new SignIn().setContext("To get your account details")).build();
}
@ForIntent("actions.intent.SIGN_IN")
public ActionResponse getSignInStatus(ActionRequest request) {
ResponseBuilder responseBuilder = getResponseBuilder(request);
if (request.isSignInGranted()) {
GoogleIdToken.Payload profile = getUserProfile(request.getUser().getIdToken());
responseBuilder.add(
"I got your account details, "
+ profile.get("given_name")
+ ". What do you want to do next?");
} else {
responseBuilder.add("I won't be able to save your data, but what do you want to do next?");
}
return responseBuilder.build();
}
private GoogleIdToken.Payload getUserProfile(String idToken) {
GoogleIdToken.Payload profile = null;
try {
profile = decodeIdToken(idToken);
} catch (Exception e) {
LOGGER.error("error decoding idtoken");
LOGGER.error(e.toString());
}
return profile;
}
private GoogleIdToken.Payload decodeIdToken(String idTokenString)
throws GeneralSecurityException, IOException {
HttpTransport transport = GoogleNetHttpTransport.newTrustedTransport();
JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();
GoogleIdTokenVerifier verifier =
new GoogleIdTokenVerifier.Builder(transport, jsonFactory)
// Specify the CLIENT_ID of the app that accesses the backend:
.setAudience(Collections.singletonList(this.clientId))
.build();
GoogleIdToken idToken = verifier.verify(idTokenString);
return idToken.getPayload();
}
{
"user": {
"idToken": "peJaCGci..."
},
"device": {},
"surface": {
"capabilities": [
{
"name": "actions.capability.SCREEN_OUTPUT"
},
{
"name": "actions.capability.AUDIO_OUTPUT"
},
{
"name": "actions.capability.MEDIA_RESPONSE_AUDIO"
},
{
"name": "actions.capability.WEB_BROWSER"
}
]
},
"conversation": {},
"inputs": [
{
"rawInputs": [],
"intent": "actions.intent.SIGN_IN",
"arguments": [
{
"name": "SIGN_IN",
"extension": {
"@type": "type.googleapis.com/google.actions.v2.SignInValue",
"status": "OK"
}
}
]
}
],
"availableSurfaces": [
{
"capabilities": [
{
"name": "actions.capability.SCREEN_OUTPUT"
},
{
"name": "actions.capability.AUDIO_OUTPUT"
},
{
"name": "actions.capability.MEDIA_RESPONSE_AUDIO"
},
{
"name": "actions.capability.WEB_BROWSER"
}
]
}
]
}رسیدگی به درخواست های دسترسی به داده ها
برای رسیدگی به درخواست دسترسی به داده‌ها، فقط بررسی کنید که کاربری که توسط شناسه Google اعلام شده از قبل در پایگاه داده شما حضور داشته باشد. قطعه کد زیر نمونه ای از نحوه بررسی اینکه آیا یک حساب کاربری در حال حاضر در پایگاه داده Firestore وجود دارد را نشان می دهد.
const admin = require('firebase-admin');
const functions = require('firebase-functions');
admin.initializeApp();
const auth = admin.auth();
const db = admin.firestore();
// Save the user in the Firestore DB after successful signin
app.intent('Get Sign In', async (conv, params, signin) => {
if (signin.status !== 'OK') {
return conv.close(`Let's try again next time.`);
}
const color = conv.data[Fields.COLOR];
const {email} = conv.user;
if (!conv.data.uid && email) {
try {
conv.data.uid = (await auth.getUserByEmail(email)).uid;
} catch (e) {
if (e.code !== 'auth/user-not-found') {
throw e;
}
// If the user is not found, create a new Firebase auth user
// using the email obtained from the Google Assistant
conv.data.uid = (await auth.createUser({email})).uid;
}
}
if (conv.data.uid) {
conv.user.ref = db.collection('users').doc(conv.data.uid);
}
conv.close(`I saved ${color} as your favorite color for next time.`);
});
// Retrieve the user's favorite color if an account exists, ask if it doesn't.
app.intent('Default Welcome Intent', async (conv) => {
const {payload} = conv.user.profile;
const name = payload ? ` ${payload.given_name}` : '';
conv.ask(`Hi${name}!`);
// conv.user.ref contains the id of the record for the user in a Firestore DB
if (conv.user.ref) {
const doc = await conv.user.ref.get();
if (doc.exists) {
const color = doc.data()[Fields.COLOR];
return conv.ask(`Your favorite color was ${color}. ` +
'Tell me a color to update it.');
}
}
conv.ask(`What's your favorite color?`);
});
private class FirestoreManager {
private final Firestore db;
private final DocumentReference userDocRef;
private final String uid;
public FirestoreManager(String databaseUrl, String email)
throws IOException, FirebaseAuthException {
if (FirebaseApp.getApps().isEmpty()) {
// Use the application default credentials (works on GCP based hosting).
FirebaseOptions options =
new FirebaseOptions.Builder()
.setCredentials(GoogleCredentials.getApplicationDefault())
.setDatabaseUrl(databaseUrl)
.build();
FirebaseApp.initializeApp(options);
}
this.db = FirestoreClient.getFirestore();
UserRecord userRecord;
try {
userRecord = FirebaseAuth.getInstance().getUserByEmail(email);
} catch (FirebaseAuthException e) {
if (e.getErrorCode() == FIREBASE_USER_NOT_FOUND_ERROR) {
UserRecord.CreateRequest createRequest = new UserRecord.CreateRequest().setEmail(email);
userRecord = FirebaseAuth.getInstance().createUser(createRequest);
} else {
throw e;
}
}
uid = userRecord.getUid();
userDocRef = db.collection(FIRESTORE_USERS_PATH).document(uid);
}
public String readUserColor() throws ExecutionException, InterruptedException {
ApiFuture<DocumentSnapshot> future = userDocRef.get();
// future.get() blocks on response
DocumentSnapshot document = future.get();
if (document.exists()) {
return document.get(COLOR_KEY).toString();
} else {
return "";
}
}
public Timestamp writeUserColor(String color) throws ExecutionException, InterruptedException {
Map<String, Object> docData = new HashMap<>();
docData.put(COLOR_KEY, color);
ApiFuture<WriteResult> future = userDocRef.set(docData);
// future.get() blocks on response
return future.get().getUpdateTime();
}
}
@ForIntent("Get Sign In")
public ActionResponse getSignIn(ActionRequest request) {
LOGGER.info("Get sign in intent start.");
ResponseBuilder responseBuilder = getResponseBuilder(request);
if (request.isSignInGranted()) {
String color = request.getConversationData().get(COLOR_KEY).toString();
GoogleIdToken.Payload profile = getUserProfile(request.getUser().getIdToken());
try {
FirestoreManager firestoreManager =
new FirestoreManager(DATABASE_URL, profile.getEmail());
saveColor(firestoreManager, color);
} catch (Exception e) {
LOGGER.error(e.toString());
}
responseBuilder
.add("I saved " + color + " as your favorite color for next time.")
.endConversation();
} else {
responseBuilder.add("Let's try again next time");
}
LOGGER.info("Get sign in intent end.");
return responseBuilder.build();
}
private void saveColor(FirestoreManager firestoreManager, String color) {
try {
Timestamp updateTime = firestoreManager.writeUserColor(color);
LOGGER.info(String.format("Update time: %s", updateTime.toString()));
} catch (Exception e) {
LOGGER.error(e.toString());
}
}