Google API ऐक्सेस करें

अगर आपको Google Play services की मदद से काम करने वाले किसी SDK टूल में मौजूद किसी एपीआई को कॉल करना है, तो आपको पहले एपीआई क्लाइंट ऑब्जेक्ट का एक इंस्टेंस बनाना होगा. जैसे, Google Sign-in या ML Kit. ये ऑब्जेक्ट, Google Play services से जुड़े कनेक्शन को अपने-आप मैनेज करते हैं. कनेक्शन उपलब्ध होने पर, हर एपीआई क्लाइंट ऑब्जेक्ट, अनुरोधों को क्रम से पूरा करता है. ऐसा न करने पर, क्लाइंट ऑब्जेक्ट, अनुरोधों को कतार में लगा देता है. जब तक दस्तावेज़ में कुछ और न बताया गया हो, तब तक क्लाइंट ऑब्जेक्ट बनाना आसान होता है. जब भी आपको एपीआई के तरीके को शुरू करना हो, तब नए एपीआई क्लाइंट बनाए जा सकते हैं.

इस गाइड में, Google Play services की मदद से काम करने वाले किसी भी SDK के लिए एपीआई कॉल करने का तरीका बताया गया है. इसमें, उन सेवाओं को ऐक्सेस करने का तरीका भी बताया गया है जिनके लिए अनुमति की ज़रूरत नहीं होती और जिनके लिए अनुमति की ज़रूरत होती है.

अपनी प्रोफ़ाइल बनाना शुरू करें

शुरू करने के लिए, अपने ऐप्लिकेशन प्रोजेक्ट में ज़रूरी टूल और डिपेंडेंसी जोड़ें. इसके बारे में, Google Play की सेवाओं को सेट अप करने के तरीके की गाइड में बताया गया है.

अनुमति के बिना ऐक्सेस करना

ऐसी सेवा को ऐक्सेस करने के लिए जिसे एपीआई की अनुमति की ज़रूरत नहीं है, सेवा के क्लाइंट ऑब्जेक्ट का एक इंस्टेंस पाएं. इसके लिए, उसे मौजूदा Context या मौजूदा Activity पास करें. कोई भी एपीआई कॉल लागू होने से पहले, उपयोगकर्ताओं को Google Play की सेवाओं को अपग्रेड करने के लिए कहा जाता है.

उदाहरण के लिए, Android के लिए Fused Location Provider का इस्तेमाल करके, डिवाइस की पिछली जगह की जानकारी पाने के लिए, नीचे दिए गए कोड स्निपेट में दिखाया गया लॉजिक जोड़ें:

Kotlin

// Code required for requesting location permissions omitted for brevity.
val client = LocationServices.getFusedLocationProviderClient(this)

// Get the last known location. In some rare situations, this can be null.
client.lastLocation.addOnSuccessListener { location : Location? ->
    location?.let {
        // Logic to handle location object.
    }
}

Java

// Code required for requesting location permissions omitted for brevity.
FusedLocationProviderClient client =
        LocationServices.getFusedLocationProviderClient(this);

// Get the last known location. In some rare situations, this can be null.
client.getLastLocation()
        .addOnSuccessListener(this, location -> {
            if (location != null) {
                // Logic to handle location object.
            }
        });

अनुमति की ज़रूरत होने पर ऐक्सेस करना

उपयोगकर्ता की अनुमति की ज़रूरत वाली सेवा को ऐक्सेस करने के लिए, यह तरीका अपनाएं:

1. उपयोगकर्ता को साइन इन कराएं.
2. सेवा के लिए ज़रूरी स्कोप को ऐक्सेस करने की अनुमति का अनुरोध करें.
3. सेवा के क्लाइंट ऑब्जेक्ट का इंस्टेंस पाएं. इसके लिए, उपयोगकर्ता के Context या Activity ऑब्जेक्ट के साथ-साथ, GoogleSignInAccount ऑब्जेक्ट को पास करें.

नीचे दिए गए उदाहरण में, Google Fit API का इस्तेमाल करके, उपयोगकर्ता के हर दिन के कदमों की जानकारी पढ़ने का तरीका बताया गया है. किसी पूरे प्रोजेक्ट के संदर्भ में, इसी तरह के लागू होने को देखने के लिए, GitHub पर BasicHistoryApiKotlin ऐप्लिकेशन की मुख्य गतिविधि देखें.

Kotlin

