نمای کلی

OAuth-based App Flip Linking (App Flip) allows your users to quickly link their accounts in your authentication system to their Google Accounts. If your app is installed on your user's phone when they initiate the account linking process, they are seamlessly flipped to your app to obtain user authorization.

This approach provides a faster linking process since the user does not have to re-enter their username and password to authenticate; instead, App Flip leverages the credentials from the user's account on your app. Once a user has linked their Google Account with your app, they can take advantage of any integrations that you have developed.

You can set up App Flip for both iOS and Android apps.

This figure shows the steps for a user to link their Google account to your authentication system. The first screenshot shows how a user can select your app if their Google account is linked to your app. The second screenshot shows the confirmation for linking their Google account with your app. The third screenshot shows a successfully linked user account in the Google app.
Figure 1. Account linking on a user's phone with App Flip.

Requirements

To implement App Flip, you must fulfill the following requirements:

  • You must have an Android or iOS app.
  • You must own, manage and maintain an OAuth 2.0 server which supports the OAuth 2.0 authorization code flow.

OAuth-based App Flip Flow

The following sequence diagram details the interaction between the User, Google App, Your App, and Your Authorization Server for App Flip.

User Google App Your App Google Server Your Auth Server 1. Initiates linking 2. Deep link to Your App 3. Show Consent Screen 4. User Grants Consent 5. Get Auth Code 6. authorization_code 7. Return to Google App 8. Pass code to Google Server 9. Token Exchange (POST) 10. access_token, refresh_token 11. Store user tokens 12. Access user resources
Figure 2. The sequence of events in the App Flip flow. If an authorization code is provided, the token exchange happens server-to-server, the same way it does in the browser-based OAuth linking flow.

Roles and responsibilities

The following table defines the roles and responsibilities of the actors in the App Flip flow.

Actor / Component GAL Role Responsibilities
Google App / Server OAuth Client Initiates the linking process, triggers a deep link to your mobile app, exchanges the authorization code for tokens, and securely stores them to access your service's APIs.
Your App Authorization Agent Authenticates the user (typically using existing app credentials), obtains consent, and retrieves an authorization code from your server.
Your Authorization Server Authorization Server Validates authorization codes and refresh tokens, and issues access tokens to the Google Server.

برای اطلاعات بیشتر در مورد جریان کد مجوز پیوند OAuth، به اجرای سرور OAuth خود مراجعه کنید.

Design guidelines

This section describes the design requirements and recommendations for the App Flip account linking consent screen. After Google calls your app, your app displays the consent screen to the user.

Requirements

  1. You must communicate that the user’s account is being linked to Google, not to a specific Google product, such as Google Home or Google Assistant.

Recommendations

We recommend that you do the following:

  1. Display Google's Privacy Policy. Include a link to Google’s Privacy Policy on the consent screen.

  2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

  3. Clear call-to-action. State a clear call-to-action on your consent screen, such as “Agree and link.” This is because users need to understand what data they're required to share with Google to link their accounts.

  4. Ability to deny or cancel. Provide a way for users to go back, deny, or cancel, if they choose not to link.

  5. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

  6. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

    • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking and the implicit flow.

  7. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

This figure shows an example consent screen with call-outs to the individual requirements and recommendations to be followed when you design a user consent screen.
Figure 2. Account linking consent screen design guidelines.

برای App Flip مبتنی بر OAuth تنظیم کنید

بخش‌های زیر پیش‌نیازهای App Flip مبتنی بر OAuth و نحوه پیکربندی پروژه App Flip خود را در کنسول Actions شرح می‌دهند.

یک Action ایجاد کنید و یک سرور OAuth 2.0 راه اندازی کنید

