Quickstart for Cloud Anchors in Unity for Android

Use Cloud Anchors to build AR experiences that Android and iOS users can share.

Prerequisites

  • If you are new to working with anchors, see Working with Anchors for an introduction.

  • The following steps assume that you have already installed and configured the ARCore SDK for Unity to target Android.

    If not, see the ARCore SDK Quickstart for Android for installation and environment configuration instructions.

Requirements

See Requirements in the Quickstart for Android.

Use Cloud Anchors

Set up your development environment for working with Cloud Anchors and try out the sample app.

About Cloud Anchors ID sharing

Apps with Cloud Anchors capabilities need a way to share cloud anchor IDs between devices.

The CloudAnchors sample app uses Unity's Networking feature for sharing Cloud Anchors IDs between devices on the same network. You can use a different solution in your own apps.

Add an API Key

To use the ARCore Cloud Anchor API in your app, you'll need an API Key.

  1. Obtain an API Key. See Setting up API keys in the Google Cloud Platform Console Help Center if you are new to working with API keys.

  2. Enable the ARCore Cloud Anchor API for your Google Cloud Platform project.

  3. Add your API key to your project:

    • In Unity, go to Edit > Project Settings > ARCore
    • Add your API key to the Cloud Services API Key field.

Open the sample

The CloudAnchors sample is included with the ARCore SDK for Unity.

  1. In the Unity Project window, you can find the CloudAnchor.unity scene in:
    Assets > GoogleARCore > Examples > CloudAnchor > Scenes

Try out the sample

Build and run the CloudAnchors sample app to try out hosting and resolving Cloud Anchors.

  1. Make sure that your build and player settings are configured as described in Configure build settings steps in the ARCore SDK Quickstart for Unity.

  2. This example uses the Unity Multiplayer API. To be able to use multiplayer services, you must set up project services and set up multiplayer.

  3. Make sure that developer options and debugging are enabled on your phone.

  4. Connect your phone to your development machine via USB.

  5. Click Play in Unity.

  6. The sample app launches on your phone using Instant Preview.

  7. Create a room with the host device. The app will display a room code which can be used to join this room from another device.

  8. Move your phone around until ARCore starts detecting and visualizing planes.

  9. Tap a plane to create an anchor object on it. A host request is sent to the Google Cloud Anchor service. The host request includes data representing the anchor's position relative to the visual features near it.

  10. After the Cloud Anchor is successfully hosted, subsequent taps will create Star objects, which will be synchronized across devices using Unity Multiplayer Services.

  11. Launch the example from a new device, and join the room you created previously. A request is sent to the Google Cloud Anchor service to resolve the pose of the cloud anchor. When this request returns successfully, the sample app renders the anchor using the pose.

  12. Both devices will now be able to tap the screen to place Stars.

Next steps

Send feedback about...