class FitFragment : Fragment() {
    private val fitnessOptions: FitnessOptions by lazy {
        FitnessOptions.builder()
            .addDataType(DataType.TYPE_STEP_COUNT_CUMULATIVE)
            .addDataType(DataType.TYPE_STEP_COUNT_DELTA)
            .build()
    }

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        fitSignIn()
    }

    /*
     * Checks whether the user is signed in. If so, executes the specified
     * function. If the user is not signed in, initiates the sign-in flow,
     * specifying the function to execute after the user signs in.
     */
    private fun fitSignIn() {
        if (oAuthPermissionsApproved()) {
            readDailySteps()
        } else {
            GoogleSignIn.requestPermissions(
                this,
                SIGN_IN_REQUEST_CODE,
                getGoogleAccount(),
                fitnessOptions
            )
        }
    }

    private fun oAuthPermissionsApproved() =
        GoogleSignIn.hasPermissions(getGoogleAccount(), fitnessOptions)

    /*
     * Gets a Google account for use in creating the fitness client. This is
     * achieved by either using the last signed-in account, or if necessary,
     * prompting the user to sign in. It's better to use the
     * getAccountForExtension() method instead of the getLastSignedInAccount()
     * method because the latter can return null if there has been no sign in
     * before.
     */
    private fun getGoogleAccount(): GoogleSignInAccount =
        GoogleSignIn.getAccountForExtension(requireContext(), fitnessOptions)

    /*
     * Handles the callback from the OAuth sign in flow, executing the function
     * after sign-in is complete.
     */
    override fun onActivityResult(
            requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)
        when (resultCode) {
            RESULT_OK -> {
                readDailySteps()
            }
            else -> {
                // Handle error.
            }
        }
    }

    /*
     * Reads the current daily step total.
     */
    private fun readDailySteps() {
        Fitness.getHistoryClient(requireContext(), getGoogleAccount())
            .readDailyTotal(DataType.TYPE_STEP_COUNT_DELTA)
            .addOnSuccessListener { dataSet ->
                val total = when {
                    dataSet.isEmpty -> 0
                    else -> dataSet.dataPoints.first()
                            .getValue(Field.FIELD_STEPS).asInt()
                }

                Log.i(TAG, "Total steps: $total")
            }
            .addOnFailureListener { e ->
                Log.w(TAG, "There was a problem getting the step count.", e)
            }
    }

    companion object {
        const val SIGN_IN_REQUEST_CODE = 1001
    }
}

Java

public class FitFragment extends Fragment {
    private final FitnessOptions fitnessOptions = FitnessOptions.builder()
            .addDataType(DataType.TYPE_STEP_COUNT_CUMULATIVE)
            .addDataType(DataType.TYPE_STEP_COUNT_DELTA)
            .build();

    @Override
    public void onViewCreated(
            @NotNull View view, @Nullable Bundle savedInstanceState) {
        fitSignIn();
    }

    /*
     * Checks whether the user is signed in. If so, executes the specified
     * function. If the user is not signed in, initiates the sign-in flow,
     * specifying the function to execute after the user signs in.
     */
    private void fitSignIn() {
        if (oAuthPermissionsApproved()) {
            readDailySteps();
        } else {
            GoogleSignIn.requestPermissions(this, SIGN_IN_REQUEST_CODE,
                    getGoogleAccount(), fitnessOptions);
        }
    }

    private boolean oAuthPermissionsApproved() {
        return GoogleSignIn.hasPermissions(getGoogleAccount(), fitnessOptions);
    }

    /*
     * Gets a Google account for use in creating the fitness client. This is
     * achieved by either using the last signed-in account, or if necessary,
     * prompting the user to sign in. It's better to use the
     * getAccountForExtension() method instead of the getLastSignedInAccount()
     * method because the latter can return null if there has been no sign in
     * before.
     */
    private GoogleSignInAccount getGoogleAccount() {
        return GoogleSignIn.getAccountForExtension(
                requireContext(), fitnessOptions);
    }

    /*
     * Handles the callback from the OAuth sign in flow, executing the function
     * after sign-in is complete.
     */
    @Override
    public void onActivityResult(
            int requestCode, int resultCode, @Nullable Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        if (resultCode == RESULT_OK) {
            readDailySteps();
        } else {
            // Handle error.
        }
    }

    /*
     * Reads the current daily step total.
     */
    private void readDailySteps() {
        AtomicInteger total = new AtomicInteger();
        Fitness.getHistoryClient(requireContext(), getGoogleAccount())
                .readDailyTotal(DataType.TYPE_STEP_COUNT_DELTA)
                .addOnSuccessListener(dataSet -> {
                    if (!dataSet.isEmpty())
                        total.set(Integer.parseInt(dataSet.getDataPoints()
                                .get(0).getValue(FIELD_STEPS).toString()));
                        Log.i(TAG, "Total steps: $total");
                })
                .addOnFailureListener(e -> {
                    Log.w(TAG, "There was a problem getting the step count.", e);
                });
    }

    private static final int SIGN_IN_REQUEST_CODE = 1001;
}

एपीआई की उपलब्धता देखना

अपने ऐप्लिकेशन में ऐसी सुविधा चालू करने से पहले जो Google Play services के एपीआई पर निर्भर करती है, डिवाइस पर एपीआई की उपलब्धता की जांच करें. ऐसा करने के लिए, checkApiAvailability() को कॉल करें.

ध्यान दें: यह जांच सिर्फ़ तब ज़रूरी है, जब एपीआई उपलब्ध न होने पर आपको अपने ऐप्लिकेशन में किसी सुविधा को बंद करना हो. एपीआई उपलब्ध न होने पर, एपीआई कॉल पूरे नहीं होते. इसलिए, एपीआई उपलब्ध होने की जांच किए बिना भी एपीआई के तरीके कॉल किए जा सकते हैं.

यहां दिए गए कोड स्निपेट में, फ़्यूज़ की गई जगह की जानकारी देने वाली सेवा की उपलब्धता की जांच करने का तरीका बताया गया है.

Kotlin

fun getLastLocationIfApiAvailable(context: Context?): Task<Location>? {
    val client = getFusedLocationProviderClient(context)
    return GoogleApiAvailability.getInstance()
        .checkApiAvailability(client)
        .onSuccessTask { _ -> client.lastLocation }
        .addOnFailureListener { _ -> Log.d(TAG, "Location unavailable.")}
}

Java

public Task<Location> getLastLocationIfApiAvailable(Context context) {
    FusedLocationProviderClient client =
            getFusedLocationProviderClient(context);
    return GoogleApiAvailability.getInstance()
            .checkApiAvailability(client)
            .onSuccessTask(unused -> client.getLastLocation())
            .addOnFailureListener(e -> Log.d(TAG, "Location unavailable."));
}