قبل از اینکه بتوانید App Flip را پیکربندی کنید، باید موارد زیر را انجام دهید:

  • یک اکشن ایجاد کنید. برای ایجاد یک Action، دستورالعمل های موجود در بخش Create a project را دنبال کنید.
  • یک سرور OAuth 2.0 راه اندازی کنید. برای اطلاعات بیشتر درباره راه‌اندازی سرور OAuth، به پیاده‌سازی پیوند حساب OAuth مراجعه کنید.

App Flip را در کنسول Actions پیکربندی کنید

بخش زیر نحوه پیکربندی App Flip را در کنسول Actions توضیح می‌دهد.

  1. روی توسعه در پیمایش بالا کلیک کنید. سپس روی Account linking در ناوبری سمت چپ کلیک کنید.
  2. سوئیچ کنار پیوند حساب را روشن کنید.
  3. در قسمت ایجاد حساب ، خیر را انتخاب کنید، من فقط می‌خواهم اجازه ایجاد حساب در وب‌سایت خود را بدهم .
  4. روی Next کلیک کنید.
  5. در قسمت نوع پیوند ، OAuth و کد مجوز را از منوهای کشویی انتخاب کنید.
  6. روی Next کلیک کنید.
  7. تمام فیلدهای زیر اطلاعات مشتری OAuth را پر کنید. (اگر App Flip پشتیبانی نمی شود، OAuth معمولی به عنوان یک بازگشت استفاده می شود.)
  8. روی Next کلیک کنید.
  9. در قسمت Use your app for account linking (اختیاری) ، گزینه Enable for iOS را علامت بزنید.
  10. فیلد پیوند جهانی را پر کنید. برای اطلاعات بیشتر درباره پیوندهای جهانی، به اجازه دادن به برنامه‌ها و وب‌سایت‌ها برای پیوند دادن به محتوای شما مراجعه کنید.
  11. اگر می‌خواهید به صورت اختیاری مشتری خود را پیکربندی کنید، دامنه‌ها را اضافه کنید و روی Add scope در زیر Configure your client (اختیاری) کلیک کنید. اگر نه، روی Next کلیک کنید.
  12. در دستورالعمل‌های تست، test (یا هر رشته دیگری) را به‌عنوان جای‌بان تایپ کنید. (پر کردن این فیلد با یک حساب آزمایشی تنها در صورتی ضروری است که شما واقعاً اقدام خود را برای انتشار ارسال می کنید.)
  13. روی ذخیره کلیک کنید.

اکنون می توانید برای پیاده سازی App Flip در برنامه iOS یا Android خود به بخش بعدی بروید.

App Flip را در برنامه های بومی خود پیاده کنید

برای اجرای App Flip، باید کد مجوز کاربر را در برنامه خود تغییر دهید تا پیوند عمیق از Google را بپذیرید.

برنامه Flip را روی دستگاه خود تست کنید

اکنون که یک Action ایجاد کرده اید و App Flip را در کنسول و برنامه خود پیکربندی کرده اید، می توانید App Flip را در دستگاه تلفن همراه خود آزمایش کنید. برای آزمایش App Flip می توانید از برنامه Google Assistant استفاده کنید.

برای آزمایش App Flip از برنامه Assistant، این مراحل را دنبال کنید:

  1. به کنسول Actions بروید و پروژه خود را انتخاب کنید.
  2. روی تست در پیمایش بالا کلیک کنید.
  3. جریان پیوند حساب را از برنامه دستیار فعال کنید:
    1. برنامه Google Assistant را باز کنید.
    2. روی تنظیمات کلیک کنید.
    3. در تب Assistant، روی Home Control کلیک کنید.
    4. روی Add(+) کلیک کنید.
    5. Action خود را از لیست ارائه دهندگان انتخاب کنید. پیشوند آن با "[test]" در لیست خواهد بود. وقتی اکشن [تست] خود را از لیست انتخاب می‌کنید، باید برنامه شما را باز کند.
    6. بررسی کنید که برنامه شما راه اندازی شده است و شروع به آزمایش جریان مجوز خود کنید.