Quick Start
To effectively utilize the Uber Ads API, you must follow some key steps to set up your environment and gain access to the API’s features. This section outlines the prerequisites necessary for getting started.
¶ Ad Account Requirements
To manage your ads through the Uber Ads API, you must have an active ad account. This account is crucial not only for running campaigns but also for managing billing settings and setting spending limits. An ad account allows you to track your advertising expenses, monitor performance, and optimize your campaigns effectively.
Note that your store ID can serve as your ad account ID for API calls. When using a store ID in the APIs, campaigns are managed at the store level and these campaigns will not show up in a user’s ad account if the user has access to both the store and ad account. Use the Eats API to get the list of stores.
¶ Step 1: Create a developer application
Next, register your application in the Uber Developer Dashboard:
- Go to the Uber Developer Dashboard
- Sign in with your Uber account
- Click “Create App” and fill out the application details:
- App name: A descriptive name for your integration
- App description: Brief description of what your app will do
- Redirect URLs: Where users will be sent after authorization
¶ Step 2: Request API access and scopes
Request access to the Ads API with the scopes you need:
Available scopes:
ads.campaigns.read
- Read access to campaign dataads.ad-accounts.read
- Read access to user’s ad accountsads.products.read
- Read access to product endpointsads.reporting
- Access to reporting endpoints
Provide your app details and use case when requesting access. Approval typically takes 3-5 business days.
¶ Step 3: Set up authentication
Follow our Authentication guide to implement OAuth 2.0 and get your access tokens.
¶ Next steps
Now that you’re set up, explore the API capabilities:
- Campaign Management: Create and manage advertising campaigns
- Performance Analytics: Access detailed reporting data
- Product Catalog: View product catalog and details
Check out the API Reference for detailed endpoint documentation and the Overview section to understand key concepts like ad hierarchy and rate limiting.
¶ Getting help
If you run into issues:
- Review the Error Handling guide for common problems
- Check your OAuth scopes match your API usage
- Verify your authentication credentials are valid