# Introduction Welcome to the official Uniquery Help Center. [Uniquery](https://uniquery.io/) is designed with one goal in mind: to simplify data workflows for individuals and teams by connecting APIs and data sources directly to your Google Sheets.
With the power of Uniquery, you can: * Automate data imports and eliminate tedious manual exports. * Effortlessly connect and sync your data across over 100 sources, including marketing platforms, analytics tools, and more. * Automatically update your imported data in the cloud. * Strengthen data workflows with customizable and scalable API connections. This Help Center is your comprehensive guide to getting the most out of Uniquery. Below is an overview of what we cover: #### 1. Getting Started with Uniquery * Introduction to Uniquery: What it is and who it's for. * Installation and setup in Google Sheets™. * Navigating the Uniquery menu and user interface. #### **2. Core Features & Functionalities** * Complete guide to the API Connector. * Using HTTP methods for API requests: GET, POST, PUT, PATCH, and DELETE. * Fetching and importing data in JSON and CSV formats. * Scheduling automatic data refreshes (hourly, daily, weekly). #### **3. Security & OAuth Integrations** * Overview of OAuth 2.0 and secure API connections. * Setting up OAuth configurations for platforms like Facebook Ads, Google Analytics, and more. * Sharing API connections with your team securely. #### **4. Advanced Guides & Tips** * Using cell references for dynamic API query customization. * Managing headers, body fields, and authentication for tailored API setups. * Connecting Uniquery to Google Looker Studio for advanced visualization. #### **5. Common Use Cases** * How marketing agencies use Uniquery to streamline campaign reporting. * Generating comprehensive dashboards with real-time data refresh. * Enhancing workflow collaboration within teams. #### **6. Troubleshooting & FAQs** * Resolving common issues with API integrations. * Understanding error codes and debugging queries. * General product FAQs to ensure a smooth experience. ### An overview of Uniquery features #### Connect to your data sources Uniquery simplifies the data import process for marketers and marketing agencies by allowing you to connect to all your data sources with just one click. Whether you're managing campaigns on Facebook Ads, Google Ads, LinkedIn Ads, or analyzing metrics from Google Analytics and Google Search Console, Uniquery has you covered. It also supports integrations with essential tools like HubSpot, Mailchimp, Shopify, Zendesk, and Stripe. For agencies handling multiple client accounts, Uniquery makes it easy to import and manage data from each client's platforms, ensuring you have a comprehensive view of all your marketing efforts in one place.
#### Select your metrics and dimensions Uniquery empowers you to create highly customized KPI and performance reports by allowing you to select only the metrics and dimensions that matter most to your campaigns. With more than 1000 metrics and dimensions from various data sources, you can build the most relevant and accurate marketing reports tailored to your needs. Additionally, you have the flexibility to choose the date range for your reports, ensuring that your data analysis is always timely and contextually appropriate. This level of customization helps you deliver actionable insights to your clients, enhancing your reporting and decision-making processes.
#### Automatic data refresh Stay on top of your campaigns with Uniquery's scheduled refresh feature, which automatically updates your data on a weekly, daily, or even hourly basis. This ensures that you always have the most current information at your fingertips, allowing you to make timely and informed decisions. For marketing agencies, this means you can effortlessly share up-to-date data with clients, providing them with real-time insights and enhancing your reporting accuracy. No more manual updates or outdated reports—Uniquery keeps your data fresh and reliable, so you can focus on optimizing your marketing strategies.
#### OAuth 2.0 support and pagination handling Uniquery's OAuth 2.0 support ensures that you can connect to any API endpoint seamlessly, a crucial feature for marketers who need to access diverse and secure data sources. Additionally, Uniquery automatically handles pagination, allowing you to import large datasets effortlessly. This means you can focus on analyzing and optimizing your marketing strategies while Uniquery manages the technical complexities, ensuring you have all the data you need at your fingertips. We’re excited to help you explore Uniquery’s full potential! Browse through the topics above to dive into a particular feature or check out our guides for hands-on assistance. Get started now and take control of your data with **Uniquery**! # How Uniquery works? Uniquery is a Google Sheets addon that connects Google Sheets with external data sources. By importing data directly into Sheets, it streamlines data management and analysis. The addon can be installe Uniquery currently is a Google Sheets addon designed to facilitate the connection between Google Sheets and various external data sources. By using Uniquery, users can import data from these sources directly into their Google Sheets, enabling efficient data management and analysis. ### Installation To use Uniquery, you first need to install the addon from the Google Workspace Marketplace. Follow these steps: 1. Open Google Sheets. 2. Navigate to `Extensions` in the menu bar. 3. Select `Add-ons` and then `Get add-ons`. 4. In the Google Workspace Marketplace, search for "Uniquery". Or use this [direct install link](https://workspace.google.com/marketplace/app/uniquery_api_connector_with_oauth_2_supp/275511172491). 5. Click on the Uniquery addon and select `Install`. Once installed, the Uniquery addon will be available under the `Extensions` menu in Google Sheets. ### Connecting to Data Sources Uniquery allows users to connect to a variety of external data sources. These connections can be managed through the Manage Connections feature. Here is how you can connect to a data source: 1. Open Google Sheets and navigate to `Extensions > Uniquery` to open the addon. 2. In the Uniquery sidebar, click on the `Create` button and select `Manage Connections`. 3. A new window will display a list of available integrations. 4. Select the desired integration and click on the `Add Connection` button. 5. An authorization page will appear. Follow the prompts to log in and authorize your account. 6. Once authorization is complete, the connection will be added to your list of managed connections.
### Creating Reports Uniquery provides functionality for generating reports based on the connected data sources. To create a report, follow these steps: 1. In the Uniquery sidebar, navigate to the `Create report` page. 2. Select the type of report you wish to create from the available options. 3. Choose the corresponding connection that you have already established. 4. Follow the prompts to configure the report parameters, adding metrics and dimensions, or date range. 5. Generate the report, and the data will be imported into your Google Sheets.
### Executing API Queries In addition to generating reports, Uniquery allows users to execute general API queries. This feature is useful for custom data retrieval tasks. To execute an API query: 1. In the Uniquery sidebar, navigate to the `API query` page. 2. Select the connection you want to use for the API query from the dropdown menu. 3. Provide the necessary query parameters and configuration, such as headers, and request body. 4. Your API query can be authenticated using the selected connection (OAuth 2). 5. Execute the query to retrieve data from the connected data source. When dealing with large datasets, pagination is often required to retrieve all data. Uniquery provides built-in support for handling pagination in API queries. To handle pagination: 1. In the `API query` page, configure your query parameters as usual. 2. Specify the pagination parameters, such as the page number and page size, according to the API documentation of the data source. 3. Uniquery will automatically handle the pagination by retrieving data in multiple requests and combining the results. 4. Execute the query to retrieve the complete dataset.
This feature simplifies the process of working with large datasets by ensuring that all data is retrieved and combined seamlessly. ### Automated Data Refresh Uniquery supports automated data refresh to ensure that your data remains up-to-date. This feature allows users to schedule data refresh for created reports and API queries at specified intervals, such as hourly, daily, or weekly. To set up automated data refresh: In the Uniquery sidebar, navigate to the `In this spreadsheet` page. Select the query for which you want to enable automated data refresh. Configure the refresh interval and other relevant settings. Save the configuration. Uniquery will automatically refresh the data at the specified intervals. ### Conclusion Uniquery is a powerful tool for integrating Google Sheets with various external data sources. By following the steps outlined in this documentation, users can efficiently connect, manage, and utilize data from multiple platforms within their Google Sheets environment. # Manage connections The Manage Connections feature in Uniquery facilitates seamless integration between Google Sheets and external APIs, supporting custom OAuth 2.0 flows for platforms beyond preset options. The Manage Connections feature is crucial for creating connections between Google Sheets and external APIs using Uniquery. It supports custom OAuth 2.0 flows, enabling users to connect with platforms not available in Uniquery's preset integrations. Here are some of the preset integrations we support: * Facebook Ads * Google Ads * Google Analytics * Linkedin Ads * Hubspot * Mailchimp * Stripe * Google Search Console * Google My Business * Shopify * Zendesk * MySQL * PostgreSQL This list is continuously growing as we add more integrations to Uniquery. ## Manage Connections in Google Sheets Addon To manage connections in the Uniquery addon, start by opening a new or existing Google Sheets file. Navigate to the menu bar and click on `Extensions`. From the dropdown menu, select `Uniquery` to open the addon.
In the Uniquery sidebar, locate the `Create` button. Click on the `Create` button and select `Manage Connections` from the dropdown menu. A new window will appear displaying a list of all available integrations that you can connect to. ### Connect to a Data Source To connect to a data source, first, select an integration from the list of available integrations. For example, if you want to connect to Google Analytics, click on the `Add Connection` button next to the Google Analytics integration.
An authorization page will appear where you need to authorize your account. Follow the prompts to log in to your account and ensure that you grant Uniquery all requested permissions to successfully pull your data. Once the authorization process is complete, you will be redirected back to Google Sheets, and the new connection will now appear in your list of managed connections. ### Use Connections in Queries You can use your connected data sources in the `Create report` or `API query` sections of Uniquery. To use a connection in the `Create report` page, navigate to the Uniquery sidebar and select the `Create report` option. Based on the report you are creating, choose the corresponding connection. For example, if you are creating a Facebook Ads report, select the Facebook Ads connection you have already established, and follow the prompts to generate your report using the selected connection.
To use a connection in the `API query` section, navigate to the Uniquery sidebar and select the `API query` option. Use the dropdown menu to select the connection you want to use for your API query. Ensure that your API query is authenticated using the selected connection by following the prompts to complete the query setup. Once the setup is complete, execute the API query to retrieve data from the connected data source.
# New API query Uniquery offers a powerful solution for integrating external data into Google Sheets through its API Connection feature. This tool allows users to connect seamlessly to various API endpoints, enabling automatic data updates and efficient data management. The key aspects of this feature are outlined in detail below.
### OAuth 2.0 Support and Pagination Handling One of the significant technical features of Uniquery is its support for OAuth 2.0. This protocol is essential for secure and seamless connectivity to various API endpoints, which is particularly crucial for marketers and data analysts who need access to data across multiple platforms. OAuth 2.0 simplifies the authentication process, ensuring that connections are both secure and reliable. Additionally, Uniquery efficiently handles pagination in APIs. Many APIs limit the amount of data returned in a single request, delivering it in multiple "pages" instead. Uniquery automatically manages these pages, collecting all the necessary data across multiple requests and compiling it into a single, comprehensive dataset. This feature saves users from the manual hassle of pagination and allows them to focus more on data analysis and interpretation. ### Step-by-Step Guide to Using the API Connector #### **Step 1: Create a New API Query** 1. Open Google Sheets and navigate to the Uniquery add-on from the Extensions menu. 2. In the Uniquery sidebar, click on the "Create" button and select "New API query" from the dropdown menu. 3. Enter a name for your query in the "Name" field. This helps you identify the API query in future projects. #### **Step 2: Configure the HTTP Method and URL** 1. Select the appropriate HTTP method (GET, POST, PUT, DELETE, or PATCH) from the dropdown menu. The method you choose indicates the action you intend to perform, such as retrieving data (GET) or creating new records (POST). 2. Enter the API endpoint URL in the "URL" field. Ensure you use the precise URL as outlined in the API documentation. \ Example:\ For a dummy JSON endpoint, you can use the following URL: ```javascript https://jsonplaceholder.typicode.com/posts ``` #### **Step 3: Add Optional Parameters and Headers** Use the "Parameters" section to specify any criteria or filters for your API request by adding key-value pairs. For example, you can add a parameter to retrieve records from a particular date onwards. Add headers to your API request in the "Request headers" section. Headers allow you to specify metadata associated with your request, such as the content type or authorization credentials. Headers provide metadata about your request, such as content type or authorization credentials. Here are some examples of common headers:
1. **Content Type Header**: * **Key**: `Content-Type` * **Value**: `application/json` * **Description**: This header specifies that the request body is formatted in JSON.
2. **Authorization Header**: * **Key**: `Authorization` * **Value**: `Bearer YOUR_ACCESS_TOKEN` * **Description**: This header includes the access token required for authenticating the API request.
3. **Custom Header**: * **Key**: `X-Custom-Header` * **Value**: `customValue` * **Description**: This is an example of a custom header that might be required by some APIs for specific configurations or custom settings. #### **Step 4: Add an OAuth 2.0 Connection (Optional)** If your API requires OAuth 2.0 authentication, click on the "Add an OAuth2 Connection" button. Follow the prompts to select and authorize the OAuth connection. This step ensures that your API query is authenticated securely. **See more:** [**Manage connections**](/basics/manage-connections) #### **Step 5: Configure the Request Body (for POST, PUT, DELETE, or PATCH Methods)** If you are using a method other than GET, you need to include additional data with your API request in the "Request body" field. Enter the required information as per the API documentation, typically in JSON format.\ \ Example:\ For a POST request to the dummy JSON endpoint, the request body might look like this: ```javascript { "title": "foo", "body": "bar", "userId": 1 } ``` #### **Step 6: Handle Pagination (Optional)** If your API returns data in multiple pages, enable the "Handle pagination" checkbox. Configure the pagination parameters, such as the page number and page size, according to the API documentation. Uniquery will automatically handle the pagination and retrieve all data across multiple requests. **1. Offset Limit in URL** For APIs that use offset and limit parameters in the URL, you can specify these parameters to control pagination. * **Example API**: `https://api.example.com/data?offset=0&limit=50` * **Pagination Parameters**: * **Offset Parameter**: `offset` * **Limit Parameter**: `limit` * **Limit Value**: `50` **2. Offset Limit in Request Body** Some APIs require offset and limit parameters to be included in the request body. * **Example API**: `https://api.example.com/data` * **Request Body**: ```javascript { "offset": 0, "limit": 50 } ``` * **Pagination Parameters**: * **Offset Parameter**: `offset` * **Limit Parameter**: `limit` * **Limit Value**: `50` **3. Cursor in URL** APIs using cursors typically provide a token that you include in the URL to retrieve the next set of results. * **Example API**: `https://api.example.com/data?cursor=abcdef` * **Pagination Parameters**: * **Cursor Parameter**: `cursor` * **Cursor Path in Response**: `data.nextCursor` **4. Cursor in Response Body** For APIs that return the cursor in the response body, you need to specify the cursor path.
* **Example API**: `https://api.example.com/data` * **Response Body**: ```javascript { "data": [...], "nextCursor": "abcdef" } ``` * **Pagination Parameters**: * **Cursor Parameter**: `cursor` * **Cursor Path in Response**: `nextCursor` **5. Next Page URL in Response** Some APIs provide the URL for the next page of results directly in the response. * **Example API**: `https://api.example.com/data` * **Response Body**: ```javascript { "data": [...], "nextPageUrl": "https://api.example.com/data?page=2" } ``` * **Pagination Parameters**: * **Next Page URL Path**: `nextPageUrl` **6. Page-Based Pagination in URL** APIs using page-based pagination typically have parameters for the page number and page size.
* **Example API**: `https://api.example.com/data?page=1&pageSize=50` * **Pagination Parameters**: * **Page Parameter**: `page` * **Page Size Parameter**: `pageSize` * **Page Size Value**: `50` **7. Page-Based Pagination in Request Body** For APIs that use page-based pagination and require the parameters in the request body.
* **Example API**: `https://api.example.com/data` * **Request Body**: ```javascript { "page": 1, "pageSize": 50 } ``` * **Pagination Parameters**: * **Page Parameter**: `page` * **Page Size Parameter**: `pageSize` * **Page Size Value**: `50` #### Setting Stop Conditions To ensure efficient pagination handling, you can set stop conditions such as: * **Max Page Reached**: Specify the maximum number of pages to retrieve. * **No Data is Returned**: Pagination stops when the API response contains no data. * **A Specific Field is Empty**: Specify a field path that indicates when pagination should stop if the field is empty. By configuring these parameters and conditions, Uniquery will manage the pagination process automatically, ensuring comprehensive data retrieval across multiple requests. This functionality allows you to handle large datasets effectively and focus on analyzing the data \
# Queries in current spreadsheet The "In this spreadsheet" tab in Uniquery allows users to view and manage all queries that run in the current Google Sheets file. This includes both generated reports and API queries. The tab provides detailed information about each query, making it easier to monitor and maintain data connections.
### Viewing Queries To access the "In this spreadsheet" tab: 1. Open your Google Sheets file and navigate to `Extensions > Uniquery` to open the addon. 2. In the Uniquery sidebar, click on the `In this spreadsheet` tab. ### Information Available In the "In this spreadsheet" tab, you can check the following information for each query: #### Data sheet The tab displays the specific sheet within the Google Sheets file where each query runs. This helps users identify the location of the data imported by the query. #### Last Refreshed For each query, the tab shows the timestamp of the last data refresh. This information is useful for ensuring that the data is up-to-date and determining when the last update occurred. #### Auth Refresh Setting The tab provides details about the authentication refresh setting for each query. This setting indicates whether the query is configured to automatically refresh its authentication tokens, ensuring continuous access to the data source. #### Adding or Removing Auth Refresh Users can add or remove authentication refresh settings for each query directly from the "In this spreadsheet" tab. This feature allows users to enable or disable automatic authentication refresh based on their requirements. To add or remove auth refresh for a query: 1. Locate the query in the "In this spreadsheet" tab. 2. Click on the relevant option to add or remove the auth refresh setting. 3. Save the changes to update the configuration. The "In this spreadsheet" tab in Uniquery provides a comprehensive overview of all queries running in the current Google Sheets file. By offering detailed information about each query, including sheet location, last refreshed timestamp, and authentication refresh settings, users can efficiently monitor and manage their data connections. The ability to add or remove auth refresh settings further enhances the flexibility and control over data import processes within Google Sheets. # Saved queries The Saved Queries page in Uniquery allows users to store queries from other spreadsheets or projects for future reuse. This feature allows users to apply previously saved queries to any spreadsheets they own, enhancing productivity and consistency in data management. ### Accessing Saved Queries To access the Saved Queries page: 1. Open your Google Sheets file and navigate to `Extensions > Uniquery` to open the addon. 2. In the Uniquery sidebar, click on the `Saved queries` tab.
### Viewing Saved Queries In the `Saved queries` tab, you will see a list of all your saved queries. These can include both generated reports and API queries. The tab provides an overview of each saved query, making it easy to identify and reuse them as needed. ### Applying a Saved Query To apply a saved query in your current spreadsheet: 1. Locate the desired query in the `Saved queries` tab. 2. Click the plus button (`+`) next to the query you want to apply. 3. A prompt will appear, asking you to select a sheet and a cell where the data will start importing.
4. Choose the appropriate sheet and cell for the data import. 5. Optionally, you can choose whether to set automatic refresh for the query by enabling the relevant option.
Once these steps are completed, the saved query will be applied to your current spreadsheet, and the data will be imported starting from the specified sheet and cell. The Saved Queries page in Uniquery provides a convenient way to store and reuse queries across different spreadsheets and projects. By following the steps outlined in this documentation, users can efficiently apply saved queries to any spreadsheets they own. # AI Summary The "AI Summary" feature in Uniquery allows users to generate summaries of their data using AI services, such as OpenAI. This feature can be enabled when creating or editing a run/query. Below are the steps to configure and use this feature. {% hint style="warning" %} When enabling the AI Summary feature in Uniquery, it is important to acknowledge the potential costs associated with using third-party AI services. By enabling the AI Summary feature, you acknowledge that any charges incurred from using the AI services (such as OpenAI) will be billed directly by the service provider. Uniquery is not liable for any costs, fees, or charges associated with the use of these AI services. You are solely responsible for managing and monitoring your usage to avoid unexpected expenses. Please review the pricing and billing policies of the respective AI service providers to understand the potential costs before enabling this feature. {% endhint %} ### **Steps to Enable and Configure AI Summary** #### Add AI summary when you create a query The AI summary feature can be enabled when you create a query and run it in a spreadsheet.
#### **Enable AI Summary Option**: You will find an option labeled "Send AI Summary of your data." Check this box to enable the AI summary feature. #### **Select AI Service Connection**: After enabling the AI summary option, a dropdown will appear labeled "Select AI service connection." Choose the appropriate AI service connection from this dropdown. This connection should be pre-configured with the necessary OAuth credentials for the AI service (e.g., OpenAI). #### **Customize the AI Prompt (Optional)**: There is an optional field labeled "Custom prompt (Optional)" where you can enter additional instructions or context for the AI. This helps in generating a more relevant and tailored summary. The prompt you enter here will be added to the default prompt set up for summarization. #### **Append AI Summary to Imported Data**: You will see a checkbox labeled "Append AI summary to imported data." Check this box if you want the generated summary to be appended directly to the imported data in your Google Sheet. # Database connection The Database Connection feature in Uniquery allows you to seamlessly connect Google Sheets with various SQL databases, including MySQL, Microsoft SQL Server, and PostgreSQL. This integration enables you to manage and analyze your data directly within Google Sheets, enhancing your productivity and data handling capabilities. ### Open the Uniquery Addon To begin, open a new or existing Google Sheets file. Once you have your spreadsheet open, navigate to the menu bar at the top of the page. Click on the `Extensions` menu item to reveal a dropdown menu. From this dropdown, select `Uniquery` to open the addon. This action will display the Uniquery sidebar, where you can manage your connections and create reports. ### Add a Database Connection In the Uniquery sidebar, locate the `Create` button. Click on this button to reveal a dropdown menu. From the dropdown, select `Manage Connections`. A new window will appear, displaying a list of all available integrations you can connect to. To add a new database connection, click on the any database connection, such as PostgreSQL. ### Select Database Type In the new window, you will be prompted to select the type of database you want to connect to. Uniquery supports several database types, including MySQL, Microsoft SQL Server, and PostgreSQL. Choose the appropriate database type from the available options by clicking on it. ### Enter Database Details After selecting the database type, you will need to enter the necessary details to establish the connection. Fill in the following fields with your database information: * **Database host**: Enter the host name of your database. This can be a domain name (e.g., your\_database\_host.com) or an IP address. Ensure that you do not include `http://`, `https://`, or the port number in this field. * **Database port**: Enter the port number of your database. The port number varies depending on the database type. For example, the default port number for MySQL is `3306`, while PostgreSQL typically uses `5432`. If you are unsure of the port number, check your database setup. * **Database name**: Enter the name of your database. * **User name**: Enter the username you use to access your database. * **Password**: Enter the password associated with your database username. ### Whitelist IP Addresses (if necessary) Depending on the database type you selected, you may need to whitelist certain IP addresses to allow access to your database. This step is crucial if your database is protected by a firewall. * For MySQL and Microsoft SQL Server, the database connector relies on Google's JDBC service. You will need to whitelist the IP addresses provided by Google. You can find the list of IP addresses [here](https://www.gstatic.com/ipranges/goog.txt). * For PostgreSQL, the database connector relies on Uniquery's proxy servers. You will need to whitelist the following IP address: `18.199.186.79`. ### Test the Connection Before finalizing the connection, it is important to test it to ensure that the details you entered are correct. Click the `Test connection` button to initiate the test. Uniquery will attempt to connect to your database using the provided information. If the connection test is successful, you will see a confirmation message indicating that the connection test succeeded. This means that Uniquery was able to establish a connection to your database with the provided details. If the connection test fails, an error message will appear. The error message will provide information about why the test failed. Common issues include incorrect host names, port numbers, usernames, or passwords. Double-check your connection configuration and make any necessary corrections before testing the connection again. ### Create the Connection Once the connection test is successful, you can proceed to create the connection. Click the `Create connection` button to store your database connection in Uniquery. A confirmation message will appear, indicating that the database connection was created successfully. Your new database connection will now be listed in the `Manage Connections` window. You can use this connection to create reports and run queries within Google Sheets.
# All data sources On this page, you can check out all data sources supported by Uniquery. * [Google Ads](https://help.uniquery.io/data-sources/google-ads) * [Google Analytics](https://help.uniquery.io/data-sources/google-analytics) * [Google Search Console](https://help.uniquery.io/data-sources/google-search-console) * [Facebook Ads](https://help.uniquery.io/data-sources/facebook-ads) * [Notion](https://help.uniquery.io/data-sources/notion) * [LinkedIn Ads](https://help.uniquery.io/data-sources/linkedin-ads) * [Hubspot](https://help.uniquery.io/data-sources/hubspot) * [Shopify](https://help.uniquery.io/data-sources/shopify) * [Airtable](https://help.uniquery.io/data-sources/airtable) * [Pipedrive](https://help.uniquery.io/data-sources/pipedrive) * [PostgreSQL](https://help.uniquery.io/postgresql) * [MySQL](https://help.uniquery.io/mysql) * And hundreds of other data sources enabled by [Custom API connection](/new-api-query) and [OAuth authorization](/basics/manage-connections)
# Google Ads Google Ads is Google's advertising platform that allows businesses to reach potential customers through targeted ad campaigns. By integrating Google Ads with Uniquery, users can pull valuable data directly into their Google Sheets for analysis and reporting. This integration enables users to access a wide range of metrics and dimensions related to their ad campaigns, providing insights into performance, reach, and engagement.
{% hint style="warning" %} ### Google Ads API uses micros Please be aware that, in Google Ads API, any tags containing "\_micros" will return currency values in micros. Micros are a unit of measurement representing **`one-millionth`** of the base currency unit. To convert micros to the standard currency format, you'll need to divide the value by 1,000,000. When you pull data using tags that include "\_micros," remember to convert the values back to your account's currency. This is a simple division: **Account Currency Value = Value in Micros / 1,000,000** For example: * If `campaign_budget.amount_micros` returns a value of `25000000`, this represents 25.00 in your account's currency. Keep this in mind when working with cost and budget data in your Google Ads reports to ensure accurate interpretation and analysis. {% endhint %} ### Metrics Metrics are quantitative measurements that provide insights into the performance of your Google Ads campaigns.
TagNameDescription
metrics.absolute_top_impression_percentageAbsolute top impression percentagePercentage of impressions that are shown at the absolute top of the search results page.
metrics.active_view_cpmActive view CPMCost per thousand impressions that are viewable.
metrics.active_view_ctrActive view CTRClick-through rate for impressions that are viewable.
metrics.active_view_impressionsActive view impressionsNumber of impressions that are viewable.
metrics.active_view_measurabilityActive view measurabilityPercentage of impressions that are measurable.
metrics.active_view_measurable_cost_microsActive view measurable cost microsCost of measurable impressions in micros.
metrics.active_view_measurable_impressionsActive view measurable impressionsNumber of measurable impressions.
metrics.active_view_viewabilityActive view viewabilityPercentage of measurable impressions that are viewable.
metrics.all_conversionsAll conversionsTotal number of conversions.
metrics.all_conversions_by_conversion_dateAll conversions by conversion dateTotal number of conversions by conversion date.
metrics.all_conversions_from_click_to_callAll conversions from click to callTotal number of conversions from click to call.
metrics.all_conversions_from_directionsAll conversions from directionsTotal number of conversions from directions.
metrics.all_conversions_from_interactions_rateAll conversions from interactions rateConversion rate from interactions.
metrics.all_conversions_from_interactions_value_per_interactionAll conversions from interactions value per interactionValue per interaction for all conversions.
metrics.all_conversions_from_location_asset_click_to_callAll conversions from location asset click to callConversions from location asset click to call.
metrics.all_conversions_from_location_asset_directionsAll conversions from location asset directionsConversions from location asset directions.
metrics.all_conversions_from_location_asset_menuAll conversions from location asset menuConversions from location asset menu.
metrics.all_conversions_from_location_asset_orderAll conversions from location asset orderConversions from location asset order.
metrics.all_conversions_from_location_asset_other_engagementAll conversions from location asset other engagementConversions from location asset other engagement.
metrics.all_conversions_from_location_asset_store_visitsAll conversions from location asset store visitsConversions from location asset store visits.
metrics.all_conversions_from_location_asset_websiteAll conversions from location asset websiteConversions from location asset website.
metrics.all_conversions_from_menuAll conversions from menuConversions from menu.
metrics.all_conversions_from_orderAll conversions from orderConversions from order.
metrics.all_conversions_from_other_engagementAll conversions from other engagementConversions from other engagement.
metrics.all_conversions_from_store_visitAll conversions from store visitConversions from store visit.
metrics.all_conversions_from_store_websiteAll conversions from store websiteConversions from store website.
metrics.all_conversions_valueAll conversions valueTotal value of all conversions.
metrics.all_conversions_value_by_conversion_dateAll conversions value by conversion dateTotal value of all conversions by conversion date.
metrics.all_conversions_value_per_costAll conversions value per costValue per cost for all conversions.
metrics.all_new_customer_lifetime_valueAll new customer lifetime valueLifetime value of all new customers.
metrics.auction_insight_search_absolute_top_impression_percentageAuction insight search absolute top impression percentagePercentage of search impressions that are shown at the absolute top of the search results page.
metrics.auction_insight_search_impression_shareAuction insight search impression shareShare of search impressions.
metrics.auction_insight_search_outranking_shareAuction insight search outranking sharePercentage of times your ad ranked higher in the auction than another participant's ad.
metrics.auction_insight_search_overlap_rateAuction insight search overlap rateFrequency with which your ad and another participant's ad received impressions simultaneously.
metrics.auction_insight_search_position_above_rateAuction insight search position above rateFrequency with which your ad's position was above another participant's ad.
metrics.auction_insight_search_top_impression_percentageAuction insight search top impression percentagePercentage of search impressions that are shown at the top of the search results page.
metrics.average_cart_sizeAverage cart sizeAverage number of items in a shopping cart.
metrics.average_costAverage costAverage cost per interaction.
metrics.average_cpcAverage CPCAverage cost per click.
metrics.average_cpeAverage CPEAverage cost per engagement.
metrics.average_cpmAverage CPMAverage cost per thousand impressions.
metrics.average_cpvAverage CPVAverage cost per view.
metrics.average_impression_frequency_per_userAverage impression frequency per userAverage number of times a user sees your ad.
metrics.average_order_value_microsAverage order value microsAverage value of an order in micros.
metrics.average_page_viewsAverage page viewsAverage number of page views per session.
metrics.average_target_cpa_microsAverage target CPA microsAverage target cost per acquisition in micros.
metrics.average_target_roasAverage target ROASAverage target return on ad spend.
metrics.average_time_on_siteAverage time on siteAverage amount of time users spend on your site.
metrics.benchmark_average_max_cpcBenchmark average max CPCAverage maximum cost per click for benchmark competitors.
metrics.benchmark_ctrBenchmark CTRClick-through rate for benchmark competitors.
metrics.biddable_app_install_conversionsBiddable app install conversionsNumber of app install conversions that are biddable.
metrics.biddable_app_post_install_conversionsBiddable app post install conversionsNumber of post-install conversions that are biddable.
metrics.bounce_rateBounce ratePercentage of single-page sessions.
metrics.clicksClicksNumber of clicks.
metrics.combined_clicksCombined clicksTotal number of combined clicks.
metrics.combined_clicks_per_queryCombined clicks per queryAverage number of combined clicks per query.
metrics.combined_queriesCombined queriesTotal number of combined queries.
metrics.content_budget_lost_impression_shareContent budget lost impression sharePercentage of impressions lost due to budget constraints in content campaigns.
metrics.content_impression_shareContent impression shareShare of impressions in content campaigns.
metrics.content_rank_lost_impression_shareContent rank lost impression sharePercentage of impressions lost due to rank constraints in content campaigns.
metrics.conversion_last_conversion_dateConversion last conversion dateDate of the last conversion.
metrics.conversion_last_received_request_date_timeConversion last received request date timeDate and time of the last received conversion request.
metrics.conversionsConversionsNumber of conversions.
metrics.conversions_by_conversion_dateConversions by conversion dateNumber of conversions by conversion date.
metrics.conversions_from_interactions_rateConversions from interactions rateConversion rate from interactions.
metrics.conversions_from_interactions_value_per_interactionConversions from interactions value per interactionValue per interaction for conversions.
metrics.conversions_valueConversions valueTotal value of conversions.
metrics.conversions_value_by_conversion_dateConversions value by conversion dateTotal value of conversions by conversion date.
metrics.conversions_value_per_costConversions value per costValue per cost for conversions.
metrics.cost_microsCost microsTotal cost in micros.
metrics.cost_of_goods_sold_microsCost of goods sold microsCost of goods sold in micros.
metrics.cost_per_all_conversionsCost per all conversionsCost per all conversions.
metrics.cost_per_conversionCost per conversionCost per conversion.
metrics.cost_per_current_model_attributed_conversionCost per current model attributed conversionCost per conversion attributed to the current model.
metrics.cross_device_conversionsCross device conversionsNumber of conversions that occur across devices.
metrics.cross_device_conversions_value_microsCross device conversions value microsValue of cross-device conversions in micros.
metrics.cross_sell_cost_of_goods_sold_microsCross sell cost of goods sold microsCost of goods sold from cross-sell in micros.
metrics.cross_sell_gross_profit_microsCross sell gross profit microsGross profit from cross-sell in micros.
metrics.cross_sell_revenue_microsCross sell revenue microsRevenue from cross-sell in micros.
metrics.cross_sell_units_soldCross sell units soldNumber of units sold from cross-sell.
metrics.ctrCTRClick-through rate.
metrics.current_model_attributed_conversionsCurrent model attributed conversionsNumber of conversions attributed to the current model.
metrics.current_model_attributed_conversions_from_interactions_rateCurrent model attributed conversions from interactions rateConversion rate from interactions attributed to the current model.
metrics.current_model_attributed_conversions_from_interactions_value_per_interactionCurrent model attributed conversions from interactions value per interactionValue per interaction for conversions attributed to the current model.
metrics.current_model_attributed_conversions_valueCurrent model attributed conversions valueTotal value of conversions attributed to the current model.
metrics.current_model_attributed_conversions_value_per_costCurrent model attributed conversions value per costValue per cost for conversions attributed to the current model.
metrics.eligible_impressions_from_location_asset_store_reachEligible impressions from location asset store reachNumber of eligible impressions from location asset store reach.
metrics.engagement_rateEngagement rateRate of engagements.
metrics.engagementsEngagementsNumber of engagements.
metrics.gmail_forwardsGmail forwardsNumber of Gmail forwards.
metrics.gmail_savesGmail savesNumber of Gmail saves.
metrics.gmail_secondary_clicksGmail secondary clicksNumber of secondary clicks in Gmail.
metrics.gross_profit_marginGross profit marginGross profit margin percentage.
metrics.gross_profit_microsGross profit microsGross profit in micros.
metrics.historical_creative_quality_scoreHistorical creative quality scoreHistorical quality score of the creative.
metrics.historical_landing_page_quality_scoreHistorical landing page quality scoreHistorical quality score of the landing page.
metrics.historical_quality_scoreHistorical quality scoreHistorical quality score.
metrics.historical_search_predicted_ctrHistorical search predicted CTRHistorical predicted click-through rate for search.
metrics.hotel_average_lead_value_microsHotel average lead value microsAverage lead value for hotels in micros.
metrics.hotel_commission_rate_microsHotel commission rate microsCommission rate for hotels in micros.
metrics.hotel_eligible_impressionsHotel eligible impressionsNumber of eligible impressions for hotels.
metrics.hotel_expected_commission_costHotel expected commission costExpected commission cost for hotels.
metrics.hotel_price_difference_percentageHotel price difference percentagePercentage difference in hotel prices.
metrics.impressionsImpressionsNumber of impressions.
metrics.impressions_from_store_reachImpressions from store reachNumber of impressions from store reach.
metrics.interaction_event_typesInteraction event typesTypes of interaction events.
metrics.interaction_rateInteraction rateRate of interactions.
metrics.interactionsInteractionsNumber of interactions.
metrics.invalid_click_rateInvalid click rateRate of invalid clicks.
metrics.invalid_clicksInvalid clicksNumber of invalid clicks.
metrics.lead_cost_of_goods_sold_microsLead cost of goods sold microsCost of goods sold for leads in micros.
metrics.lead_gross_profit_microsLead gross profit microsGross profit from leads in micros.
metrics.lead_revenue_microsLead revenue microsRevenue from leads in micros.
metrics.lead_units_soldLead units soldNumber of units sold from leads.
metrics.message_chat_rateMessage chat rateRate of message chats.
metrics.message_chatsMessage chatsNumber of message chats.
metrics.message_impressionsMessage impressionsNumber of message impressions.
metrics.mobile_friendly_clicks_percentageMobile friendly clicks percentagePercentage of clicks that are mobile-friendly.
metrics.new_customer_lifetime_valueNew customer lifetime valueLifetime value of new customers.
metrics.optimization_score_upliftOptimization score upliftUplift in optimization score.
metrics.optimization_score_urlOptimization score URLURL for optimization score.
metrics.ordersOrdersNumber of orders.
metrics.organic_clicksOrganic clicksNumber of organic clicks.
metrics.organic_clicks_per_queryOrganic clicks per queryAverage number of organic clicks per query.
metrics.organic_impressionsOrganic impressionsNumber of organic impressions.
metrics.organic_impressions_per_queryOrganic impressions per queryAverage number of organic impressions per query.
metrics.organic_queriesOrganic queriesNumber of organic queries.
metrics.percent_new_visitorsPercent new visitorsPercentage of new visitors.
metrics.phone_callsPhone callsNumber of phone calls.
metrics.phone_impressionsPhone impressionsNumber of phone impressions.
metrics.phone_through_ratePhone through rateRate of phone throughs.
metrics.publisher_organic_clicksPublisher organic clicksNumber of organic clicks from publishers.
metrics.publisher_purchased_clicksPublisher purchased clicksNumber of purchased clicks from publishers.
metrics.publisher_unknown_clicksPublisher unknown clicksNumber of unknown clicks from publishers.
metrics.relative_ctrRelative CTRRelative click-through rate.
metrics.revenue_microsRevenue microsRevenue in micros.
metrics.search_absolute_top_impression_shareSearch absolute top impression shareShare of impressions at the absolute top of search results.
metrics.search_budget_lost_absolute_top_impression_shareSearch budget lost absolute top impression sharePercentage of absolute top impressions lost due to budget constraints.
metrics.search_budget_lost_impression_shareSearch budget lost impression sharePercentage of impressions lost due to budget constraints.
metrics.search_budget_lost_top_impression_shareSearch budget lost top impression sharePercentage of top impressions lost due to budget constraints.
metrics.search_click_shareSearch click shareShare of clicks in search results.
metrics.search_exact_match_impression_shareSearch exact match impression shareShare of exact match impressions in search results.
metrics.search_impression_shareSearch impression shareShare of impressions in search results.
metrics.search_rank_lost_absolute_top_impression_shareSearch rank lost absolute top impression sharePercentage of absolute top impressions lost due to rank constraints.
metrics.search_rank_lost_impression_shareSearch rank lost impression sharePercentage of impressions lost due to rank constraints.
metrics.search_rank_lost_top_impression_shareSearch rank lost top impression sharePercentage of top impressions lost due to rank constraints.
metrics.search_top_impression_shareSearch top impression shareShare of top impressions in search results.
metrics.search_volumeSearch volumeVolume of searches.
metrics.sk_ad_network_installsSk ad network installsNumber of installs from SKAdNetwork.
metrics.sk_ad_network_total_conversionsSk ad network total conversionsTotal number of conversions from SKAdNetwork.
metrics.speed_scoreSpeed scoreScore representing the speed of your site.
metrics.top_impression_percentageTop impression percentagePercentage of impressions that are shown at the top of the search results page.
### Dimensions Dimensions are attributes that describe and segment your data, allowing users to break down metrics and analyze them in more detail. | Tag | Name | Description | | --------------------------------------------------------------------------- | ---------------------------------------------------------- | --------------------------------------------------------------------------- | | `customer.auto_tagging_enabled` | Account auto tagging enabled | Whether auto-tagging is enabled for the account. | | `customer.call_reporting_setting.call_conversion_action` | Account conversion action (Call Reporting) | The conversion action associated with call reporting for the account. | | `customer.call_reporting_setting.call_conversion_reporting_enabled` | Account Conversion Reporting Enabled (Call Reporting) | Whether call conversion reporting is enabled for the account. | | `customer.call_reporting_setting.call_reporting_enabled` | Account Reporting Enabled (Call Reporting) | Whether call reporting is enabled for the account. | | `customer.conversion_tracking_setting.accepted_customer_data_terms` | Account Customer Data terms | Whether the account has accepted the customer data terms. | | `customer.conversion_tracking_setting.conversion_tracking_id` | Account Conversion ID | The conversion tracking ID for the account. | | `customer.conversion_tracking_setting.conversion_tracking_status` | Account Conversion Tracking Status | The conversion tracking status for the account. | | `customer.conversion_tracking_setting.cross_account_conversion_tracking_id` | Account Conversion Tracking ID | The cross-account conversion tracking ID for the account. | | `customer.currency_code` | Account Currency code | The currency code for the account. | | `customer.descriptive_name` | Account Name | The descriptive name of the account. | | `customer.final_url_suffix` | Account Final Url Suffix | The final URL suffix for the account. | | `customer.has_partners_badge` | Account has partner badge | Whether the account has a partner badge. | | `customer.id` | Account ID | The ID of the account. | | `customer.manager` | Account (is MCC) | Whether the account is an MCC account. | | `customer.optimization_score` | Account optimization score | The optimization score for the account. | | `customer.optimization_score_weight` | Account optimization score weight | The weight of the optimization score for the account. | | `customer.remarketing_setting.google_global_site_tag` | Account global site tag | The global site tag for the account. | | `customer.status` | Account status | The status of the account. | | `customer.tracking_url_template` | Account tracking url template | The tracking URL template for the account. | | `customer.time_zone` | Account timezone | The time zone for the account. | | `segments.ad_network_type` | Ad network type | The type of ad network. | | `segments.click_type` | Click type | The type of click. | | `segments.conversion_action` | Conversion action | The conversion action. | | `segments.conversion_action_category` | Conversion action category | The category of the conversion action. | | `segments.conversion_action_name` | Conversion action name | The name of the conversion action. | | `segments.conversion_adjustment` | Conversion adjustment | The conversion adjustment. | | `segments.conversion_lag_bucket` | Conversion lag bucket | The conversion lag bucket. | | `segments.conversion_or_adjustment_lag_bucket` | Conversion or adjustment lag bucket | The conversion or adjustment lag bucket. | | `segments.conversion_value_rule_primary_dimension` | Conversion value rule primary dimension | The primary dimension of the conversion value rule. | | `segments.date` | Date | The date. | | `segments.day_of_week` | Day of week | The day of the week. | | `segments.device` | Device | The device. | | `segments.external_conversion_source` | External conversion source | The external conversion source. | | `segments.hour` | Hour | The hour. | | `segments.month` | Month | The month. | | `segments.month_of_year` | Month of year | The month of the year. | | `segments.quarter` | Quarter | The quarter. | | `segments.recommendation_type` | Recommendation type | The type of recommendation. | | `segments.sk_ad_network_ad_event_type` | Sk ad network ad event type | The type of ad event in the SK ad network. | | `segments.sk_ad_network_fine_conversion_value` | Sk ad network conversion value | The conversion value in the SK ad network. | | `segments.sk_ad_network_source_app.sk_ad_network_source_app_id` | Sk network source app ID | The ID of the source app in the SK ad network. | | `segments.sk_ad_network_user_type` | Sk ad network user type | The type of user in the SK ad network. | | `segments.slot` | Slot | The slot. | | `segments.week` | Week | The week. | | `segments.year` | Year | The year. | | `campaign.accessible_bidding_strategy` | Campaign Accessible bidding strategy | The accessible bidding strategy for the campaign. | | `campaign.ad_serving_optimization_status` | Campaign Ad serving optimization status | The ad serving optimization status for the campaign. | | `campaign.advertising_channel_sub_type` | Campaign Advertising channel sub type | The advertising channel sub type for the campaign. | | `campaign.advertising_channel_type` | Campaign Advertising channel type | The advertising channel type for the campaign. | | `campaign.app_campaign_setting.app_id` | Campaign app ID | The app ID for the campaign. | | `campaign.app_campaign_setting.app_store` | Campaign app store | The app store for the campaign. | | `campaign.app_campaign_setting.bidding_strategy_goal_type` | Campaign app bidding strategy goal type | The bidding strategy goal type for the campaign. | | `campaign.audience_setting.use_audience_grouped` | Campaign use audience grouped | Whether the campaign uses audience grouped. | | `campaign.base_campaign` | Campaign Base campaign | The base campaign for the campaign. | | `campaign.bidding_strategy` | Campaign Bidding strategy | The bidding strategy for the campaign. | | `campaign.bidding_strategy_type` | Campaign Bidding strategy type | The bidding strategy type for the campaign. | | `campaign.campaign_budget` | Campaign budget | The budget for the campaign. | | `campaign.commission.commission_rate_micros` | Campaign commission rate | The commission rate for the campaign. | | `campaign.dynamic_search_ads_setting.domain_name` | Campaign Dynamic search ads domain name | The domain name for dynamic search ads for the campaign. | | `campaign.dynamic_search_ads_setting.feeds` | Campaign Dynamic search ads feeds | The feeds for dynamic search ads for the campaign. | | `campaign.dynamic_search_ads_setting.language_code` | Campaign Dynamic search ads language code | The language code for dynamic search ads for the campaign. | | `campaign.dynamic_search_ads_setting.use_supplied_urls_only` | Campaign Dynamic search ads use supplied urls only | Whether dynamic search ads for the campaign use supplied URLs only. | | `campaign.end_date` | Campaign End date | The end date for the campaign. | | `campaign.excluded_parent_asset_field_types` | Campaign Excluded parent asset field types | The excluded parent asset field types for the campaign. | | `campaign.experiment_type` | Campaign Experiment type | The experiment type for the campaign. | | `campaign.final_url_suffix` | Campaign Final url suffix | The final URL suffix for the campaign. | | `campaign.frequency_caps` | Campaign Frequency caps | The frequency caps for the campaign. | | `campaign.geo_target_type_setting.negative_geo_target_type` | Campaign negative geo target type | The negative geo target type for the campaign. | | `campaign.geo_target_type_setting.positive_geo_target_type` | Campaign positive geo target type | The positive geo target type for the campaign. | | `campaign.hotel_setting.hotel_center_id` | Campaign hotel center ID | The hotel center ID for the campaign. | | `campaign.id` | Campaign ID | The ID of the campaign. | | `campaign.labels` | Campaign Labels | The labels for the campaign. | | `campaign.local_campaign_setting.location_source_type` | Campaign Local campaign location source type | The location source type for the campaign. | | `campaign.manual_cpc.enhanced_cpc_enabled` | Campaign enhanced CPC enabled | Whether enhanced CPC is enabled for the campaign. | | `campaign.manual_cpm` | Campaign Manual cpm | The manual CPM for the campaign. | | `campaign.manual_cpv` | Campaign Manual cpv | The manual CPV for the campaign. | | `campaign.maximize_conversion_value.target_roas` | Campaign Maximize conversion value target roas | The target ROAS for maximize conversion value for the campaign. | | `campaign.maximize_conversions.target_cpa` | Campaign Maximize conversions.target cpa | The target CPA for maximize conversions for the campaign. | | `campaign.name` | Campaign Name | The name of the campaign. | | `campaign.network_settings.target_content_network` | Campaign Network target content network | Whether the campaign targets the content network. | | `campaign.network_settings.target_google_search` | Campaign Network target google search | Whether the campaign targets Google search. | | `campaign.network_settings.target_partner_search_network` | Campaign Network target partner search network | Whether the campaign targets the partner search network. | | `campaign.network_settings.target_search_network` | Campaign Network settings.target search network | Whether the campaign targets the search network. | | `campaign.optimization_goal_setting.optimization_goal_types` | Campaign optimization goal types | The optimization goal types for the campaign. | | `campaign.optimization_score` | Campaign Optimization score | The optimization score for the campaign. | | `campaign.payment_mode` | Campaign Payment mode | The payment mode for the campaign. | | `campaign.percent_cpc.cpc_bid_ceiling_micros` | Campaign CPC bid ceiling | The CPC bid ceiling for the campaign. | | `campaign.percent_cpc.enhanced_cpc_enabled` | Campaign enhanced CPC enabled | Whether enhanced CPC is enabled for the campaign. | | `campaign.real_time_bidding_setting.opt_in` | Campaign Real time bidding opt in | Whether real-time bidding is opted in for the campaign. | | `campaign.resource_name` | Campaign Resource name | The resource name for the campaign. | | `campaign.selective_optimization.conversion_actions` | Campaign Selective optimization conversion actions | The selective optimization conversion actions for the campaign. | | `campaign.serving_status` | Campaign Serving status | The serving status for the campaign. | | `campaign.shopping_setting.campaign_priority` | Campaign Shopping campaign priority | The campaign priority for shopping for the campaign. | | `campaign.shopping_setting.enable_local` | Campaign Shopping enable local | Whether shopping enable local for the campaign. | | `campaign.shopping_setting.merchant_id` | Campaign Shopping merchant ID | The merchant ID for shopping for the campaign. | | `campaign.shopping_setting.sales_country` | Campaign Shopping sales country | The sales country for shopping for the campaign. | | `campaign.shopping_setting.use_vehicle_inventory` | Campaign Shopping use vehicle inventory | Whether shopping use vehicle inventory for the campaign. | | `campaign.start_date` | Campaign Start date | The start date for the campaign. | | `campaign.status` | Campaign Status | The status for the campaign. | | `campaign.target_cpa.cpc_bid_ceiling_micros` | Campaign Target cpa/cpc bid ceiling | The CPC bid ceiling for target CPA for the campaign. | | `campaign.target_cpa.cpc_bid_floor_micros` | Campaign Target cpa/cpc bid floor | The CPC bid floor for target CPA for the campaign. | | `campaign.target_cpa.target_cpa_micros` | Campaign Target cpa | The target CPA for the campaign. | | `campaign.target_cpm` | Campaign Target cpm | The target CPM for the campaign. | | `campaign.target_impression_share.cpc_bid_ceiling_micros` | Campaign Target impression share CPC bid ceiling | The CPC bid ceiling for target impression share for the campaign. | | `campaign.target_impression_share.location` | Campaign Target impression share location | The location for target impression share for the campaign. | | `campaign.target_impression_share.location_fraction_micros` | Campaign Target impression share location fraction | The location fraction for target impression share for the campaign. | | `campaign.target_roas.cpc_bid_ceiling_micros` | Campaign Target roas/cpc bid ceiling | The CPC bid ceiling for target ROAS for the campaign. | | `campaign.target_roas.cpc_bid_floor_micros` | Campaign Target roas/cpc bid floor | The CPC bid floor for target ROAS for the campaign. | | `campaign.target_roas.target_roas` | Campaign Target roas.target roas | The target ROAS for the campaign. | | `campaign.target_spend.cpc_bid_ceiling_micros` | Campaign Target spend/cpc bid ceiling | The CPC bid ceiling for target spend for the campaign. | | `campaign.target_spend.target_spend_micros` | Campaign Target spend | The target spend for the campaign. | | `campaign.targeting_setting.target_restrictions` | Campaign Targeting restrictions | The targeting restrictions for the campaign. | | `campaign.tracking_setting.tracking_url` | Campaign tracking url | The tracking URL for the campaign. | | `campaign.tracking_url_template` | Campaign Tracking url template | The tracking URL template for the campaign. | | `campaign.url_custom_parameters` | Campaign Url custom parameters | The URL custom parameters for the campaign. | | `campaign.url_expansion_opt_out` | Campaign Url expansion opt out | Whether URL expansion opt out for the campaign. | | `campaign.vanity_pharma.vanity_pharma_display_url_mode` | Campaign vanity pharma display url mode | The vanity pharma display URL mode for the campaign. | | `campaign.vanity_pharma.vanity_pharma_text` | Campaign vanity pharma text | The vanity pharma text for the campaign. | | `campaign.video_brand_safety_suitability` | Campaign Video brand safety suitability | The video brand safety suitability for the campaign. | | `segments.ad_destination_type` | Ad destination type | The type of ad destination. | | `segments.conversion_attribution_event_type` | Conversion attribution event type | The type of conversion attribution event. | | `bidding_strategy.campaign_count` | Bidding strategy campaign count | The number of campaigns for the bidding strategy. | | `bidding_strategy.currency_code` | Bidding strategy currency code | The currency code for the bidding strategy. | | `bidding_strategy.effective_currency_code` | Bidding strategy effective currency code | The effective currency code for the bidding strategy. | | `bidding_strategy.enhanced_cpc` | Bidding strategy enhanced cpc | Whether enhanced CPC is enabled for the bidding strategy. | | `bidding_strategy.id` | Bidding strategy ID | The ID of the bidding strategy. | | `bidding_strategy.maximize_conversion_value.cpc_bid_ceiling_micros` | Bidding strategy maximize conversion value CPC bid ceiling | The CPC bid ceiling for maximize conversion value for the bidding strategy. | | `bidding_strategy.maximize_conversion_value.cpc_bid_floor_micros` | Bidding strategy maximize conversion value CPC bid floor | The CPC bid floor for maximize conversion value for the bidding strategy. | | `bidding_strategy.maximize_conversion_value.target_roas` | Bidding strategy maximize conversion value target roas | The target ROAS for maximize conversion value for the bidding strategy. | | `bidding_strategy.maximize_conversions.cpc_bid_ceiling_micros` | Bidding strategy maximize conversions CPC bid ceiling | The CPC bid ceiling for maximize conversions for the bidding strategy. | | `bidding_strategy.maximize_conversions.cpc_bid_floor_micros` | Bidding strategy maximize conversions.cpc bid floor | The CPC bid floor for maximize conversions for the bidding strategy. | | `bidding_strategy.maximize_conversions.target_cpa` | Bidding strategy maximize conversions target cpa | The target CPA for maximize conversions for the bidding strategy. | | `bidding_strategy.name` | Bidding strategy name | The name of the bidding strategy. | | `bidding_strategy.non_removed_campaign_count` | Bidding strategy non removed campaign count | The number of non-removed campaigns for the bidding strategy. | | `bidding_strategy.resource_name` | Bidding strategy resource name | The resource name for the bidding strategy. | | `bidding_strategy.status` | Bidding strategy status | The status of the bidding strategy. | | `bidding_strategy.target_cpa.cpc_bid_ceiling_micros` | Bidding strategy target cpa/cpc bid ceiling | The CPC bid ceiling for target CPA for the bidding strategy. | | `bidding_strategy.target_cpa.cpc_bid_floor_micros` | Bidding strategy target cpa.cpc bid floor | The CPC bid floor for target CPA for the bidding strategy. | | `bidding_strategy.target_cpa.target_cpa_micros` | Bidding strategy target cpa.target cpa | The target CPA for the bidding strategy. | | `bidding_strategy.target_impression_share.cpc_bid_ceiling_micros` | Bidding strategy target impression | | | Tag | Name | Description | | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `bidding_strategy.target_impression_share.location` | Bidding strategy target impression share location | The location for the target impression share bidding strategy. | | `bidding_strategy.target_impression_share.location_fraction_micros` | Bidding strategy target impression share location fraction | The location fraction for the target impression share bidding strategy. | | `bidding_strategy.target_roas.cpc_bid_ceiling_micros` | Bidding strategy target roas/cpc bid ceiling | The CPC bid ceiling for the target ROAS bidding strategy. | | `bidding_strategy.target_roas.cpc_bid_floor_micros` | Bidding strategy target roas/cpc bid floor | The CPC bid floor for the target ROAS bidding strategy. | | `bidding_strategy.target_roas.target_roas` | Bidding strategy target roas.target roas | The target ROAS for the bidding strategy. | | `bidding_strategy.target_spend.cpc_bid_ceiling_micros` | Bidding strategy target spend/cpc bid ceiling | The CPC bid ceiling for the target spend bidding strategy. | | `bidding_strategy.target_spend.target_spend_micros` | Bidding strategy target spend | The target spend for the bidding strategy. | | `bidding_strategy.type` | Bidding strategy type | The type of the bidding strategy. | | `campaign_budget.amount_micros` | Campaign budget amount | The amount of the campaign budget. | | `campaign_budget.delivery_method` | Campaign budget delivery method | The delivery method of the campaign budget. | | `campaign_budget.explicitly_shared` | Campaign budget explicitly shared | Whether the campaign budget is explicitly shared. | | `campaign_budget.has_recommended_budget` | Campaign budget has recommended budget | Whether the campaign budget has a recommended budget. | | `campaign_budget.id` | Campaign budget ID | The ID of the campaign budget. | | `campaign_budget.name` | Campaign budget name | The name of the campaign budget. | | `campaign_budget.period` | Campaign budget period | The period of the campaign budget. | | `campaign_budget.recommended_budget_amount_micros` | Campaign budget recommended budget amount | The recommended budget amount of the campaign budget. | | `campaign_budget.recommended_budget_estimated_change_weekly_clicks` | Campaign budget recommended budget estimated change weekly clicks | The estimated change in weekly clicks for the recommended budget of the campaign budget. | | `campaign_budget.recommended_budget_estimated_change_weekly_cost_micros` | Campaign budget recommended budget estimated change weekly cost | The estimated change in weekly cost for the recommended budget of the campaign budget. | | `campaign_budget.recommended_budget_estimated_change_weekly_interactions` | Campaign budget recommended budget estimated change weekly interactions | The estimated change in weekly interactions for the recommended budget of the campaign budget. | | `campaign_budget.recommended_budget_estimated_change_weekly_views` | Campaign budget recommended budget estimated change weekly views | The estimated change in weekly views for the recommended budget of the campaign budget. | | `campaign_budget.reference_count` | Campaign budget reference count | The reference count of the campaign budget. | | `campaign_budget.resource_name` | Campaign budget resource name | The resource name of the campaign budget. | | `campaign_budget.status` | Campaign budget status | The status of the campaign budget. | | `campaign_budget.total_amount_micros` | Campaign budget total amount micros | The total amount of the campaign budget in micros. | | `campaign_budget.type` | Campaign budget type | The type of the campaign budget. | | `campaign_criterion.ad_schedule.day_of_week` | Campaign ad schedule day of week | The day of the week for the campaign ad schedule. | | `campaign_criterion.ad_schedule.end_hour` | Campaign ad schedule end hour | The end hour for the campaign ad schedule. | | `campaign_criterion.ad_schedule.end_minute` | Campaign ad schedule end minute | The end minute for the campaign ad schedule. | | `campaign_criterion.ad_schedule.start_hour` | Campaign ad schedule start hour | The start hour for the campaign ad schedule. | | `campaign_criterion.ad_schedule.start_minute` | Campaign ad schedule.start minute | The start minute for the campaign ad schedule. | | `campaign_criterion.age_range.type` | Campaign age range | The age range for the campaign. | | `campaign_criterion.bid_modifier` | Campaign bid modifier | The bid modifier for the campaign. | | `campaign_criterion.carrier.carrier_constant` | Campaign carrier constant | The carrier constant for the campaign. | | `campaign_criterion.combined_audience.combined_audience` | Campaign combined audience | The combined audience for the campaign. | | `campaign_criterion.content_label.type` | Campaign content label | The content label for the campaign. | | `campaign_criterion.custom_affinity.custom_affinity` | Campaign custom affinity | The custom affinity for the campaign. | | `campaign_criterion.custom_audience.custom_audience` | Campaign custom audience | The custom audience for the campaign. | | `campaign_criterion.device.type` | Campaign device | The device for the campaign. | | `campaign_criterion.gender.type` | Campaign gender | The gender for the campaign. | | `campaign_criterion.income_range.type` | Campaign income range | The income range for the campaign. | | `campaign_criterion.ip_block.ip_address` | Campaign ip block address | The IP block address for the campaign. | | `campaign_criterion.keyword.match_type` | Campaign keyword match type | The keyword match type for the campaign. | | `campaign_criterion.keyword.text` | Campaign keyword text | The keyword text for the campaign. | | `campaign_criterion.keyword_theme.free_form_keyword_theme` | Campaign free form keyword theme | The free form keyword theme for the campaign. | | `campaign_criterion.keyword_theme.keyword_theme_constant` | Campaign keyword theme constant | The keyword theme constant for the campaign. | | `campaign_criterion.language.language_constant` | Campaign language constant | The language constant for the campaign. | | `campaign_criterion.listing_scope.dimensions` | Campaign listing scope | The listing scope for the campaign. | | `campaign_criterion.location.geo_target_constant` | Campaign geo target constant | The geo target constant for the campaign. | | `campaign_criterion.location_group` | Campaign location group | The location group for the campaign. | | `campaign_criterion.location_group.feed` | Campaign location group.feed | The feed for the location group for the campaign. | | `campaign_criterion.mobile_app_category.mobile_app_category_constant` | Campaign mobile app category constant | The mobile app category constant for the campaign. | | `campaign_criterion.mobile_application.app_id` | Campaign mobile app ID | The mobile app ID for the campaign. | | `campaign_criterion.mobile_application.name` | Campaign mobile application name | The mobile application name for the campaign. | | `campaign_criterion.mobile_device.mobile_device_constant` | Campaign mobile device constant | The mobile device constant for the campaign. | | `campaign_criterion.operating_system_version.operating_system_version_constant` | Campaign operating system version constant | The operating system version constant for the campaign. | | `campaign_criterion.parental_status.type` | Campaign parental status | The parental status for the campaign. | | `campaign_criterion.placement.url` | Campaign placement url | The placement URL for the campaign. | | `campaign_criterion.proximity.address.city_name` | Campaign proximity address city name | The city name for the proximity address for the campaign. | | `campaign_criterion.proximity.address.country_code` | Campaign proximity address country code | The country code for the proximity address for the campaign. | | `campaign_criterion.proximity.address.postal_code` | Campaign proximity address postal code | The postal code for the proximity address for the campaign. | | `campaign_criterion.proximity.address.province_code` | Campaign proximity address province code | The province code for the proximity address for the campaign. | | `campaign_criterion.proximity.address.province_name` | Campaign proximity address province name | The province name for the proximity address for the campaign. | | `campaign_criterion.proximity.address.street_address` | Campaign proximity address street address | The street address for the proximity address for the campaign. | | `campaign_criterion.proximity.geo_point.latitude_in_micro_degrees` | Campaign proximity geo latitude in micro degrees | The latitude in micro degrees for the proximity geo point for the campaign. | | `campaign_criterion.proximity.geo_point.longitude_in_micro_degrees` | Campaign proximity geo longitude in micro degrees | The longitude in micro degrees for the proximity geo point for the campaign. | | `campaign_criterion.proximity.radius` | Campaign proximity.radius | The radius for the proximity for the campaign. | | `campaign_criterion.proximity.radius_units` | Campaign proximity radius units | The radius units for the proximity for the campaign. | | `campaign_criterion.topic.path` | Campaign topic path | The topic path for the campaign. | | `campaign_criterion.topic.topic_constant` | Campaign topic constant | The topic constant for the campaign. | | `campaign_criterion.user_interest.user_interest_category` | Campaign user interest category | The user interest category for the campaign. | | `campaign_criterion.user_list.user_list` | Campaign user list | The user list for the campaign. | | `campaign_criterion.webpage.conditions` | Campaign webpage conditions | The webpage conditions for the campaign. | | `campaign_criterion.webpage.coverage_percentage` | Campaign webpage coverage percentage | The webpage coverage percentage for the campaign. | | `campaign_criterion.webpage.sample.sample_urls` | Campaign webpage sample urls | The sample URLs for the webpage for the campaign. | | `campaign_criterion.youtube_channel.channel_id` | Campaign youtube channel ID | The YouTube channel ID for the campaign. | | `campaign_criterion.youtube_video.video_id` | Campaign youtube video ID | The YouTube video ID for the campaign. | | `ad_group.ad_rotation_mode` | Ad group ad rotation mode | The ad rotation mode for the ad group. | | `ad_group.audience_setting.use_audience_grouped` | Ad group audience setting use audience grouped | Whether the ad group audience setting uses audience grouped. | | `ad_group.base_ad_group` | Ad group base name | The base name of the ad group. | | `ad_group.cpc_bid_micros` | Ad group CPC bid | The CPC bid for the ad group in micros. | | `ad_group.cpm_bid_micros` | Ad group cpm bid | The CPM bid for the ad group in micros. | | `ad_group.cpv_bid_micros` | Ad group cpv bid | The CPV bid for the ad group in micros. | | `ad_group.display_custom_bid_dimension` | Ad group display custom bid | The display custom bid for the ad group. | | `ad_group.effective_cpc_bid_micros` | Ad group effective CPC bid micros | The effective CPC bid for the ad group in micros. | | `ad_group.effective_target_cpa_micros` | Ad group effective target cpa micros | The effective target CPA for the ad group in micros. | | `ad_group.effective_target_cpa_source` | Ad group effective target cpa source | The source of the effective target CPA for the ad group. | | `ad_group.effective_target_roas` | Ad group effective target roas | The effective target ROAS for the ad group. | | `ad_group.effective_target_roas_source` | Ad group effective target roas source | The source of the effective target ROAS for the ad group. | | `ad_group.excluded_parent_asset_field_types` | Ad group excluded parent asset field types | The excluded parent asset field types for the ad group. | | `ad_group.explorer_auto_optimizer_setting.opt_in` | Ad group explorer auto optimizer setting.opt in | Whether the ad group explorer auto optimizer setting is opted in. | | `ad_group.final_url_suffix` | Ad group final url suffix | The final URL suffix for the ad group. | | `ad_group.id` | Ad group ID | The ID of the ad group. | | `ad_group.labels` | Ad group labels | The labels for the ad group. | | `ad_group.name` | Ad group name | The name of the ad group. | | `ad_group.percent_cpc_bid_micros` | Ad group percent CPC bid | The percent CPC bid for the ad group in micros. | | `ad_group.status` | Ad group status | The status of the ad group. | | `ad_group.target_cpa_micros` | Ad group target cpa | The target CPA for the ad group in micros. | | `ad_group.target_cpm_micros` | Ad group target cpm | The target CPM for the ad group in micros. | | `ad_group.target_roas` | Ad group target roas | The target ROAS for the ad group. | | `ad_group.targeting_setting.target_restrictions` | Ad group targeting setting.target restrictions | The target restrictions for the ad group targeting setting. | | `ad_group.tracking_url_template` | Ad group tracking url template | The tracking URL template for the ad group. | | `ad_group.type` | Ad group type | The type of the ad group. | | `ad_group.url_custom_parameters` | Ad group url custom parameters | The URL custom parameters for the ad group. | | `ad_group_ad.action_items` | Ad action items | The action items for the ad. | | `ad_group_ad.ad.added_by_google_ads` | Ads by google ads | Whether the ad was added by Google Ads. | | `ad_group_ad.ad.app_ad.descriptions` | Ad descriptions (App) | The descriptions for the app ad. | | `ad_group_ad.ad.app_ad.headlines` | Ad headlines (App) | The headlines for the app ad. | | `ad_group_ad.ad.app_ad.html5_media_bundles` | Ad html5 media bundles (App) | The HTML5 media bundles for the app ad. | | `ad_group_ad.ad.app_ad.images` | Ad images (App) | The images for the app ad. | | `ad_group_ad.ad.app_ad.mandatory_ad_text` | Ad mandatory ad text (App) | The mandatory ad text for the app ad. | | `ad_group_ad.ad.app_ad.youtube_videos` | Ad youtube videos (App) | The YouTube videos for the app ad. | | `ad_group_ad.ad.app_engagement_ad.descriptions` | Ad engagement ad descriptions (App) | The descriptions for the app engagement ad. | | `ad_group_ad.ad.app_engagement_ad.headlines` | Ad engagement ad.headlines (App) | The headlines for the app engagement ad. | | `ad_group_ad.ad.app_engagement_ad.images` | Ad engagement images (App) | The images for the app engagement ad. | | `ad_group_ad.ad.app_engagement_ad.videos` | Ad app engagement videos (App) | The videos for the app engagement ad. | | `ad_group_ad.ad.app_pre_registration_ad.descriptions` | Ad pre registration ad descriptions (App) | The descriptions for the app pre-registration ad. | | `ad_group_ad.ad.app_pre_registration_ad.headlines` | Ad pre registration ad headlines (App) | The headlines for the app pre-registration ad. | | `ad_group_ad.ad.app_pre_registration_ad.images` | Ad pre registration ad.images (App) | The images for the app pre-registration ad. | | `ad_group_ad.ad.app_pre_registration_ad.youtube_videos` | Ad pre registration ad youtube videos (App) | The YouTube videos for the app pre-registration ad. | | `ad_group_ad.ad.call_ad.business_name` | Ad business name (call ad) | The business name for the call ad. | | `ad_group_ad.ad.call_ad.call_tracked` | Ad tracked (call ad) | Whether the call ad is tracked. | | `ad_group_ad.ad.call_ad.conversion_action` | Ad conversion action (call ad) | The conversion action for the call ad. | | `ad_group_ad.ad.call_ad.conversion_reporting_state` | Ad conversion reporting state (call ad) | The conversion reporting state for the call ad. | | `ad_group_ad.ad.call_ad.country_code` | Ad country code (call ad) | The country code for the call ad. | | `ad_group_ad.ad.call_ad.description1` | Ad description1 (call ad) | The first description for the call ad. | | `ad_group_ad.ad.call_ad.description2` | Ad description2 (call ad) | The second description for the call ad. | | Tag | Name | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | `user_list.eligible_for_search` | Eligible for search | Whether the user list is eligible for search. | | `user_list.id` | Id | The ID of the user list. | | `user_list.integration_code` | Integration code | The integration code of the user list. | | `user_list.logical_user_list.rules` | Logical user list rules | The rules of the logical user list. | | `user_list.match_rate_percentage` | Match rate percentage | The match rate percentage of the user list. | | `user_list.membership_life_span` | Membership life span | The membership life span of the user list. | | `user_list.membership_status` | Membership status | The membership status of the user list. | | `user_list.name` | Name | The name of the user list. | | `user_list.read_only` | Read only | Whether the user list is read only. | | `user_list.resource_name` | Resource name | The resource name of the user list. | | `user_list.rule_based_user_list.combined_rule_user_list.left_operand.rule_item_groups` | Rule based user list combined rule user list left operand rule item groups | The rule item groups of the left operand of the combined rule user list. | | `user_list.rule_based_user_list.combined_rule_user_list.left_operand.rule_type` | Rule based user list combined rule user list left operand rule type | The rule type of the left operand of the combined rule user list. | | `user_list.rule_based_user_list.combined_rule_user_list.right_operand.rule_item_groups` | Rule based user list combined rule user list right operand rule item groups | The rule item groups of the right operand of the combined rule user list. | | `user_list.rule_based_user_list.combined_rule_user_list.right_operand.rule_type` | Rule based user list combined rule user list right operand rule type | The rule type of the right operand of the combined rule user list. | | `user_list.rule_based_user_list.combined_rule_user_list.rule_operator` | Rule based user list combined rule user list rule operator | The rule operator of the combined rule user list. | | `user_list.rule_based_user_list.date_specific_rule_user_list.end_date` | Rule based user list date specific rule user list end date | The end date of the date specific rule user list. | | `user_list.rule_based_user_list.date_specific_rule_user_list.rule.rule_item_groups` | Rule based user list date specific rule user list rule rule item groups | The rule item groups of the rule of the date specific rule user list. | | `user_list.rule_based_user_list.date_specific_rule_user_list.rule.rule_type` | Rule based user list date specific rule user list rule rule type | The rule type of the rule of the date specific rule user list. | | `user_list.rule_based_user_list.date_specific_rule_user_list.start_date` | Rule based user list date specific rule user list start date | The start date of the date specific rule user list. | | `user_list.rule_based_user_list.expression_rule_user_list.rule.rule_item_groups` | Rule based user list expression rule user list rule rule item groups | The rule item groups of the rule of the expression rule user list. | | `user_list.rule_based_user_list.expression_rule_user_list.rule.rule_type` | Rule based user list expression rule user list rule rule type | The rule type of the rule of the expression rule user list. | | `user_list.rule_based_user_list.prepopulation_status` | Rule based user list prepopulation status | The prepopulation status of the rule based user list. | | `user_list.similar_user_list.seed_user_list` | Similar user list seed user list | The seed user list of the similar user list. | | `user_list.size_for_display` | Size for display | The size of the user list for display. | | `user_list.size_for_search` | Size for search | The size of the user list for search. | | `user_list.size_range_for_display` | Size range for display | The size range of the user list for display. | | `user_list.size_range_for_search` | Size range for search | The size range of the user list for search. | | `user_list.type` | Type | The type of the user list. | | `segments.hotel_date_selection_type` | Hotel date selection type | The hotel date selection type. | | `dynamic_search_ads_search_term_view.has_matching_keyword` | Dynamic ads has matching keyword | Whether the dynamic search ads search term view has a matching keyword. | | `dynamic_search_ads_search_term_view.has_negative_keyword` | Dynamic ads has negative keyword | Whether the dynamic search ads search term view has a negative keyword. | | `dynamic_search_ads_search_term_view.has_negative_url` | Dynamic ads has negative url | Whether the dynamic search ads search term view has a negative URL. | | `dynamic_search_ads_search_term_view.headline` | Dynamic ads headline | The headline of the dynamic search ads search term view. | | `dynamic_search_ads_search_term_view.landing_page` | Dynamic ads landing page | The landing page of the dynamic search ads search term view. | | `dynamic_search_ads_search_term_view.page_url` | Dynamic ads page url | The page URL of the dynamic search ads search term view. | | `dynamic_search_ads_search_term_view.search_term` | Dynamic ads search term | The search term of the dynamic search ads search term view. | | `segments.webpage` | Webpage | The webpage. | | `segments.product_aggregator_id` | Product aggregator ID | The ID of the product aggregator. | | `segments.product_bidding_category_level1` | Product bidding category level1 | The first level of the product bidding category. | | `segments.product_bidding_category_level2` | Product bidding category level2 | The second level of the product bidding category. | | `segments.product_bidding_category_level3` | Product bidding category level3 | The third level of the product bidding category. | | `segments.product_bidding_category_level4` | Product bidding category level4 | The fourth level of the product bidding category. | | `segments.product_bidding_category_level5` | Product bidding category level5 | The fifth level of the product bidding category. | | `segments.product_brand` | Product brand | The brand of the product. | | `segments.product_channel` | Product channel | The channel of the product. | | `segments.product_channel_exclusivity` | Product channel exclusivity | The channel exclusivity of the product. | | `segments.product_condition` | Product condition | The condition of the product. | | `segments.product_country` | Product country | The country of the product. | | `segments.product_custom_attribute0` | Product custom attribute0 | The first custom attribute of the product. | | `segments.product_custom_attribute1` | Product custom attribute1 | The second custom attribute of the product. | | `segments.product_custom_attribute2` | Product custom attribute2 | The third custom attribute of the product. | | `segments.product_custom_attribute3` | Product custom attribute3 | The fourth custom attribute of the product. | | `segments.product_custom_attribute4` | Product custom attribute4 | The fifth custom attribute of the product. | | `segments.product_item_id` | Product item ID | The ID of the product item. | | `segments.product_language` | Product language | The language of the product. | | `segments.product_merchant_id` | Product merchant ID | The ID of the product merchant. | | `segments.product_store_id` | Product store ID | The ID of the product store. | | `segments.product_title` | Product title | The title of the product. | | `segments.product_type_l1` | Product type l1 | The first level of the product type. | | `segments.product_type_l2` | Product type l2 | The second level of the product type. | | `segments.product_type_l3` | Product type l3 | The third level of the product type. | | `segments.product_type_l4` | Product type l4 | The fourth level of the product type. | | `segments.product_type_l5` | Product type l5 | The fifth level of the product type. | | `search_term_view.search_term` | Search term | The search term. | | `search_term_view.status` | Search term status | The status of the search term. | | `segments.search_term_match_type` | Search term match type | The match type of the search term. | | `extension_feed_item.ad_schedules` | Extension ad schedules | The ad schedules for the extension feed item. | | `extension_feed_item.affiliate_location_feed_item.address_line_1` | Extension affiliate location feed item address line 1 | The first line of the address of the affiliate location feed item. | | `extension_feed_item.affiliate_location_feed_item.address_line_2` | Extension affiliate location feed item address line 2 | The second line of the address of the affiliate location feed item. | | `extension_feed_item.affiliate_location_feed_item.business_name` | Extension affiliate location feed item business name | The business name of the affiliate location feed item. | | `extension_feed_item.affiliate_location_feed_item.chain_id` | Extension affiliate location feed item chain ID | The chain ID of the affiliate location feed item. | | `extension_feed_item.affiliate_location_feed_item.chain_name` | Extension affiliate location feed item chain name | The chain name of the affiliate location feed item. | | `extension_feed_item.affiliate_location_feed_item.city` | Extension affiliate location feed item city | The city of the affiliate location feed item. | | `extension_feed_item.affiliate_location_feed_item.country_code` | Extension affiliate location feed item country code | The country code of the affiliate location feed item. | | `extension_feed_item.affiliate_location_feed_item.phone_number` | Extension affiliate location feed item phone number | The phone number of the affiliate location feed item. | | `extension_feed_item.affiliate_location_feed_item.postal_code` | Extension affiliate location feed item postal code | The postal code of the affiliate location feed item. | | `extension_feed_item.affiliate_location_feed_item.province` | Extension affiliate location feed item province | The province of the affiliate location feed item. | | `extension_feed_item.app_feed_item.app_id` | Extension app feed item app ID | The app ID of the app feed item. | | `extension_feed_item.app_feed_item.app_store` | Extension app feed item app store | The app store of the app feed item. | | `extension_feed_item.app_feed_item.final_mobile_urls` | Extension app feed item final mobile urls | The final mobile URLs of the app feed item. | | `extension_feed_item.app_feed_item.final_url_suffix` | Extension app feed item final url suffix | The final URL suffix of the app feed item. | | `extension_feed_item.app_feed_item.final_urls` | Extension app feed item final urls | The final URLs of the app feed item. | | `extension_feed_item.app_feed_item.link_text` | Extension app feed item link text | The link text of the app feed item. | | `extension_feed_item.app_feed_item.tracking_url_template` | Extension app feed item tracking url template | The tracking URL template of the app feed item. | | `extension_feed_item.call_feed_item.call_conversion_action` | Extension call feed item call conversion action | The call conversion action of the call feed item. | | `extension_feed_item.call_feed_item.call_conversion_reporting_state` | Extension call feed item call conversion reporting state | The call conversion reporting state of the call feed item. | | `extension_feed_item.call_feed_item.call_conversion_tracking_disabled` | Extension call feed item call conversion tracking disabled | Whether call conversion tracking is disabled for the call feed item. | | `extension_feed_item.call_feed_item.call_tracking_enabled` | Extension call feed item call tracking enabled | Whether call tracking is enabled for the call feed item. | | `extension_feed_item.call_feed_item.country_code` | Extension call feed item country code | The country code of the call feed item. | | `extension_feed_item.call_feed_item.phone_number` | Extension call feed item phone number | The phone number of the call feed item. | | `extension_feed_item.callout_feed_item.callout_text` | Extension callout feed item callout text | The callout text of the callout feed item. | | `extension_feed_item.device` | Extension device | The device of the extension feed item. | | `extension_feed_item.end_date_time` | Extension end date time | The end date and time of the extension feed item. | | `extension_feed_item.extension_type` | Extension extension type | The extension type of the extension feed item. | | `extension_feed_item.hotel_callout_feed_item.language_code` | Extension hotel callout feed item language code | The language code of the hotel callout feed item. | | `extension_feed_item.hotel_callout_feed_item.text` | Extension hotel callout feed item text | The text of the hotel callout feed item. | | `extension_feed_item.id` | Extension ID | The ID of the extension feed item. | | `extension_feed_item.image_feed_item.image_asset` | Extension image feed item image asset | The image asset of the image feed item. | | `extension_feed_item.location_feed_item.address_line_1` | Extension location feed item address line 1 | The first line of the address of the location feed item. | | `extension_feed_item.location_feed_item.address_line_2` | Extension location feed item address line 2 | The second line of the address of the location feed item. | | `extension_feed_item.location_feed_item.business_name` | Extension location feed item business name | The business name of the location feed item. | | `extension_feed_item.location_feed_item.city` | Extension location feed item city | The city of the location feed item. | | `extension_feed_item.location_feed_item.country_code` | Extension location feed item country code | The country code of the location feed item. | | `extension_feed_item.location_feed_item.phone_number` | Extension location feed item phone number | The phone number of the location feed item. | | `extension_feed_item.location_feed_item.postal_code` | Extension location feed item postal code | The postal code of the location feed item. | | `extension_feed_item.location_feed_item.province` | Extension location feed item province | The province of the location feed item. | | `extension_feed_item.price_feed_item.final_url_suffix` | Extension price feed item final url suffix | The final URL suffix of the price feed item. | | `extension_feed_item.price_feed_item.language_code` | Extension price feed item language code | The language code of the price feed item. | | `extension_feed_item.price_feed_item.price_offerings` | Extension price feed item price offerings | The price offerings of the price feed item. | | `extension_feed_item.price_feed_item.price_qualifier` | Extension price feed item price qualifier | The price qualifier of the price feed item. | | `extension_feed_item.price_feed_item.tracking_url_template` | Extension price feed item tracking url template | The tracking URL template of the price feed item. | | `extension_feed_item.price_feed_item.type` | Extension price feed item type | The type of the price feed item. | | `extension_feed_item.promotion_feed_item.discount_modifier` | Extension promotion feed item discount modifier | The discount modifier of the promotion feed item. | | `extension_feed_item.promotion_feed_item.final_mobile_urls` | Extension promotion feed item final mobile urls | The final mobile URLs of the promotion feed item. | | `extension_feed_item.promotion_feed_item.final_url_suffix` | Extension promotion feed item final url suffix | The final URL suffix of the promotion feed item. | | Tag | New | Description | | ------------------------------------------------------------------- | ---------------------------------------------- | -------------------------------------------------------------- | | `billing_setup.end_date_time` | Billing end date time | The end date and time of the billing setup. | | `billing_setup.end_time_type` | Billing end time type | The end time type of the billing setup. | | `billing_setup.id` | Billing ID | The ID of the billing setup. | | `billing_setup.payments_account` | Billing payments account | The payments account of the billing setup. | | `billing_setup.payments_account_info.payments_account_id` | Billing payments account ID | The ID of the payments account of the billing setup. | | `billing_setup.payments_account_info.payments_account_name` | Billing payments account name | The name of the payments account of the billing setup. | | `billing_setup.payments_account_info.payments_profile_id` | Billing payments profile ID | The ID of the payments profile of the billing setup. | | `billing_setup.payments_account_info.payments_profile_name` | Billing payments profile name | The name of the payments profile of the billing setup. | | `billing_setup.payments_account_info.secondary_payments_profile_id` | Billing payments secondary payments profile ID | The ID of the secondary payments profile of the billing setup. | | `billing_setup.resource_name` | Billing resource name | The resource name of the billing setup. | | `billing_setup.start_date_time` | Billing start date time | The start date and time of the billing setup. | | `billing_setup.status` | Billing status | The status of the billing setup. | # Google Analytics Google Analytics is a comprehensive web analytics service that provides insights into website traffic, user behavior, and conversions. It allows you to track how users find your website, what they do on your site, and whether they complete desired actions (like making a purchase or filling out a form). Understanding Google Analytics data is crucial for optimizing your website, improving user experience, and driving business results. {% hint style="warning" %} Please note that Uniquery only supports Google Analytics 4. Universal Analytics has been deprecated by Google and thus is not supported by us. {% endhint %} ### **How a Google Analytics Connection Works in Uniquery** Uniquery streamlines the process of accessing and analyzing your Google Analytics data directly within Google Sheets. Instead of manually exporting reports from the Google Analytics interface, Uniquery establishes a secure, direct connection to the Google Analytics Data API (for Google Analytics 4) using OAuth 2.0 authentication. This connection allows you to: * **Automate Data Retrieval:** Pull your Google Analytics data directly into your spreadsheets. * **Customize Reports:** Select specific metrics and dimensions to build reports tailored to your needs. * **Schedule Refreshes:** Keep your data up-to-date with automatic hourly, daily, or weekly refreshes. * **Combine Data Sources:** Integrate Google Analytics data with data from other marketing platforms (like LinkedIn Ads, Facebook Ads, etc.) for a holistic view of your marketing performance. All in one spread sheet. * Directly access the Google Analytics API and extract the response to Google Sheets. ### **Metrics** In Google Analytics, *metrics* are the quantitative measurements of user activity on your website. They provide the numerical data that shows how users are interacting with your site. | Tag | Name | Description | | ------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `active1DayUsers` | 1-day active users | The number of distinct users who visited your site or app in the last day. | | `active28DayUsers` | 28-day active users | The number of distinct users who visited your site or app in the last 28 days. | | `active7DayUsers` | 7-day active users | The number of distinct users who visited your site or app in the last 7 days. | | `activeUsers` | Active users | The number of distinct users who have engaged with your site or app in the current reporting period (varies depending on the report context, can be 1-day, 7-day, or 28-day active users). | | `adUnitExposure` | Ad unit exposure | The length of time users were exposed to ad units on your site or app (usually measured in seconds). Relevant if you monetize with ads. | | `addToCarts` | Add to carts | The number of times users added items to their shopping carts on your website or app. | | `advertiserAdClicks` | Ads clicks | The number of clicks on ads displayed on your site or app (if you're using a platform like AdSense). | | `advertiserAdCost` | Ads cost | The total cost of ads displayed on your site or app (if applicable). | | `advertiserAdCostPerClick` | Ads cost per click | The average cost you paid for each click on ads displayed on your site or app. | | `advertiserAdCostPerConversion` | Cost per conversion | The cost of advertising, divided by the number of conversions | | `advertiserAdImpressions` | Ads impressions | The number of impressions of advertisement. | | `averagePurchaseRevenue` | Average purchase revenue | The average revenue generated per transaction (calculated as `purchaseRevenue` / `transactions`). | | `averagePurchaseRevenuePerPayingUser` | ARPPU | The average revenue generated per *paying* user (calculated as `purchaseRevenue` / `totalPurchasers`). | | `averagePurchaseRevenuePerUser` | Average purchase revenue per user | The average revenue generated per *all* users (including non-paying users) (calculated as `purchaseRevenue` / `totalUsers`). | | `averageRevenuePerUser` | ARPU | The average revenue generated per user, including both ecommerce and ad revenue (calculated as `totalRevenue` / `totalUsers`). A key overall performance indicator. | | `averageSessionDuration` | Average session duration | The average length of time users spent on your site or app per session (usually measured in seconds). | | `bounceRate` | Bounce rate | The percentage of sessions in which users viewed only one page and then left your site without further interaction. A lower bounce rate is generally better. | | `cartToViewRate` | Cart-to-view rate | The percentage of product views that resulted in the product being added to the cart (calculated as `addToCarts` / `itemViewEvents`). A measure of how likely users are to add items to cart. | | `checkouts` | Checkouts | The number of times users initiated the checkout process on your website or app. | | `cohortActiveUsers` | Cohort active users | The number of active users within a specific cohort (a group of users acquired during the same time period). Used for cohort analysis. | | `cohortTotalUsers` | Cohort total users | The total number of users in a specific cohort. | | `conversions` | Conversions | The number of times users completed a desired action on your site or app (e.g., making a purchase, submitting a form, signing up for a newsletter). | | `crashAffectedUsers` | Crash-affected users | (For apps) The number of users who experienced a crash in your app. | | `crashFreeUsersRate` | Crash-free users rate | (For apps) The percentage of users who did *not* experience a crash in your app. | | `dauPerMau` | DAU / MAU | The ratio of daily active users (DAU) to monthly active users (MAU). A measure of user "stickiness." A higher ratio indicates that users are returning to your site or app frequently. | | `dauPerWau` | DAU / WAU | The ratio of daily active users (DAU) to weekly active users (WAU). Another measure of user stickiness. | | `ecommercePurchases` | Ecommerce purchases | The number of completed ecommerce transactions on your website or app. | | `engagedSessions` | Engaged sessions | The number of sessions that lasted longer than a specified threshold (usually 10 seconds) or included a conversion event or multiple pageviews. A measure of user engagement. | | `engagementRate` | Engagement rate | The percentage of sessions that were engaged sessions (calculated as `engagedSessions` / `sessions`). A higher engagement rate indicates that users are finding your content valuable and interactive. | | `eventCount` | Event count | The total number of events triggered on your site or app. Events are custom actions you track (e.g., button clicks, video plays, downloads). | | `eventCountPerUser` | Event count per user | The average number of events triggered per user (calculated as `eventCount` / `totalUsers`). | | `eventValue` | Event value | The sum of the values associated with events. You can assign values to events to represent their importance or monetary worth. | | `eventsPerSession` | Events per session | The average number of events triggered per session (calculated as `eventCount` / `sessions`). | | `firstTimePurchaserConversionRate` | First-time purchaser conversion | The percentage of users who made their *first* purchase on your site or app. | | `firstTimePurchasers` | First time purchasers | The number of users who made their first purchase on your site or app. | | `firstTimePurchasersPerNewUser` | First-time purchasers per new user | The number of first-time purchasers divided by the number of new users. | | `grossItemRevenue` | Gross item revenue | The total revenue generated from the sale of individual items, *before* any discounts, shipping, or taxes are applied. | | `grossPurchaseRevenue` | Gross purchase revenue | The total revenue generated from all purchases, *before* any refunds, shipping, or taxes are applied. | | `itemDiscountAmount` | Item discount amount | The total amount of discounts applied to individual items. | | `itemListClickEvents` | Item-list click events | The number of times users clicked on items within a product list (e.g., a category page, search results page). | | `itemListClickThroughRate` | Item list click through rate | The percentage of item list views that resulted in a click on an item (calculated as `itemListClickEvents` / `itemListViewEvents`). | | `itemListViewEvents` | Item-list view events | The number of times users viewed a product list. | | `itemPromotionClickThroughRate` | Item promotion click through rate | The percentage of item promotion views that resulted in a click on the promotion. | | `itemRefundAmount` | Item refund amount | The total amount of refunds issued for individual items. | | `itemRevenue` | Item revenue | The total revenue generated from the sale of individual items, *after* any discounts are applied (but before shipping and taxes). | | `itemViewEvents` | Item view events | The number of times users viewed a product detail page. | | `itemsAddedToCart` | Items added to cart | The total number of items added to shopping carts. | | `itemsCheckedOut` | Items checked out | The total number of items included in completed checkout processes. | | `itemsClickedInList` | Items clicked in list | The number of times individual items were clicked on within a product list. | | `itemsClickedInPromotion` | Items clicked in promotion | The number of times individual items were clicked on within a promotion. | | `itemsPurchased` | Items purchased | The total number of items purchased. | | `itemsViewed` | Items viewed | The total number of individual items viewed (on product detail pages). | | `itemsViewedInList` | Items viewed in list | The number of times individual items were viewed within a product list. | | `itemsViewedInPromotion` | Items viewed in promotion | The number of times individual items were viewed within a promotion. | | `newUsers` | New users | The number of users who visited your site or app for the *first* time. | | `organicGoogleSearchAveragePosition` | Organic Google Search average position | The average position of your website in Google Search results for organic (non-paid) searches. Requires integration with Google Search Console. | | `organicGoogleSearchClickThroughRate` | Organic Google Search click through rate | The percentage of Google Search impressions that resulted in a click to your website (for organic searches). Requires integration with Google Search Console. | | `organicGoogleSearchClicks` | Organic Google Search clicks | The number of clicks your website received from organic Google Search results. Requires integration with Google Search Console. | | `organicGoogleSearchImpressions` | Organic Google Search impressions | The number of times your website appeared in Google Search results for organic searches. Requires integration with Google Search Console. | | `promotionClicks` | Promotion clicks | The number of times users clicked on internal promotions (e.g., banners on your homepage promoting a sale). | | `promotionViews` | Promotion views | The number of times users viewed internal promotions. | | `publisherAdClicks` | Publisher ad clicks | The number of clicks on ads served through your Google Ad Manager account (if you're a publisher using Ad Manager). | | `publisherAdImpressions` | Publisher ad impressions | The number of ad impressions served through your Google Ad Manager account. | | `purchaseRevenue` | Purchase revenue | The total revenue generated from purchases, *after* discounts, and including shipping and tax. This is the most accurate measure of revenue from ecommerce. | | `purchaseToViewRate` | Purchase-to-view rate | The percentage of product detail page views that resulted in a purchase (calculated as `ecommercePurchases` / `itemViewEvents`). A measure of how likely users are to purchase after viewing a product. | | `purchaserConversionRate` | Purchaser conversion | The percentage of users who made a purchase (calculated as `totalPurchasers` / `totalUsers`). | | `refundAmount` | Refund amount | The total amount of refunds issued. | | `returnOnAdSpend` | Return on ad spend | The revenue generated for every dollar spent on advertising (calculated as `totalAdRevenue` / `advertiserAdCost`). A key measure of advertising effectiveness. | | `screenPageViews` | Views | The total number of pageviews or screen views (for apps). A fundamental measure of website traffic. | | `screenPageViewsPerSession` | Views per session | The average number of screens viewed per session. | | `screenPageViewsPerUser` | Views per user | The average number of screens viewed per user. | | `scrolledUsers` | Scrolled users | The number of users who scrolled down at least 90% of a page. A measure of engagement, indicating that users are consuming your content. | | `sessionConversionRate` | Session conversion rate | The percentage of sessions that resulted in a conversion (calculated as `conversions` / `sessions`). | | `sessions` | Sessions | The number of visits to your site or app. A session is a group of interactions that take place within a given time frame (typically 30 minutes of inactivity ends a session). | | `sessionsPerUser` | Sessions per user | The average number of sessions per user (calculated as `sessions` / `totalUsers`). | | `shippingAmount` | Shipping amount | The total amount of shipping charges collected. | | `taxAmount` | Tax amount | The total amount of taxes collected. | | `totalAdRevenue` | Total ad revenue | The total revenue generated from advertising, including both revenue from ads displayed on your site and ads you run on other platforms (if integrated). | | `totalPurchasers` | Total purchasers | The number of users who have made at least one purchase. | | `totalRevenue` | Total revenue | The sum of all revenue, including ecommerce revenue, ad revenue, and any other revenue sources you track. The most comprehensive measure of overall revenue. | | `transactions` | Transactions | The number of completed ecommerce transactions. | | `transactionsPerPurchaser` | Transactions per purchaser | The average number of transactions per purchaser (calculated as `transactions` / `totalPurchasers`). | | `userConversionRate` | User conversion rate | The percentage of *users* who completed a conversion (calculated as number of users who converted / `totalUsers`). This differs from `sessionConversionRate`, which is based on sessions. | | `userEngagementDuration` | User engagement | The total time users spent actively engaged with your site or app (across all users). | | `wauPerMau` | WAU / MAU | The ratio of weekly active users (WAU) to monthly active users (MAU). Another measure of "stickiness." | ### **Dimensions** *Dimensions* in Google Analytics provide context to your metrics. They are attributes of your users and their activity that allow you to segment and analyze your data. Dimensions enable you to break down your metrics by various criteria. | Tag | Name | Description | | --------------------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `achievementId` | Achievement ID | The ID of a specific achievement or milestone in a game or app (if you're tracking game data). | | `adFormat` | Ad format | The format of the ads displayed on your site (e.g., "Banner," "Interstitial," "Native"). Relevant if you're monetizing with ads. | | `adSourceName` | Ad source | The source of your ad traffic (e.g., "Google Ads," "AdMob"). | | `adUnitName` | Ad unit | The name of the ad unit within your site or app. Allows you to analyze performance by specific ad placements. | | `appVersion` | App version | The version of your mobile app. Useful for tracking performance across different app versions. | | `audienceId` | Audience ID | The ID of a specific audience you've defined in Google Analytics. | | `audienceName` | Audience name | The name of a specific audience you've defined in Google Analytics. Allows you to analyze the behavior of different user segments. | | `audienceResourceName` | Audience resource name | The resource name of the audience. | | `brandingInterest` | Interests | The interests of your users, based on their browsing activity and other data. Provides insights into user demographics and affinities. | | `browser` | Browser | The web browser used by your visitors (e.g., Chrome, Firefox, Safari). | | `campaignId` | Campaign ID | The ID of a specific marketing campaign (usually from your ad platform, like Google Ads). | | `campaignName` | Campaign | The name of a specific marketing campaign. Allows you to analyze performance by campaign. | | `character` | Character | In game analytics, name of game character. | | `city` | City | The city from which your website traffic originates. | | `cityId` | City ID | The unique ID of the city. | | `cohort` | Cohort | Groups users based on the date they first visited your site. Useful for cohort analysis to see how user behavior changes over time. | | `cohortNthDay` | Daily cohort | The number of days since a user's first visit, used for cohort analysis. Shows how user behavior changes over days after their initial visit. | | `cohortNthMonth` | Monthly cohort | The number of months since a user's first visit, used for cohort analysis. Shows how user behavior changes over months after their initial visit. | | `cohortNthWeek` | Weekly cohort | The number of weeks since a user's first visit, used for cohort analysis. Shows how users behave over the weeks. | | `contentGroup` | Content group | A grouping of related content on your website (e.g., "Blog Posts," "Product Pages"). Allows you to analyze performance by content category. | | `contentId` | Content ID | The ID of a specific piece of content. | | `contentType` | Content type | The type of content (e.g., "article," "video," "product"). | | `continent` | Continent | The continent from which your website traffic originates. | | `continentId` | Continent ID | The unique ID of the continent. | | `country` | Country | The country from which your website traffic originates. | | `countryId` | Country ID | The unique ID of the country. | | `currencyCode` | Currency | The currency used for transactions on your website or app. | | `date` | Date | The date of the data (YYYYMMDD format). | | `dateHour` | Date + hour (YYYYMMDDHH) | The date and hour of the data (YYYYMMDDHH format). Provides more granular time-based analysis. | | `dateHourMinute` | Date hour and minute | The date, hour, and minute of the data (YYYYMMDDHHMM format). Provides the most granular time-based analysis. | | `day` | Day | The day of the month (1-31). | | `dayOfWeek` | Day of week | The day of the week (0-6, where 0 is Sunday). | | `dayOfWeekName` | Day of week name | The name of the day of the week (e.g., "Sunday," "Monday"). | | `defaultChannelGroup` | Default channel group | The default channel grouping in Google Analytics (e.g., "Organic Search," "Direct," "Referral," "Social"). Provides a high-level view of traffic sources. | | `deviceCategory` | Device category | The type of device used to access your site or app (e.g., "desktop," "mobile," "tablet"). | | `deviceModel` | Device model | The specific model of the device used (e.g., "iPhone 13," "Samsung Galaxy S22"). | | `eventName` | Event name | The name of a custom event you're tracking on your site or app. | | `fileExtension` | File extension | The extension of a downloaded file (e.g., ".pdf," ".docx"). Relevant if you track file downloads. | | `fileName` | File name | The name of a downloaded file. | | `firstSessionDate` | First session date | The date of a user's first session on your site or app. | | `firstUserCampaignId` | First user campaign ID | The ID of the campaign that first acquired the user. | | `firstUserCampaignName` | First user campaign | The name of the campaign that first acquired the user. | | `firstUserDefaultChannelGroup` | First user default channel group | The default channel grouping that first acquired the user. | | `firstUserGoogleAdsAccountName` | First user Google Ads account name | The Google Ads account name associated with the user's first acquisition (if applicable). | | `firstUserGoogleAdsAdGroupId` | \ First user Google Ads ad group ID | \ The Google Ads ad group ID associated with the user's first acquisition (if applicable). | | `firstUserGoogleAdsAdGroupName` | \ First user Google Ads ad group name | \ The Google Ads ad group name associated with the user's first acquisition (if applicable). | | `firstUserGoogleAdsAdNetworkType` | \ First user Google Ads ad network type | \ The Google Ads ad network type (e.g., Search, Display) associated with the user's first acquisition (if applicable). | | `firstUserGoogleAdsCampaignId` | \ First user Google Ads campaign ID | The Google Ads campaign ID associated with the user's first session. | | `firstUserGoogleAdsCampaignName` | First user Google Ads campaign | \ The Google Ads campaign name associated with the user's first acquisition (if applicable). | | `firstUserGoogleAdsCampaignType` | \ First user Google Ads campaign type | \ The Google Ads campaign type (e.g., Search, Display, Shopping) associated with the user's first acquisition (if applicable). | | `firstUserGoogleAdsCreativeId` | \ First user Google Ads creative ID | \ The Google Ads creative ID associated with the user's first acquisition (if applicable). | | `firstUserGoogleAdsCustomerId` | \ First user Google Ads customer ID | \ The Google Ads customer ID associated with the user's first acquisition (if applicable). | | `firstUserGoogleAdsKeyword` | \ First user Google Ads keyword text | \ The Google Ads keyword associated with the user's first acquisition (if applicable). | | `firstUserGoogleAdsQuery` | \ First user Google Ads query | The Google Ads search query associated with the user's first acquisition (if applicable). | | `firstUserManualAdContent` | First user manual ad content | The ad content (UTM parameter `utm_content`) associated with the user's first acquisition (for manually tagged campaigns). | | `firstUserManualTerm` | First user manual term | The keyword term (UTM parameter `utm_term`) associated with the user's first acquisition (for manually tagged campaigns). | | `firstUserMedium` | First user medium | The medium (UTM parameter `utm_medium`) that first acquired the user (e.g., "organic," "cpc," "referral"). | | `firstUserPrimaryChannelGroup` | First user primary channel group | The primary channel group (a broader categorization than the default channel group) that first acquired the user. | | `firstUserSource` | First user source | The source (UTM parameter `utm_source`) that first acquired the user (e.g., "google," "facebook," "newsletter"). | | `firstUserSourceMedium` | First user source / medium | The combination of source and medium that first acquired the user. | | `firstUserSourcePlatform` | First user source platform | The platform where the user first found your site (e.g. "Manual", "Google Ads"). | | `fullPageUrl` | Full page URL | The complete URL of the page visited, including the protocol (e.g., "https\://"). | | `googleAdsAccountName` | Google Ads account name | The name of your Google Ads account (if linked to Google Analytics). | | `googleAdsAdGroupId` | Google Ads ad group ID | The ID of the Google Ads ad group (if applicable). | | `googleAdsAdGroupName` | Google Ads ad group name | The name of the Google Ads ad group (if applicable). | | `googleAdsAdNetworkType` | Google Ads ad network type | The Google Ads network type (e.g., "Search," "Display") (if applicable). | | `googleAdsCampaignId` | Google Ads campaign ID | The ID of the Google Ads campaign (if applicable). | | `googleAdsCampaignName` | Google Ads campaign | The name of your Google Ads campaign (if linked). | | `googleAdsCampaignType` | Google Ads campaign type | The type of Google Ads campaign (e.g., "Search," "Display," "Shopping") (if applicable). | | `googleAdsCreativeId` | Google Ads creative ID | The ID of the Google Ads creative (if applicable). | | `googleAdsCustomerId` | Google Ads customer ID | The customer ID of your Google Ads account (if applicable). | | `googleAdsKeyword` | Google Ads keyword text | The keyword that triggered your Google Ads ad (if applicable). | | `googleAdsQuery` | Google Ads query | The search query that triggered your Google Ads ad (if applicable). | | `groupId` | Group ID | The ID of a user group (if you're using user groups). | | `hostName` | Hostname | The hostname of your website (e.g., "[www.example.com](https://www.google.com/url?sa=E\&source=gmail\&q=https://www.example.com)"). | | `hour` | Hour | The hour of the day (0-23). | | `isConversionEvent` | Is conversion event | Indicates whether an event is marked as a conversion (true/false). | | `isoWeek` | ISO week of the year | The ISO week number (1-53). | | `isoYear` | ISO year | The ISO year. | | `isoYearIsoWeek` | ISO week of ISO year | The combined ISO year and ISO week (YYYYWW format). | | `itemAffiliation` | Item affiliation | The affiliation or store associated with a product (e.g., "Online Store," "Local Store"). | | `itemBrand` | Item brand | The brand of a product (e.g., "Google," "Nike"). | | `itemCategory` | Item category | The primary category of a product (e.g., "Apparel," "Electronics"). | | `itemCategory2` | Item category 2 | A secondary category for a product. | | `itemCategory3` | Item category 3 | A tertiary category for a product. | | `itemCategory4` | Item category 4 | A fourth-level category for a product. | | `itemCategory5` | Item category 5 | A fifth-level category for a product. | | `itemId` | Item ID | The unique ID of a product. | | `itemListId` | Item list ID | The ID of a product list (e.g., "Related Products," "Search Results"). | | `itemListName` | Item list name | The name of a product list. | | `itemListPosition` | Item list position | The position of the item within list | | `itemLocationID` | Item location ID | For local inventory ads, the ID of the location. | | `itemName` | Item name | The name of a product. | | `itemPromotionCreativeName` | Item promotion creative name | The name of the creative used for an item promotion. | | `itemPromotionCreativeSlot` | Item promotion creative slot | The placement of the item promotion. | | `itemPromotionId` | Item promotion ID | The ID of an item promotion. | | `itemPromotionName` | Item promotion name | The name of an item promotion. | | `itemVariant` | Item variant | A variation of a product (e.g., "Size: Large," "Color: Blue"). | | `landingPage` | Landing page | The first page a user visited in a session. | | `landingPagePlusQueryString` | Landing page + query string | The landing page URL, including any query parameters. | | `language` | Language | The language setting of the user's browser. | | `languageCode` | Language code | The language code of the user's browser (e.g., "en-US," "fr-CA"). | | `level` | Level | In game analytics, level in game | | `linkClasses` | Link classes | The CSS classes of a clicked link. Requires enhanced link attribution to be enabled. | | `linkDomain` | Link domain | The domain of a clicked link. Requires enhanced link attribution. | | `linkId` | Link ID | The ID of a clicked link. Requires enhanced link attribution. | | `linkText` | Link text | The text of clicked link. | | `linkUrl` | Link URL | The URL of a clicked link. Requires enhanced link attribution. | | `manualAdContent` | Manual ad content | The ad content (UTM parameter `utm_content`) for manually tagged campaigns. | | `manualTerm` | Manual term | The keyword term (UTM parameter `utm_term`) for manually tagged campaigns. | | `medium` | Medium | The medium through which users arrived at your site (e.g., "organic," "cpc," "referral," "email"). | | `method` | Method | The method. | | `minute` | Minute | The minute of the hour (0-59). | | `mobileDeviceBranding` | Device brand | The brand of the mobile device (e.g., "Apple," "Samsung"). | | `mobileDeviceMarketingName` | Device | The marketing name of the mobile device (e.g., "iPhone | | | | | | ------------------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `mobileDeviceModel` | Mobile model | The model of the mobile device (e.g., "iPhone 14 Pro," "Galaxy S23 Ultra"). | | `month` | Month | The month of the year (1-12). | | `newVsReturning` | New / returning | Whether the user is a new visitor ("New") or a returning visitor ("Returning"). | | `nthDay` | Nth day | The number of days since a specific event (used in custom reporting). | | `nthHour` | Nth hour | The number of hours since a specific event (used in custom reporting). | | `nthMinute` | Nth minute | The number of minutes since a specific event (used in custom reporting). | | `nthMonth` | Nth month | The number of months since a specific event (used in custom reporting). | | `nthWeek` | Nth week | The number of weeks since a specific event (used in custom reporting). | | `nthYear` | Nth year | The number of years since a specific event (used in custom reporting). | | `operatingSystem` | Operating system | The operating system of the user's device (e.g., "Windows," "macOS," "Android," "iOS"). | | `operatingSystemVersion` | OS version | The version of the operating system (e.g., "Windows 11," "iOS 16"). | | `operatingSystemWithVersion` | Operating system with version | The operating system and its version (e.g., "Windows 11," "iOS 16.2"). | | `orderCoupon` | Order coupon | The coupon code applied to an order (if applicable). | | `outbound` | Outbound | Whether a link click was outbound (leading to an external website) or internal (true/false). | | `pageLocation` | Page location | The full URL of the page, including the protocol and any query parameters. | | `pagePath` | Page path | The path of the page on your website (e.g., "/products/shoes," "/blog/article-1"). Excludes the domain. | | `pagePathPlusQueryString` | Page path + query string | The path of the page, including any query parameters. | | `pageReferrer` | Page referrer | The URL of the page that referred the user to the current page (the previous page in the user's journey). | | `pageTitle` | Page title | The title of the page, as defined in the `` tag of the HTML. | | `percentScrolled` | Percent scrolled | The percentage of a page that a user scrolled (e.g., "90"). Requires enhanced measurement to be enabled. | | `platform` | Platform | The platform used to access your site or app (e.g., "Web," "Android," "iOS"). | | `platformDeviceCategory` | Platform / device category | A combined dimension showing both the platform and device category (e.g., "Web / desktop," "Android / mobile"). | | `primaryChannelGroup` | Primary Channel Group | A higher-level grouping of traffic channels. | | `region` | Region | The region (e.g., state or province) from which your traffic originates. | | `screenResolution` | Screen resolution | The screen resolution of the user's device (e.g., "1920x1080"). | | `searchTerm` | Search term | The search term entered by a user on your site (if you have site search tracking enabled). | | `sessionCampaignId` | Session campaign ID | The ID of the campaign associated with the current session. | | `sessionCampaignName` | Session campaign | The name of the campaign associated with the current session. | | `sessionDefaultChannelGroup` | Session default channel group | The default channel grouping associated with the current session. | | `sessionGoogleAdsAccountName` | Session Google Ads account name | The Google Ads account name associated with the current session (if applicable). | | `sessionGoogleAdsAdGroupId` | Session Google Ads ad group ID | The Google Ads ad group ID associated with the current session (if applicable). | | `sessionGoogleAdsAdGroupName` | Session Google Ads ad group name | The Google Ads ad group name associated with the current session (if applicable). | | `sessionGoogleAdsAdNetworkType` | Session Google Ads ad network type | The Google Ads ad network type (e.g., Search, Display) associated with the current session (if applicable). | | `sessionGoogleAdsCampaignId` | Session Google Ads campaign ID | The Google Ads campaign ID associated with the current session. | | `sessionGoogleAdsCampaignName` | Session Google Ads campaign | The Google Ads Campaign associated with the current session | | `sessionGoogleAdsCampaignType` | Session Google Ads campaign type | The Google Ads campaign type associated with the current session | | `sessionGoogleAdsCreativeId` | Session Google Ads creative ID | The Google Ads Creative ID associated with the session. | | `sessionGoogleAdsCustomerId` | Session Google Ads customer ID | The Google Ads customer ID associated with the session. | | `sessionGoogleAdsKeyword` | Session Google Ads keyword text | The Google Ads keyword associated with the current session (if applicable). | | `sessionGoogleAdsQuery` | Session Google Ads query | The Google Ads search query associated with the current session (if applicable). | | `sessionManualAdContent` | Session manual ad content | The ad content (UTM parameter `utm_content`) for manually tagged campaigns, associated with the current session. | | `sessionManualTerm` | Session manual term | The keyword term (UTM parameter `utm_term`) for manually tagged campaigns, associated with the current session. | | `sessionMedium` | Session medium | The medium (UTM parameter `utm_medium`) associated with the current session (e.g., "organic," "cpc," "referral"). | | `sessionPrimaryChannelGroup` | Session primary channel group | The primary channel group associated with the session. | | `sessionSa360AdGroupName` | Session SA360 ad group name | The Search Ads 360 ad group name associated with the current session (if applicable). | | `sessionSa360CampaignId` | Session SA360 campaign ID | The Search Ads 360 campaign ID associated with the current session (if applicable). | | `sessionSa360CampaignName` | Session SA360 campaign | The Search Ads 360 campaign name associated with the current session (if applicable). | | `sessionSa360CreativeFormat` | Session SA360 creative format | The Search Ads 360 creative format associated with the current session (if applicable). | | `sessionSa360EngineAccountId` | Session SA360 engine account ID | The Search Ads 360 engine account ID associated with the current session (if applicable). | | `sessionSa360EngineAccountName` | Session SA360 engine account name | The Search Ads 360 engine account name associated with the current session (if applicable). | | `sessionSa360EngineAccountType` | Session SA360 engine account type | The Search Ads 360 engine account type associated with the current session (if applicable). | | `sessionSa360Keyword` | Session SA360 keyword text | The Search Ads 360 keyword associated with the current session (if applicable). | | `sessionSa360Medium` | Session SA360 medium | The Search Ads 360 medium associated with the current session (if applicable). | | `sessionSa360Query` | Session SA360 query | The Search Ads 360 search query associated with the current session (if applicable). | | `sessionSa360Source` | Session SA360 source | The Search Ads 360 source associated with the current session (if applicable). | | `sessionSource` | Session source | The source (UTM parameter `utm_source`) associated with the current session (e.g., "google," "facebook"). | | `sessionSourceMedium` | Session source / medium | The combination of source and medium associated with the current session. | | `sessionSourcePlatform` | Session source platform | The platform where the user found your site during current session (e.g. "Manual", "Google Ads"). | | `shippingTier` | Shipping tier | The shipping tier selected for a transaction (e.g., "Ground," "Express"). | | `signedInWithUserId` | Signed in with user ID | Indicates whether the user was signed in with a user ID (true/false). Requires user ID tracking to be enabled. | | `source` | Source | The source of your traffic (e.g., "google," "facebook," "direct"). | | `sourceMedium` | Source / medium | The combination of source and medium (e.g., "google / organic," "facebook / cpc"). | | `sourcePlatform` | Source platform | The platform from which your traffic originated (e.g., "Manual" for manually tagged campaigns, "Google Ads" for Google Ads campaigns). | | `streamId` | Stream ID | The unique ID of the data stream (for Google Analytics 4 properties). | | `streamName` | Stream name | The name of the data stream (for Google Analytics 4 properties). | | `testDataFilterId` | Test data filter ID | The ID of a test data filter (used for filtering data in your reports). | | `testDataFilterName` | Test data filter name | The name of a test data filter. | | `transactionId` | Transaction ID | The unique ID of an ecommerce transaction. | | `unifiedPagePathScreen` | Page path and screen class | A combined dimension showing the page path (for websites) or screen class (for apps). | | `unifiedPageScreen` | Page path + query string and screen class | A combined dimension showing the page path and query string (for websites) or screen class (for apps). | | `unifiedScreenClass` | Page title and screen class | A combined dimension showing the page title (for websites) or screen class (for apps). | | `unifiedScreenName` | Page title and screen name | A combined dimension showing the page title (for websites) or screen name (for apps). | | `userAgeBracket` | Age | The age bracket of the user (e.g., "18-24," "25-34"). | | `userGender` | Gender | The gender of the user (e.g., "male," "female"). | | `videoProvider` | Video provider | The provider of an embedded video (e.g., "YouTube," "Vimeo"). Requires enhanced measurement or custom event tracking. | | `videoTitle` | Video title | The title of an embedded video. Requires enhanced measurement or custom event tracking. | | `videoUrl` | Video URL | The URL of an embedded video. Requires enhanced measurement or custom event tracking. | | `virtualCurrencyName` | Virtual currency name | The name of a virtual currency used in a game or app (if applicable). | | `visible` | Visible | Whether a piece of content was visible on the screen (true/false). Often used with content impressions. | | `week` | Week | The week of the year (1-53). | | `year` | Year | The year of the data. | | `yearMonth` | Year month | The combined year and month (YYYYMM format). | | `yearWeek` | Year week | The combined year and week (YYYYWW format). | # Google Search Console Google Search Console is a free service offered by Google that helps you monitor, maintain, and troubleshoot your site's presence in Google Search results. It provides valuable insights into how Google sees your website, including: * **Search Performance:** See which queries bring users to your site, how often your site appears in search results (impressions), how often users click on your site (clicks), your average position in search results, and your click-through rate (CTR). * **Indexing Status:** Understand how Google is crawling and indexing your website, identify any indexing errors, and submit sitemaps to help Google discover your content. * **Mobile Usability:** Check for mobile-friendliness issues that could affect your site's ranking in mobile search results. * **Security Issues:** Receive alerts about any security problems detected on your site, such as malware or hacking. * **Links to Your Site:** See which websites are linking to your site (backlinks), which is a crucial factor in search engine ranking. Effectively using Google Search Console data is essential for improving your website's organic search visibility and driving more traffic from Google. ### **How a Google Search Console Connection Works in Uniquery** Uniquery simplifies the process of retrieving and analyzing your Google Search Console data directly within Google Sheets. Instead of manually downloading CSV reports from the Search Console interface, Uniquery establishes a secure, direct connection to the Google Search Console API using OAuth 2.0 authentication. This connection allows you to: * **Automate Data Retrieval:** Pull your Search Console performance data directly into your spreadsheets. * **Customize Reports:** Select specific metrics and dimensions to build reports tailored to your SEO analysis needs. * **Schedule Refreshes:** Keep your data up-to-date with automatic hourly, daily, or weekly refreshes. * **Combine Data Sources:** Integrate Search Console data with data from other platforms (like Google Analytics, LinkedIn Ads, etc.) for a complete picture of your online performance. * Directly access the Google Search Console API and extract the response to Google Sheets. ### **Metrics** In Google Search Console, *metrics* represent the quantitative measurements of your website's performance in Google Search. They provide the numerical data that shows how your site is performing. Okay, here's the table for Google Search Console *metrics* supported by Uniquery, including Tag, Name, and a Description: | Tab | Name | Description | | ------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `clicks` | Clicks | The number of times users clicked on your website's listing in Google Search results. A direct measure of how much traffic Google Search is sending to your site. | | `impressions` | Impressions | The number of times your website's listing appeared in Google Search results. Indicates how often your site is being seen by users. | | `ctr` | CTR (Click-Through Rate) | The percentage of impressions that resulted in a click (Clicks / Impressions). A higher CTR indicates that your search result listings are compelling and relevant. | | `position` | Average Position | The average position of your website's listing in search results for a given query or page. Lower numbers are better (position 1 is the top result). | ### **Dimensions** *Dimensions* in Google Search Console provide context to your metrics. They allow you to segment your data and analyze performance across different categories. Dimensions are attributes that describe your data, enabling you to break down your metrics. | Tag | Name | Description | | ------------------ | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `query` | Search query | The actual search terms users typed into Google to find your site. Essential for understanding what keywords are driving traffic and identifying new keyword opportunities. | | `country` | Country | The country where the user was located when they performed the search. Useful for understanding your geographic reach and tailoring content to specific regions. | | `device` | Device | The type of device used to perform the search (e.g., "desktop," "mobile," "tablet"). Important for optimizing your site for different device types and understanding user behavior on each. | | `page` | Page | The specific page on your website that appeared in the search results. Allows you to analyze the performance of individual pages and identify which pages are ranking well. | | `searchAppearance` | Search appearance | How your search result listing appeared in Google Search. Examples include "AMP article," "Rich result," "Video," "Web Light result," etc. Helps you understand the impact of rich snippets. | | `date` | Date | Segments your data. | # Facebook Ads Facebook Ads is Meta's advertising platform that allows businesses to reach potential customers through targeted ad campaigns. By integrating Facebook Ads with Uniquery, users can pull valuable data directly into their Google Sheets for analysis and reporting. This integration enables users to access a wide range of metrics and dimensions related to their ad campaigns, providing insights into performance, reach, and engagement. #### Metrics <a href="#metrics" id="metrics"></a> Metrics are quantitative measurements that provide insights into the performance of your Facebook Ads campaigns. | Tag | Name | Description | | ----------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------- | | `impressions` | Impressions | The number of times your ads were displayed. | | `cpc` | CPC | Cost Per Click: The average amount you're charged for each click on your ad. | | `cpm` | CPM | Cost Per Mille (1,000 impressions): The average amount you're charged for 1,000 impressions of your ad. | | `cpp` | CPP | Cost Per Purchase: The average cost of each purchase attributed to your ad. | | `ctr` | CTR | Click-Through Rate: The percentage of impressions that resulted in a click. | | `spend` | Spend | The total amount of money spent on your ad campaign. | | `reach` | Reach | The number of unique people who saw your ads. | | `account_currency` | Account Currency | The currency used for your Facebook Ads account. | | `account_id` | Account ID | The unique identifier for your Facebook Ads account. | | `account_name` | Account Name | The name of your Facebook Ads account. | | `action_values` | Action Values | The monetary value associated with specific actions taken as a result of your ads. | | `actions` | Actions | The total number of actions taken as a result of your ads (e.g., likes, shares, comments). | | `ad_id` | Ad ID | The unique identifier for an individual ad. | | `ad_name` | Ad Name | The name of the individual ad. | | `adset_id` | Adset ID | The unique identifier for an ad set. | | `adset_name` | Adset Name | The name of the ad set. | | `app_id` | App ID | The unique identifier for an app related to the ad. | | `attribution_setting` | Attribution Setting | The settings used to determine which interactions are attributed to conversions. | | `buying_type` | Buying Type | The type of buying method used for the ad (e.g., auction, reach and frequency). | | `campaign_id` | Campaign ID | The unique identifier for an ad campaign. | | `campaign_name` | Campaign Name | The name of the ad campaign. | | `canvas_avg_view_percent` | Canvas Avg View Percent | The average percentage of a canvas ad viewed. | | `canvas_avg_view_time` | Canvas Avg View Time | The average time spent viewing a canvas ad. | | `catalog_segment_value` | Catalog Segment Value | The value associated with a specific segment of a product catalog. | | `clicks` | Clicks | The total number of clicks on your ads. | | `coarse_conversion_value` | Coarse Conversion Value | A broader, less granular measure of conversion value. | | `conversion_rate_ranking` | Conversion Rate Ranking | How your ad's conversion rate compares to other ads targeting a similar audience. | | `conversion_values` | Conversion Values | The monetary value associated with conversions. | | `conversions` | Conversions | The total number of conversions attributed to your ads. | | `converted_product_quantity` | Converted Product Quantity | The quantity of products purchased as a result of your ads. | | `converted_product_value` | Converted Product Value | The monetary value of products purchased as a result of your ads. | | `cost_per_action_type` | Cost Per Action Type | The cost associated with a specific type of action (e.g., cost per like). | | `cost_per_conversion` | Cost Per Conversion | The average cost of each conversion. | | `cost_per_estimated_ad_recallers` | Cost Per Estimated Ad Recallers | The cost per person estimated to remember your ad. | | `cost_per_inline_link_click` | Cost Per Inline Link Click | The cost per click on a link within the ad's content. | | `cost_per_inline_post_engagement` | Cost Per Inline Post Engagement | The cost per engagement (e.g., like, comment, share) within the ad's post. | | `cost_per_outbound_click` | Cost Per Outbound Click | The cost per click that directs users to a website or app outside of Facebook. | | `cost_per_thruplay` | Cost Per Thruplay | The cost per video view that reached a certain duration (e.g., 15 seconds). | | `cost_per_unique_action_type` | Cost Per Unique Action Type | The cost per unique user taking a specific action. | | `cost_per_unique_click` | Cost Per Unique Click | The cost per unique user who clicked on your ad. | | `cost_per_unique_inline_link_click` | Cost Per Unique Inline Link Click | The cost per unique user who clicked on a link within the ad's content. | | `cost_per_unique_outbound_click` | Cost Per Unique Outbound Click | The cost per unique user who clicked on a link that directs them outside of Facebook. | | `date_start` | Date Start | The starting date of the reporting period. | | `date_stop` | Date Stop | The ending date of the reporting period. | | `dda_results` | Dda Results | Data-driven attribution results. | | `engagement_rate_ranking` | Engagement Rate Ranking | How your ad's engagement rate compares to other ads targeting a similar audience. | | `estimated_ad_recall_rate` | Estimated Ad Recall Rate | The estimated percentage of people who would remember your ad. | | `estimated_ad_recallers` | Estimated Ad Recallers | The estimated number of people who would remember your ad. | | `fidelity_type` | Fidelity Type | The type of data fidelity (e.g., observed, modeled). | | `frequency` | Frequency | The average number of times each person saw your ad. | | `full_view_impressions` | Full View Impressions | The number of times your ad was fully viewed. | | `full_view_reach` | Full View Reach | The number of unique people who fully viewed your ad. | | `inline_link_click_ctr` | Inline Link Click CTR | The click-through rate for links within the ad's content. | | `inline_link_clicks` | Inline Link Clicks | The number of clicks on links within the ad's content. | | `inline_post_engagement` | Inline Post Engagement | The total number of engagements (e.g., likes, comments, shares) within the ad's post. | | `instagram_upcoming_event_reminders_set` | Instagram Upcoming Event Reminders Set | The number of reminders set for upcoming Instagram events. | | `instant_experience_clicks_to_open` | Instant Experience Clicks To Open | The number of clicks to open an instant experience ad. | | `instant_experience_clicks_to_start` | Instant Experience Clicks To Start | The number of clicks to start an instant experience ad. | | `instant_experience_outbound_clicks` | Instant Experience Outbound Clicks | The number of clicks from an instant experience ad to external websites. | | `is_conversion_id_modeled` | Is Conversion ID Modeled | Indicates if the conversion ID was modeled. | | `landing_destination` | Landing Destination | The URL or location where users are directed after clicking the ad. | | `mobile_app_purchase_roas` | Mobile App Purchase Roas | Return on ad spend for mobile app purchases. | | `objective` | Objective | The marketing objective of the ad campaign (e.g., website traffic, conversions). | | `optimization_goal` | Optimization Goal | The goal used for optimizing ad delivery. | | `outbound_clicks` | Outbound Clicks | The number of clicks that direct users to a website or app outside of Facebook. | | `outbound_clicks_ctr` | Outbound Clicks CTR | The click-through rate for clicks that direct users outside of Facebook. | | `postback_sequence_index` | Postback Sequence Index | The index of the postback sequence. | | `purchase_roas` | Purchase Roas | Return on ad spend for purchases. | | `qualifying_question_qualify_answer_rate` | Qualifying Question Qualify Answer Rate | The rate at which qualifying questions are answered with qualifying answers. | | `quality_ranking` | Quality Ranking | How your ad's perceived quality compares to other ads targeting a similar audience. | | `redownload` | Redownload | The number of app redownloads. | | `skan_campaign_id` | Skan Campaign ID | SKAdNetwork campaign ID. | | `skan_conversion_id` | Skan Conversion ID | SKAdNetwork conversion ID. | | `social_spend` | Social Spend | The portion of your ad spend attributed to social interactions. | | `total_postbacks` | Total Postbacks | The total number | | Tag | Name | Description | | -------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `total_postbacks_detailed` | Total Postbacks Detailed | Represents the total number of detailed postbacks received, which are notifications sent from a third-party server to Facebook's servers, often used for tracking conversions or events. | | `total_postbacks_detailed_v4` | Total Postbacks Detailed V4 | A more recent version of the detailed postbacks metric, likely incorporating updates or refinements in tracking methodologies. | | `user_segment_key` | User Segment Key | A unique identifier or key representing a specific user segment. This is used to distinguish and analyze performance across different user groups. | | `video_30_sec_watched_actions` | Video 30 Sec Watched Actions | The number of times a video was watched for at least 30 seconds. This metric indicates sustained engagement with video content. | | `video_avg_time_watched_actions` | Video Avg Time Watched Actions | The average amount of time users spent watching the video. It provides insight into the overall engagement level with video content. | | `video_p100_watched_actions` | Video P100 Watched Actions | The number of times a video was watched to 100% completion. This metric indicates viewers who watched the entire video. | | `video_p25_watched_actions` | Video 25% Watched Actions | The number of times a video was watched to at least 25% completion. This metric helps track early engagement with video content. | | `video_p50_watched_actions` | Video 50% Watched Actions | The number of times a video was watched to at least 50% completion. This metric indicates mid-point engagement with video content. | | `video_p75_watched_actions` | Video 75% Watched Actions | The number of times a video was watched to at least 75% completion. This metric indicates high engagement with video content. | | `video_p95_watched_actions` | Video 95% Watched Actions | The number of times a video was watched to at least 95% completion. This metric indicates very high engagement, just before the video's completion. | | `video_play_actions` | Video Play Actions | The total number of times a video was played. This metric indicates the initial engagement with video content. | | `video_play_curve_actions` | Video Play Curve Actions | Data related to how viewers are watching the video over time, showing drop off points or high engagement points during the video. This indicates the viewers engagement curve. | | `website_ctr` | Website CTR | The click-through rate to the website, calculated as the number of clicks on the ad that led to the website divided by the number of impressions. It measures the effectiveness of driving traffic to the website. | | `website_purchase_roas` | Website Purchase Roas | Return on ad spend for website purchases. It measures the revenue generated from website purchases relative to the ad spend, indicating the profitability of the ad campaign. | #### Dimensions <a href="#dimensions" id="dimensions"></a> Dimensions are attributes that describe and segment your data, allowing users to break down metrics and analyze them in more detail. | Tag | Name | Description | | ----------------------------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------- | | `breakdown.ad_format_asset` | Ad Format Asset | The specific format of the ad asset (e.g., image, video, carousel). | | `breakdown.age` | Age | The age range of the users who saw the ad. | | `breakdown.app_id` | App ID | The ID of the app associated with the ad activity. | | `breakdown.body_asset` | Body Asset | The text content of the ad's body. | | `breakdown.call_to_action_asset` | Call To Action Asset | The specific call-to-action button or text used in the ad. | | `breakdown.coarse_conversion_value` | Coarse Conversion Value | A broad, privacy-preserving value indicating the level of conversion. | | `breakdown.country` | Country | The country where the ad was shown. | | `breakdown.description_asset` | Description Asset | The descriptive text associated with the ad. | | `breakdown.fidelity_type` | Fidelity Type | The type of fidelity or accuracy of the data. | | `breakdown.gender` | Gender | The gender of the users who saw the ad. | | `breakdown.hsid` | Hsid | A unique identifier (hash) for user activity. | | `breakdown.image_asset` | Image Asset | The specific image used in the ad. | | `breakdown.impression_device` | Impression Device | The type of device on which the ad was shown (e.g., mobile, desktop). | | `breakdown.is_conversion_id_modeled` | Is Conversion ID Modeled | Indicates if the conversion ID was modeled due to privacy limitations. | | `breakdown.landing_destination` | Landing Destination | The URL where users were directed after clicking the ad. | | `breakdown.link_url_asset` | Link URL Asset | The specific URL associated with a link in the ad. | | `breakdown.mdsa_landing_destination` | Mdsa Landing Destination | The landing destination for Meta Dynamic Showcase Ads. | | `breakdown.media_asset_url` | Media Asset URL | The URL of the media asset used in the ad. | | `breakdown.media_creator` | Media Creator | The creator or source of the media used in the ad. | | `breakdown.media_destination_url` | Media Destination URL | The final destination URL of the media. | | `breakdown.media_format` | Media Format | The format of the media used in the ad (e.g., video, image). | | `breakdown.media_origin_url` | Media Origin URL | The original source URL of the media. | | `breakdown.media_text_content` | Media Text Content | The text content associated with the media. | | `breakdown.postback_sequence_index` | Postback Sequence Index | The index or order of a postback in a sequence. | | `breakdown.product_id` | Product ID | The ID of the product featured in the ad. | | `breakdown.redownload` | Redownload | Indicates if the app was redownloaded. | | `breakdown.region` | Region | The geographical region where the ad was shown. | | `breakdown.skan_campaign_id` | Skan Campaign ID | The campaign ID associated with SKAdNetwork data. | | `breakdown.skan_conversion_id` | Skan Conversion ID | The conversion ID associated with SKAdNetwork data. | | `breakdown.skan_version` | Skan Version | The version of SKAdNetwork used. | | `breakdown.title_asset` | Title Asset | The title or headline of the ad. | | `breakdown.video_asset` | Video Asset | The specific video used in the ad. | | `breakdown.dma` | DMA | Designated Market Area, a geographic region used in media measurement. | | `breakdown.frequency_value` | Frequency Value | The number of times a user saw the ad. | | `breakdown.hourly_stats_aggregated_by_advertiser_time_zone` | Hourly Stats Aggregated By Advertiser Time Zone | Hourly statistics aggregated based on the advertiser's time zone. | | `breakdown.hourly_stats_aggregated_by_audience_time_zone` | Hourly Stats Aggregated By Audience Time Zone | Hourly statistics aggregated based on the audience's time zone. | | `breakdown.mmm` | MMM | Marketing Mix Modeling data. | | `breakdown.place_page_id` | Place Page ID | The ID of the Facebook Page where the ad was placed. | | `breakdown.publisher_platform` | Publisher Platform | The platform where the ad was published (e.g., Facebook, Instagram). | | `breakdown.platform_position` | Platform Position | The position of the ad on the platform. | | `breakdown.device_platform` | Device Platform | The operating system of the device where the ad was shown (e.g., iOS, Android). | | `breakdown.standard_event_content_type` | Standard Event Content Type | The type of content associated with a standard event. | | `breakdown.conversion_destination` | Conversion Destination | The destination where the conversion occurred (e.g., website, app). | | `breakdown.marketing_messages_btn_name` | Marketing Messages Btn Name | The name of the button used in marketing messages. | | `level.delivery_ad` | Delivery Ad | The specific ad delivery. | | `level.politicalad` | Political Ad | Indication if the ad is a political ad. | | `level.ad` | Ad | The individual ad. | | `level.adset` | Adset | The ad set that the ad belongs to. | | `level.campaign` | Campaign | The campaign that the ad set belongs to. | | `level.account` | Account | The ad account that the campaign belongs to. | | `timeIncrement.1` | Day | Daily aggregation of data. | | `timeIncrement.7` | 7Day | 7 day aggregation of data. | | `timeIncrement.monthly` | Monthly | Monthly aggregation of data. | # Notion Notion is a versatile workspace application that combines note-taking, project management, databases, wikis, and more. It allows users to create and organize information in a highly customizable way. Uniquery simplifies the process of accessing and analyzing your Notion data directly within Google Sheets. Instead of manually copying and pasting data, Uniquery establishes a secure connection to the Notion API using OAuth 2.0 authentication. ### **Notion Actions in Uniquery** Uniquery interacts with Notion through a set of *`actions`*. These actions determine what type of data you retrieve and how you interact with the Notion API. Uniquery supports the following actions: * **Import a database (`getDatabase`):** Retrieves the complete contents of a specified Notion database, including all properties and rows. This is the simplest way to get all data from a database. * **Query a database (`queryDatabase`):** Retrieves data from a Notion database based on a specific query, filter, and sort criteria that you define using JSON. This provides fine-grained control over the data you import. * **List all databases (`listDatabases`):** Retrieves a list of all databases shared with the Uniquery integration. This is useful for discovering database IDs for use with other actions. This doesn't import database *content*; it only lists the databases themselves. * **Search (`search`):** Performs a search across your Notion workspace, similar to Notion's built-in search. You can use a JSON query to specify search terms and filters. ### **Choosing a Database (for `getDatabase` and `queryDatabase`)** When using the `Import a database` or `Query a database` actions, you'll need to select the specific Notion database you want to work with. Uniquery provides a convenient way to do this: 1. **Connect to Notion:** In the Uniquery sidebar, go to "Manage Connections" and add a connection to your Notion workspace. 2. **Refresh Databases:** In the "Create Report" section for Notion, click the "Refresh databases" button. This will fetch a list of all databases shared with the Uniquery integration. 3. **Select Database:** Choose the desired database from the "Choose database" dropdown menu. This dropdown will populate after you refresh the database list. The dropdown displays database names, the value are database Ids. ### **Using Query JSON (for `queryDatabase` and `search`)** The `Query a database` and `Search` actions allow you to use Notion's powerful query language to specify which data you want to retrieve. This is done using a JSON (JavaScript Object Notation) object. * **Query JSON (for `queryDatabase`):** Enter a valid JSON object in the "Query JSON" text area to filter, sort, and otherwise refine the data retrieved from the selected database. Refer to the [Notion API documentation](https://developers.notion.com/reference/post-database-query) for details on the query syntax. * **Example (Filter):** JSON ```json { "filter": { "property": "Status", "select": { "equals": "Done" } } } ``` This example filters the database to only include rows where the "Status" property (which is assumed to be a "select" property) is equal to "Done". * **Example (Sort):** JSON ```json { "sorts": [ { "property": "Due Date", "direction": "ascending" } ] } ``` This example sorts the database by the "Due Date" property in ascending order. * **Query JSON (for `search`):** Enter a valid JSON object to define your search criteria. Refer to the [Notion API documentation](https://developers.notion.com/reference/post-search) for the search query syntax. * **Example:**JSON ```json { "query": "Project A", "filter": { "value": "page", "property": "object" } } ``` This will search "Project A" and only return pages. ### **Example: Importing a Notion Database** 1. **Connect to Notion:** Go to "Manage Connections" and connect your Notion workspace. 2. **Create a Report:** Go to "Create report." 3. **Select Action:** Choose "Import a database" from the "Choose an action" dropdown. 4. **Refresh Databases:** Click "Refresh databases." 5. **Choose Database:** Select the database you want to import from the "Choose database" dropdown. 6. **Generate Report:** Click the button to generate the report. Uniquery will import the entire database into your Google Sheets, with each property becoming a separate column. ### **Example: Querying a Notion Database** 1. **Connect to Notion:** Go to "Manage Connections" and connect your Notion workspace. 2. **Create a Report:** Click on the "Create" button. 3. **Select Action:** Choose "Query a database" from the "Choose an action" dropdown. 4. **Refresh Databases:** Click "Refresh databases." 5. **Choose Database:** Select the database you want to query from the "Choose database" dropdown. 6. **Enter Query JSON:** In the "Query JSON" text area, enter a valid JSON object to define your filter and sort criteria. 7. **Generate Report:** Click the button to generate the report. Uniquery will import the filtered and sorted data into your Google Sheet. By using the different actions and query capabilities, you can create a wide range of reports in Google Sheets to analyze your Notion data, track progress, and integrate it with other information. # LinkedIn Ads LinkedIn Ads is a powerful platform for B2B marketing, allowing you to target professionals based on their industry, job title, company, seniority, and more. It offers a variety of ad formats, including Sponsored Content, Message Ads (formerly Sponsored InMail), Text Ads, and Dynamic Ads, enabling you to reach your target audience with tailored messaging. Effective LinkedIn Ads campaigns rely on careful targeting, compelling creative, and consistent performance monitoring. ### **How a LinkedIn Ads Connection Works in Uniquery** Uniquery simplifies the process of retrieving and analyzing your LinkedIn Ads data directly within Google Sheets. Instead of manually downloading CSV reports from the LinkedIn Campaign Manager, Uniquery establishes a secure, direct connection to the LinkedIn Ads API using OAuth 2.0 authentication. This connection allows you to: * **Automate Data Retrieval:** Pull your LinkedIn Ads performance data directly into your spreadsheets. * **Customize Reports:** Select specific metrics and dimensions to build reports tailored to your needs. * **Schedule Refreshes:** Keep your data up-to-date with automatic hourly, daily, or weekly refreshes. * **Combine Data Sources:** Integrate LinkedIn Ads data with data from other marketing platforms (like Google Analytics, Facebook Ads, etc.) for a holistic view of your marketing performance. All in one spreadsheet. * Directly access the LinkedIn Ads API and extract the response to Google Sheets. ### **Metrics** In LinkedIn Ads, *metrics* represent the quantitative measurements of your campaign performance. They provide the numerical data that shows how your ads are performing. Understanding these metrics is crucial for evaluating the success of your campaigns and making data-driven optimizations. | Tag | Name | Description | | ------------------------------------------ | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `actionClicks` | Action Clicks | The number of clicks on various call-to-action buttons within your ad (e.g., "Apply Now," "Learn More"). Represents direct interactions with your ad's intended action. | | `adUnitClicks` | Ad Unit Clicks | The number of times users clicked on the ad unit itself, not necessarily a specific call-to-action. This can include clicks on the ad image or headline. | | `approximateMemberReach` | Approximate Member Reach | An estimate of the total number of unique LinkedIn members who could potentially see your ad, based on your targeting criteria. This is a reach estimate, not the actual number of impressions. | | `cardClicks` | Card Clicks | The number of clicks on a specific card within a Carousel Ad. Carousel Ads display multiple images or videos (cards) that users can swipe through. | | `cardImpressions` | Card Impressions | The number of times a specific card within a Carousel Ad was displayed to a user. | | `clicks` | Clicks | The total number of clicks on your ad, including clicks on the ad unit, call-to-action buttons, and other interactive elements. A general measure of engagement. | | `commentLikes` | Comment Likes | The number of likes received on comments made on your Sponsored Content posts. Indicates engagement with user-generated content related to your ad. | | `comments` | Comments | The number of comments made on your Sponsored Content posts. Shows how much discussion your ad is generating. | | `companyPageClicks` | Company Page Clicks | The number of clicks on the link to your company page within your ad. Measures interest in learning more about your company. | | `conversionValueInLocalCurrency` | Conversion Value In Local Currency | The total value of conversions attributed to your LinkedIn Ads, expressed in your local currency. Requires conversion tracking to be set up. Represents the monetary value generated by your campaigns. | | `costInLocalCurrency` | Cost In Local Currency | The total amount spent on your LinkedIn Ads campaigns, expressed in your local currency. | | `costInUsd` | Cost In USD | The total amount spent on your LinkedIn Ads campaigns, expressed in US dollars. | | `dateRange` | Date Range | This usually goes in dimension. Defines a time period. | | `documentCompletions` | Document Completions | The number of times users fully viewed a document you shared in your ad (e.g., a PDF). Indicates strong interest in your content. | | `documentFirstQuartileCompletions` | Document First Quartile Completions | The number of times users viewed at least the first 25% of a document in your ad. | | `documentMidpointCompletions` | Document Midpoint Completions | The number of times users viewed at least 50% of a document in your ad. | | `documentThirdQuartileCompletions` | Document Third Quartile Completions | The number of times users viewed at least 75% of a document in your ad. | | `downloadClicks` | Download Clicks | The number of times users clicked to download a file offered in your ad. Useful for measuring interest in downloadable resources like white papers or ebooks. | | `externalWebsiteConversions` | External Website Conversions | The number of conversions that occurred on your website after a user clicked on your LinkedIn Ad. Requires conversion tracking to be implemented. | | `externalWebsitePostClickConversions` | External Website Post Click Conversions | The number of conversions on your website that occurred within a set time window *after* a user clicked on your LinkedIn Ad. Focuses on conversions directly attributable to ad clicks. | | `externalWebsitePostViewConversions` | External Website Post View Conversions | The number of conversions on your website that occurred within a set time window after a user *saw* your LinkedIn Ad (but didn't necessarily click). Captures the influence of ad impressions on conversions. | | `follows` | Follows | The number of new followers your company page gained as a direct result of your Sponsored Content. Measures the impact of your ads on building your organic audience. | | `fullScreenPlays` | Full Screen Plays | The number of times users played your video ad in full-screen mode. Indicates higher engagement with your video content. | | `headlineClicks` | Headline Clicks | The number of clicks directly to the headline. | | `headlineImpressions` | Headline Impressions | The number of impression of the headline. | | `impressions` | Impressions | The number of times your ad was displayed to users. A fundamental measure of ad reach. A single user can see the same ad multiple times (multiple impressions). | | `jobApplications` | Job Applications | The number of job applications received through LinkedIn's job application feature, driven by your ads. Relevant for recruitment campaigns. | | `jobApplyClicks` | Job Apply Clicks | The number of clicks on the "Apply" button within a job posting promoted by your ad. A key metric for tracking interest in job openings. | | `landingPageClicks` | Landing Page Clicks | The number of clicks that took users to the landing page specified in your ad. Measures the effectiveness of your ad in driving traffic to your website. | | `leadGenerationMailContactInfoShares` | Lead Generation Mail Contact Info Shares | In Sponsored InMail campaigns, the number of times users shared their contact information through a lead generation form. | | `leadGenerationMailInterestedClicks` | Lead Generation Mail Interested Clicks | In Sponsored InMail campaigns, the number of clicks on a call-to-action button indicating interest (e.g., "Learn More," "Register"). | | `likes` | Likes | The number of likes your Sponsored Content posts received. A basic measure of engagement and social approval. | | `oneClickLeadFormOpens` | One Click Lead Form Opens | The number of times users opened a one-click lead generation form within your ad. These forms pre-populate with the user's LinkedIn profile information, making it easy to submit leads. | | `oneClickLeads` | One Click Leads | The number of leads submitted through a one-click lead generation form. A key metric for measuring lead generation success. | | `opens` | Opens | In Sponsored InMail campaigns, the number of times users opened your message. The equivalent of email opens. | | `otherEngagements` | Other Engagements | A catch-all metric for various other interactions with your ad that aren't captured by other specific metrics. | | `pivotValues` | Pivot Values | Value used for pivot tables. | | `postClickJobApplications` | Post Click Job Applications | The number of job applications received within a set time window *after* a user clicked on your LinkedIn Ad (promoting a job posting). | | `postClickJobApplyClicks` | Post Click Job Apply Clicks | Clicks on the "Apply" button within a promoted job posting, occurring within a set time window *after* a user initially clicked on the ad. | | `postClickRegistrations` | Post Click Registrations | The number of registrations (e.g., for a webinar or event) that occurred within a set time window *after* a user clicked on your LinkedIn Ad. | | `postViewJobApplications` | Post View Job Applications | The number of job applications received within a set time window after a user *saw* your LinkedIn Ad (promoting a job posting), but didn't necessarily click. | | `postViewJobApplyClicks` | Post View Job Apply Clicks | Clicks on the "Apply" button within a promoted job posting, occurring within a set time window after a user *saw* the ad (but didn't click). | | `postViewRegistrations` | Post View Registrations | The number of registrations that occurred within a set time window after a user *saw* your LinkedIn Ad (but didn't necessarily click). | | `reactions` | Reactions | The number of reactions (e.g., Like, Celebrate, Support, Love, Insightful, Curious) users gave to your Sponsored Content posts. Provides a more nuanced view of engagement than just likes. | | `registrations` | Registrations | The number of registrations (e.g., for a webinar or event) driven by your LinkedIn Ads. | | `sends` | Sends | In Sponsored InMail campaigns, the number of messages sent. | | `shares` | Shares | The number of times users shared your Sponsored Content posts. Indicates strong engagement and content virality. | | `talentLeads` | Talent Leads | The number of leads generated specifically for talent acquisition purposes. Useful for recruitment campaigns. | | `textUrlClicks` | Text Url Clicks | The number of clicks on text URLs included within your ad copy. | | `totalEngagements` | Total Engagements | The sum of all engagement metrics (clicks, likes, comments, shares, etc.). A broad measure of overall ad interaction. | | `validWorkEmailLeads` | Valid Work Email Leads | The number of leads generated that include a valid work email address. Indicates higher-quality leads for B2B campaigns. | | `videoCompletions` | Video Completions | The number of times users watched your video ad to the end. A strong indicator of video ad effectiveness. | | `videoFirstQuartileCompletions` | Video First Quartile Completions | The number of times users watched at least the first 25% of your video ad. | | `videoMidpointCompletions` | Video Midpoint Completions | The number of times users watched at least 50% of your video ad. | | `videoStarts` | Video Starts | The number of times users started playing your video ad. A basic measure of video ad views. | | `videoThirdQuartileCompletions` | Video Third Quartile Completions | The number of times users watched at least 75% of your video ad. | | `videoViews` | Video Views | The number of times your video ad was viewed. Often defined as a view of a certain duration (e.g., 2 seconds or more). | | `viralCardClicks` | Viral Card Clicks | The number of clicks on a card within a Carousel Ad that occurred due to organic sharing or engagement (not directly from the paid ad). | | `viralCardImpressions` | Viral Card Impressions | The number of times a card within a Carousel Ad was displayed due to organic sharing or engagement. | | `viralClicks` | Viral Clicks | The number of clicks on your ad that occurred due to organic sharing or engagement (not directly from the paid ad). | | `viralCommentLikes` | Viral Comment Likes | The number of likes on comments made on your Sponsored Content posts, originating from organic sharing or engagement. | | `viralComments` | Viral Comments | The number of comments made on your Sponsored Content posts, originating from organic sharing or engagement. | | `viralCompanyPageClicks` | Viral Company Page Clicks | Clicks on your company page link that occurred due to organic sharing or engagement with your ad. | | `viralDocumentCompletions` | Viral Document Completions | Completions of a document shared in your ad, driven by organic sharing or engagement. | | `viralDocumentFirstQuartileCompletions` | Viral Document First Quartile Completions | Views of at least the first 25% of a document in your ad, driven by organic sharing or engagement. | | `viralDocumentMidpointCompletions` | Viral Document Midpoint Completions | Views of at least 50% of a document in your ad, driven by organic sharing or engagement. | | `viralDocumentThirdQuartileCompletions` | Viral Document Third Quartile Completions | Views of at least 75% of a document in your ad, driven by organic sharing or engagement. | | `viralDownloadClicks` | Viral Download Clicks | Downloads of a file offered in your ad, driven by organic sharing or engagement. | | `viralExternalWebsiteConversions` | Viral External Website Conversions | Conversions on your website attributed to organic sharing or engagement with your LinkedIn Ad. | | `viralExternalWebsitePostClickConversions` | Viral External Website Post Click Conversions | Website conversions occurring within a set time window after a user clicked on a *virally shared* instance of your LinkedIn Ad. | | `viralExternalWebsitePostViewConversions` | Viral External Website Post View Conversions | Website conversions occurring within a set time window after a user saw a *virally shared* instance of your LinkedIn Ad (without clicking). | | `viralFollows` | Viral Follows | New followers gained for your company page due to organic sharing or engagement with your ad. | | `viralFullScreenPlays` | Viral Full Screen Plays | Plays of your video ad in full-screen mode, driven by organic sharing or engagement. | | `viralImpressions` | Viral Impressions | Impressions of your ad that occurred due to organic sharing or engagement. | | `viralJobApplications` | Viral Job Applications | Job applications received through organic sharing or engagement with your ad promoting a job posting. | | `viralJobApplyClicks` | Viral Job Apply Clicks | Clicks on the "Apply" button within a job posting, driven by organic sharing or engagement with your ad. | | `viralLandingPageClicks` | Viral Landing Page Clicks | Clicks to your landing page that occurred due to organic sharing or engagement with your ad. | | `viralLikes` | Viral Likes | Likes on your Sponsored Content posts that originated from organic sharing or engagement. | | `viralOneClickLeadFormOpens` | Viral One Click Lead Form Opens | Opens of one-click lead generation forms, driven by organic sharing or engagement with your ad. | | `viralOneClickLeads` | Viral One Click Leads | Leads submitted through one-click lead generation forms, driven by organic sharing or engagement with your ad. | | `viralOtherEngagements` | Viral Other Engagements | A catch-all for other interactions with your ad that occurred due to organic sharing or engagement. | | `viralPostClickJobApplications` | Viral Post Click Job Applications | Job applications received within a set window after a click on a *virally shared* instance of your ad (promoting a job). | | `viralPostClickJobApplyClicks` | Viral Post Click Job Apply Clicks | "Apply" button clicks within a promoted job posting, occurring within a set window after a click on a *virally shared* instance of the ad. | | `viralPostClickRegistrations` | Viral Post Click Registrations | Registrations occurring within a set window after a click on a *virally shared* instance of your ad. | | `viralPostViewJobApplications` | Viral Post View Job Applications | Job applications received within a set window after a user *saw* a *virally shared* instance of your ad (promoting a job), without clicking. | | `viralPostViewJobApplyClicks` | Viral Post View Job Apply Clicks | "Apply" button clicks within a promoted job posting, occurring within a set window after a user *saw* a *virally shared* instance of the ad (without clicking). | | `viralPostViewRegistrations` | Viral Post View Registrations | Registrations occurring within a set window after a user *saw* a *virally shared* instance of your ad (without clicking). | | `viralReactions` | Viral Reactions | Reactions to your Sponsored Content posts that originated from organic sharing or engagement. | | `viralRegistrations` | Viral Registrations | Registrations driven by organic sharing or engagement with your LinkedIn Ads. | | `viralShares` | Viral Shares | Shares of your Sponsored Content posts that originated from organic sharing or engagement. | | `viralTotalEngagements` | Viral Total Engagements | The sum of all engagement metrics driven by organic sharing or engagement with your ad. | ### **Dimensions** *Dimensions* in LinkedIn Ads provide context to your metrics. They allow you to segment your data and analyze performance across different categories. Dimensions are essentially the attributes that describe your data, allowing you to break down your metrics by various criteria. | Tag | Name | Description | | -------------------------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `COMPANY` | Company | Segments your data by the LinkedIn Company Page associated with the ad campaign. Useful for analyzing performance across different company pages you manage. | | `ACCOUNT` | Account | Segments your data by the LinkedIn Ads account. Useful if you manage multiple accounts. | | `SHARE` | Share | Segments data by the specific Sponsored Content share. This allows you to analyze the performance of individual posts. | | `CAMPAIGN` | Campaign | Segments your data by the specific LinkedIn Ads campaign. Essential for analyzing performance at the campaign level. | | `CREATIVE` | Creative | Segments your data by the individual ad creative (e.g., image, video, text). Allows you to compare the performance of different ad variations. | | `CAMPAIGN_GROUP` | Campaign Group | Segments your data by the campaign group, which is a collection of campaigns under a common theme or objective. | | `CONVERSION` | Conversion | Segments your data by the specific conversion tracked (e.g., lead form submission, website purchase). Allows you to analyze which conversions are performing best. | | `CONVERSATION_NODE` | Conversation Node | (For conversational ads) Segments data by the specific node within a conversation flow. Useful for analyzing user interaction within complex ad formats. | | `CONVERSATION_NODE_OPTION_INDEX` | Conversation Node Option Index | (For conversational ads) Segments data by the user's selected option within a conversation node. Provides even more granular insight into user choices within conversational ads. | | `SERVING_LOCATION` | Serving Location | Segments your data by the geographic location where your ads were served. Useful for understanding regional performance differences. | | `CARD_INDEX` | Card Index | (For Carousel Ads) Segments your data by the position of the card within the carousel (e.g., card 1, card 2, etc.). Allows you to analyze which cards are most engaging. | | `PLACEMENT_NAME` | Placement Name | Segments data by where your ad was shown on LinkedIn (e.g., LinkedIn Feed, LinkedIn Audience Network). Helps you understand which placements are most effective. | | `IMPRESSION_DEVICE_TYPE` | Impression Device Type | Segments your data by the type of device users saw your ad on (e.g., desktop, mobile). Useful for optimizing campaigns for different devices. | | `timeGranularity__DAILY` | Day | Segments your data by day. Provides a daily breakdown of your performance metrics. | | `timeGranularity__MONTHLY` | Month | Segments your data by month. Provides a monthly breakdown of your performance metrics. | | `timeGranularity__YEARLY` | Year | Segments your data by year. Provides a yearly breakdown of your performance metrics. Useful for long-term trend analysis. | # Hubspot HubSpot is a comprehensive *CRM (Customer Relationship Management)* platform that provides tools for marketing, sales, customer service, and content management. It helps businesses attract visitors, convert leads, close deals, and delight customers. HubSpot's built-in reporting offers many insights, but integrating HubSpot data with other data sources and performing custom analyses is often essential for a complete view of business performance. ### **How a HubSpot Connection Works in Uniquery** Uniquery streamlines accessing and analyzing your HubSpot data directly within Google Sheets. Instead of manually exporting data from HubSpot, Uniquery establishes a secure, direct connection to the HubSpot API using OAuth 2.0 authentication. This connection allows you to: * **Automate Data Retrieval:** Pull data from various HubSpot objects (like Contacts, Companies, and Deals) directly into your spreadsheets. * **Customize Data Imports:** Select the specific HubSpot action you want to perform (currently: importing Contacts, Companies, or Deals). * **Limit the Number of Records:** Control the amount of data imported in a single request. * **Schedule Refreshes:** Keep your data up-to-date with automatic hourly, daily, or weekly refreshes (available with a paid Uniquery subscription). * **Combine Data Sources:** Integrate HubSpot data with data from other marketing platforms, analytics tools, and business systems for a holistic view of performance. * Directly access the Hubspot API and extract the response to Google Sheets. Uniquery simplifies data extraction, eliminates manual exports, and provides a powerful way to work with your HubSpot data in Google Sheets. ### **HubSpot Actions in Uniquery** Uniquery interacts with HubSpot by performing specific *actions*. Currently, Uniquery supports the following actions for importing data: * **Import Contacts:** Retrieves data about your contacts in HubSpot, including properties like name, email, company, lifecycle stage, and any custom properties you've defined. * **Import Companies:** Retrieves data about companies in HubSpot, including properties like company name, domain, industry, and any custom company properties. * **Import Deals:** Retrieves data about your deals in HubSpot, including properties like deal name, amount, stage, close date, associated contacts and companies, and any custom deal properties. Each of these actions retrieves a set of *records* (individual contacts, companies, or deals) from HubSpot, along with their associated *properties* (fields). ### **Limiting the Number of Records (Number of Records)** The HubSpot API has limits on the number of records that can be retrieved in a single request. Uniquery allows you to specify a limit: * **Number of records (optional):** Enter the number of records you want to import. The default value is 10. If left blank, Uniquery will import 10 records. ### **Example: Importing Contacts from HubSpot** To import contact data into your Google Sheet: 1. **Connect to HubSpot:** In the Uniquery sidebar, go to "Manage Connections" and add a connection to your HubSpot account. 2. **Create a Report:** Go to "Create Report." 3. **Select Action:** Choose "Import contacts" from the "Choose an action" dropdown. 4. **Set Limit (Optional):** Enter a value for "Number of records (optional)." Leave blank for the default of 10. 5. **Generate Report:** Click the button to generate the report (the exact button text may vary). Uniquery will import the specified contact data into your Google Sheet. The data will be presented with each contact property (e.g., `firstname`, `lastname`, `email`, `company`, `lifecyclestage`) as a separate column. ### **Example: Importing Companies or Deals** Follow similar procedures to import companies and deals, the only difference is to choose different actions. By selecting different actions and using the limiting option, you can create various reports in Google Sheets to analyze your HubSpot data and gain insights into your marketing, sales, and customer relationships. # Shopify Shopify is a leading e-commerce platform that allows businesses to create and manage online stores. It provides a comprehensive suite of tools for handling everything from product listings and inventory management to order processing, payments, and shipping. Shopify's robust reporting features offer insights into sales, customer behavior, and overall store performance. However, for advanced analysis and reporting, integrating Shopify data with other data sources is often necessary. Okay, here's a revised draft for the Shopify data source section, reflecting Uniquery's approach of retrieving "resources" rather than explicitly defining metrics and dimensions: ### **Shopify Resources in Uniquery** Instead of using the traditional "metrics" and "dimensions" terminology, Uniquery works with Shopify *resources*. A resource represents a type of data object within Shopify, such as an Order, a Product, or a Customer. Each resource has a set of associated *fields* that contain the specific data points. When you create a Shopify report in Uniquery, you select the resource you want to import. ### **Shopify Resources Supported by Uniquery** Uniquery supports importing data from the following Shopify resources: * **Orders:** Contains all information related to orders placed in your store, including order details, line items, customer information, shipping and billing addresses, payment details, refunds, and fulfillment status. * **Products:** Contains information about your products, including titles, descriptions, variants (with prices and SKUs), inventory levels (through associated Inventory Level objects), images, and more. * **Collects:** Represents the relationships between products and collections. Useful for understanding which products belong to which collections. * **Events:** Records various events that occur within your Shopify store, such as order creation, product updates, and customer account changes. * **Gift cards:** Contains data on gift cards issued by your store. * **Custom collections:** Contains information of your custom collections. * **Marketing events:** Contains marketing activities. * **Blogs** Contains blog posts ### **Filtering Shopify Data (Order Status)** For the `Orders` resource, Uniquery provides an additional filtering option: * **Order Status:** You can choose to import orders with a specific status: * **Any:** Imports all orders, regardless of status. * **Open:** Imports only orders that are currently open (not yet fulfilled or canceled). * **Closed:** Imports only orders that have been fulfilled. * **Canceled:** Imports only orders that have been canceled. This allows you to focus your reports on specific subsets of your order data. ### **Limiting the Number of Records (Limit)** The Shopify API has limits on the number of records that can be retrieved in a single request. Uniquery allows you to specify a `Limit` for your data import: * **Limit (Optional):** Enter the number of records you want to import. The default value is 50. The maximum value is 250, due to Shopify's API limitations. Uniquery automatically handles pagination, so even if you set a limit of 250, and there are more than 250 records, running the query again will retrieve the next set of records. ### **Example: Importing Order Data** To import order data into your Google Sheet: 1. **Connect to Shopify:** In the Uniquery sidebar, go to "Manage Connections" and add a connection to your Shopify store. 2. **Create a Report:** Go to the "Create Report" page. 3. **Select Resource:** Choose "Orders" from the "Choose a Shopify resource type to import" dropdown. 4. **Filter by Status (Optional):** Select the desired "Order status" (Any, Open, Closed, or Canceled). 5. **Set Limit (Optional):** Enter a value for "Limit" (maximum 250). Leave blank for the default of 50. 6. **Generate Report:** Click the button to generate the report. Uniquery will import the specified order data into your Google Sheet. The data will be presented with each field (e.g., `order_number`, `created_at`, `total_price`, `customer.email`, etc.) as a separate column. **Example: Importing product data** To import product data, select "Products" as resource, set limits, and then click the button to generate the report. All product data will be imported into the Google Sheet. By selecting different resources and using the available filtering and limiting options, you can create a wide variety of reports in Google Sheets to analyze your Shopify data and gain valuable insights into your store's performance. # Airtable Airtable is a cloud-based, collaborative platform that combines the features of a spreadsheet and a database. It allows users to create flexible, relational databases to organize and manage data, track projects, and build custom workflows. Uniquery streamlines accessing and analyzing your Airtable data directly within Google Sheets. Instead of manually exporting CSV files from Airtable, Uniquery establishes a secure, direct connection to the Airtable API using OAuth 2.0 authentication. ### **Airtable Actions in Uniquery** Uniquery interacts with Airtable through a set of *actions*. These actions determine what type of data you retrieve. Uniquery supports the following actions: * **Imports a table (`getTableRecords`):** Retrieves all records (rows) from a specified Airtable table, including all fields (columns). This is the primary action for getting your Airtable data into Google Sheets. * **List all bases (`listBases`):** Retrieves a list of all Airtable bases that the Uniquery integration has access to. This action is useful for discovering base IDs and understanding which bases are available. This action *does not* import the data within the bases; it only lists the bases themselves. ### **Specifying the Table URL (for `getTableRecords`)** When using the `Imports a table` action, you'll need to provide the URL of the specific Airtable table you want to import. Here's how to find the table URL: 1. **Open your Airtable base and table:** Navigate to the specific table you want to import within your Airtable base. 2. **Copy the URL from your browser's address bar:** The URL should look something like this: `https://airtable.com/appXXXXXXXXXXXXXX/tblYYYYYYYYYYYYYY/viwZZZZZZZZZZZZZZ` * `appXXXXXXXXXXXXXX` is the Base ID. * `tblYYYYYYYYYYYYYY` is the Table ID. * `viwZZZZZZZZZZZZZZ` is the View ID. * The URL can also contain block information. 3. **Paste the URL into Uiquery** Paste this full URL into the "Table URL" field in the Uniquery sidebar. ### **Example: Importing an Airtable Table** 1. **Connect to Airtable:** In the Uniquery sidebar, go to "Manage Connections" and add a connection to your Airtable account. 2. **Create a Report:** Click on "Create" button. 3. **Select Action:** Choose "Imports a table" from the "Choose an action" dropdown. 4. **Enter Table URL:** Paste the URL of your Airtable table into the "Table URL" field. 5. **Generate Report:** Click the button to generate the report. Uniquery will import all records from the specified table into your Google Sheet. Each field in your Airtable table will become a separate column in the spreadsheet. ### **Example: Listing All Bases** 1. **Connect to Airtable:** In the Uniquery sidebar, go to "Manage Connections" and add a connection to your Airtable account. 2. **Create a Report:** Go to "Create report". 3. **Select Action:** Choose "List all bases" from the "Choose an action" dropdown. 4. **Generate Report:** Click the button to generate the report. Uniquery will import a list of your Airtable bases (including base IDs and names) into your Google Sheet. This is useful for reference, especially if you need to find the base ID for other integrations or API calls. By using these actions, you can efficiently retrieve data from your Airtable bases and tables, bringing it into Google Sheets for further analysis, reporting, and integration with other data sources. # Pipedrive Pipedrive is a sales-focused CRM (Customer Relationship Management) platform designed to help sales teams manage leads, track deals, and automate their sales processes. It provides a visual pipeline view of deals, allowing for easy tracking of progress through different stages. Uniquery simplifies accessing and analyzing your Pipedrive data directly within Google Sheets. Instead of manually exporting CSV files from Pipedrive, Uniquery establishes a secure, direct connection to the Pipedrive API using OAuth 2.0 authentication. ### **Pipedrive Resources in Uniquery** Uniquery interacts with Pipedrive by retrieving data from different *resources*. A resource represents a type of data object within Pipedrive. Uniquery currently supports the following Pipedrive resources: * **Persons:** Represents individual contacts in Pipedrive. Includes information like name, email, phone number, organization, and custom fields. * **Leads:** Represents potential deals that are in the early stages of the sales process. Includes information about the lead, associated contact and organization, and lead value. * **Deals:** Represents deals in progress, including deal value, stage, close date, associated contact and organization, and custom fields. * **Projects:** If you use Pipedrive's Projects feature, this resource allows you to retrieve data about your projects. * **Products:** Represents the products or services you sell. Includes information like product name, code, price, and custom fields. * **Organizations:** Represents companies or organizations associated with your contacts and deals. Includes information like company name, address, and custom fields. * **Activities:** Represents activities related to your deals and contacts, such as calls, meetings, emails, and tasks. ### **Filtering Data by Owner ID (Persons and Leads)** For the `Persons` and `Leads` resources, Uniquery offers an optional filter: * **Owner ID (Optional):** If you provide a user ID in this field, Uniquery will only import Persons or Leads that are *owned* by that specific Pipedrive user. Leave this field blank to import all Persons or Leads, regardless of owner. ### **Example: Importing All Deals from Pipedrive** 1. **Connect to Pipedrive:** In the Uniquery sidebar, go to "Manage Connections" and add a connection to your Pipedrive account. 2. **Create a Report:** Go to "Create Report". 3. **Select Resource:** Choose "Import all deals" from the "Choose an action" dropdown. 4. **Generate Report:** Click the button to generate the report. Uniquery will import all your Pipedrive deals into your Google Sheet. Each deal property (e.g., `title`, `value`, `stage_id`, `person_id`, `org_id`) will be a separate column. ### **Example: Importing Leads for a Specific Owner** 1. **Connect to Pipedrive:** In the Uniquery sidebar, go to "Manage Connections" and add a connection to your Pipedrive account. 2. **Create a Report:** Go to "Create report". 3. **Select Resource:** Choose "Import all leads" from the "Choose an action" dropdown. 4. **Enter Owner ID:** In the "Owner ID (Optional)" field, enter the Pipedrive user ID of the owner whose leads you want to import. You can typically find a user's ID in the Pipedrive user management settings or through the Pipedrive API. 5. **Generate Report:** Click the button to generate the report. Uniquery will import only the leads owned by the specified user. By selecting different resources and using the optional owner ID filter, you can build a variety of reports in Google Sheets to analyze your Pipedrive data and gain valuable insights into your sales performance. # PostgreSQL Uniquery allows you to connect to your PostgreSQL databases directly from Google Sheets, enabling seamless data import and analysis. This guide will walk you through the steps to create a PostgreSQL database connection report using the Uniquery addon. ### **Navigating to the Database Connection Report Page** To begin, open Google Sheets and navigate to Extensions > Uniquery to open the addon. In the Uniquery sidebar, click on the Create button and select Database Connection. You will be directed to the Database Connection Report page. ### **Setting Up Your Report** On the Database Connection Report page, you will find a form to configure your PostgreSQL database connection and report settings. 1. **Report Name**\ Provide a name for your report in the "Report name" field. This helps you identify the report for future reference. For example, you can name it "My PostgreSQL Import". 2. **Select OAuth Connection**\ Choose the OAuth connection for your PostgreSQL database. If you haven't set up a connection yet, follow the prompts to log in and [connect to your PostgreSQL database](/database-connection). 3. **Choose an Action**\ Select the action you want to perform with your PostgreSQL database. You have two options: * **Pull data from table**: This option allows you to import data from a specific table in your PostgreSQL database. * **Run SQL statement (INSERT only)**: This option allows you to run an SQL statement (INSERT only) on your PostgreSQL database. 4. **Configure Table Name or SQL Statement** * If you selected "Pull data from table", provide the name of the table you want to import data from in the "Table name" field. * If you selected "Run SQL statement (INSERT only)", provide the SQL statement you want to execute in the "SQL statement" field. Note that currently only the SELECT query method is supported. **Need Help?** If you need assistance with your PostgreSQL database connection, click on the "Need Help" link. This will provide you with additional resources and support for connecting to your PostgreSQL database. **Save and run** Once you have configured all the necessary settings, save your report. Finally, execute the report to import data from your PostgreSQL database into Google Sheets. By following these steps, you can easily connect to your PostgreSQL database and create customized reports using Uniquery in Google Sheets. This enables you to manage and analyze your data efficiently, leveraging the powerful capabilities of both PostgreSQL and Google Sheets. # MySQL Uniquery allows you to connect to your MySQL databases directly from Google Sheets, enabling seamless data import and analysis. This guide will walk you through the steps to create a MySQL database connection report using the Uniquery addon. ### Navigating to the Database Connection Report Page To begin, open Google Sheets and navigate to Extensions > Uniquery to open the addon. In the Uniquery sidebar, click on the Create button and select Database Connection. You will be directed to the Database Connection Report page. ### Setting Up Your Report On the Database Connection Report page, you will find a form to configure your MySQL database connection and report settings. #### Report Name Provide a name for your report in the "Report name" field. This helps you identify the report for future reference. For example, you can name it "My MySQL Import". #### Select OAuth Connection Choose the OAuth connection for your MySQL database. If you haven't set up a connection yet, follow the prompts to log in and [connect to your MySQL database](/database-connection). #### Choose an Action Select the action you want to perform with your MySQL database. You have two options: * Pull data from table: This option allows you to import data from a specific table in your MySQL database. * Run SQL statement (INSERT only): This option allows you to run an SQL statement (INSERT only) on your MySQL database. #### Configure Table Name or SQL Statement If you selected "Pull data from table", provide the name of the table you want to import data from in the "Table name" field.\ If you selected "Run SQL statement (INSERT only)", provide the SQL statement you want to execute in the "SQL statement" field. Note that currently only the SELECT query method is supported. ### Need Help? If you need assistance with your MySQL database connection, click on the "Need Help" link. This will provide you with additional resources and support for connecting to your MySQL database. ### Save and run Once you have configured all the necessary settings, save your report. Finally, execute the report to import data from your MySQL database into Google Sheets. By following these steps, you can easily connect to your MySQL database and create customized reports using Uniquery in Google Sheets. This enables you to manage and analyze your data efficiently, leveraging the powerful capabilities of both MySQL and Google Sheets. # Create your first API query Welcome to Uniquery, your go-to Google Sheets add-on for effortlessly importing API data straight into your spreadsheets. Whether you’re a seasoned developer or a data enthusiast, Uniquery simplifies the process of fetching and managing API data, right from your Google Sheets environment. Follow the steps below to create your first API query: ### Open Uniquery 1. Launch your Google Sheets document. 2. Navigate to the **Extensions** menu located in the top toolbar. 3. Scroll down to **Uniquery** and select it from the dropdown menu to open the Uniquery add-on panel on your sheet. ### Create a New Query 1. In the Uniquery panel, find and click on the **Create query** button located in the top menu. 2. A new query configuration window will open. <figure><img src="/files/0pIOv9R5NbV2wWfnmT1u" alt=""><figcaption></figcaption></figure> ### Configure Your API Query You will now enter the details of the API request you wish to make. Here’s a brief on what to input: 1. **Method**: Select the HTTP method of your API request (GET, POST, PUT, DELETE, etc.). 2. **URL**: Enter the full API endpoint URL you are querying. 3. **Headers**: If the API requires any headers (like authentication tokens), click on the “Add Header” button and enter the key-value pairs as needed. 4. **Request Body** (for methods that require it, like POST or PUT): Input the JSON or form-encoded data you want to send with your request. <figure><img src="/files/SU3B8A8Pe6KvAwWop1KR" alt=""><figcaption></figcaption></figure> #### Preview Your Query 1. After filling in the necessary API data, click on the **Preview** button to open a popup window displaying the expected result of your query. 2. This step is crucial to ensure that your query is correctly set up and returning the data you expect. <figure><img src="/files/ksIMQ5ohO0CiNZ47LxVV" alt=""><figcaption></figcaption></figure> #### Save and Run Your Query 1. If you’re satisfied with the preview and ready to fetch the data: * Click on the **Save and Run** button. * This action will save your query configuration for future use. * Your query will then be executed, and the data will be imported into the current spreadsheet. <figure><img src="/files/CTmABYkKkSVlFhsauBkY" alt=""><figcaption></figcaption></figure> Congratulations! You’ve now successfully created and executed your first API query with Uniquery. The data should now be visible in your Google Sheet. #### Additional Tips: * **Experiment with Different APIs**: Use Uniquery to connect with various APIs to explore and import a wide range of data into your sheets. * **Manage Your Queries**: All your saved queries can be managed within the Uniquery panel. You can run them again or edit them as needed. Should you have any questions or require further assistance, feel free to consult the Uniquery help documentation or reach out to our support team. # Import Facebook Ads data In this post, we will go through how to begin importing Facebook Ads into Google Sheets using Uniquery, ensuring that your marketing analysis is as smooth and efficient as possible. ### What is Uniquery? <a href="#what-is-uniquery" id="what-is-uniquery"></a> Uniquery revolutionizes the way marketers handle data from Facebook Ads by providing a direct pipeline into Google Sheets. This powerful Google Sheets add-on negates the need for manual data exports and dashboard reconstructions, making real-time data analysis not only possible but easily achievable. With Uniquery, you can create Facebook Ads performance reports with one click with your desired metrics and data dimensions, and schedule your report data to be automatically refreshed every hour, day, or week. ### Installing Uniquery Uniquery is a [Google Sheets addon](https://workspace.google.com/marketplace/app/uniquery_facebook_shopify_notion_data_co/275511172491). Here’s a straightforward process to get you started: **1. Open a New Spreadsheet**: [Launch Google Sheets and start with a fresh spreadsheet](https://sheet.new/). **2. Navigate to Extensions**: From the Google Sheets menu, select ‘Extensions’, then choose ‘Add-ons’ > ‘Get add-ons’. <br> <figure><img src="/files/gx0p9p6GLZK8y3I5p5ws" alt=""><figcaption></figcaption></figure> **3. Search in Google Workspace Marketplace**: In the search bar, type “Uniquery” and select the first app that appears. <figure><img src="/files/c0myiubfAP49s9iIowvH" alt=""><figcaption></figcaption></figure> **4. Install Uniquery**: Follow the on-screen prompts to install the add-on. **5. Launch Uniquery**: Post-installation, you can access Uniquery from the ‘Extensions’ tab, where it’s listed as an add-on. <figure><img src="/files/jQnZNfeRGsOYr5yEEHag" alt=""><figcaption></figcaption></figure> ### Authorizing Uniquery for Facebook Ads Data Import Before importing any data, you need to authorize Uniquery to access your Facebook Ads account: <figure><img src="/files/iKZKlhgTnA5dOmCSW7rR" alt=""><figcaption></figcaption></figure> 1. **Open Uniquery Sidebar**: In the sidebar of your spreadsheet, launch Uniquery. 2. **Link Your Facebook Account**: Navigate to Create > Manage Connections via the menu icon, click ‘Add Connection’, and select Facebook for linkage. 3. **Authorize Connection**: Follow the prompts, log in to your Facebook account, and authorize Uniquery to access your ad data. **Importing Facebook Ads Data into Google Sheets** Now that Uniquery is set up and authorized, you’re ready to import Facebook Ads data: On the top Create menu, select “Create report”, and on the next page, select Facebook Ads. Now you can see the Facebook Ads report configuration page. <figure><img src="/files/mepuN4EHA5CL8BxW6lWs" alt=""><figcaption></figcaption></figure> The first step of creating a Facebook Ads report is to select a date range for the report. In this example, we will select the date range of “Month to date,” meaning that the report will contain data from the first day of the current month to today. Please remember whatever date you choose here will become relative. When the data refreshes in the next month, you will get the next month’s “Month to date” data. The second step of creating a Facebook Ads report in Google Sheets involves selecting the reporting metrics and dimensions. This is important as it defines the type of data you’ll be analyzing and presenting in your report. **Metrics** <figure><img src="/files/bEJztdJitZOHIYhi9TyZ" alt=""><figcaption></figcaption></figure> Metrics refer to the quantitative measurements of your Facebook Ads performance. These are numerical data points that tell you how your campaigns are performing in terms of achieving your marketing objectives. Examples of metrics you might consider including in your report are: * **Clicks**: The total number of clicks on your ads. It’s a direct indicator of how engaging your ads are. * **Impressions**: The number of times your ads were on screen. This helps you understand the reach of your ads. * **Spend**: The total amount of money spent on your ads during the selected date range. It’s crucial for tracking your advertising budget. * **Conversions**: The number of times users took a desired action after clicking on your ad. This could range from making a purchase, signing up for a newsletter, or any other goal you’ve set. * **Cost per Action (CPA)**: The average cost for each action (conversion) taken. This metric helps you evaluate the cost-effectiveness of your ads. **Dimensions** <figure><img src="/files/hUFPtGgrM9fgZr6EPiUm" alt=""><figcaption></figcaption></figure> Dimensions, on the other hand, provide context to your metrics. They are the qualitative aspects of your data that help you segment and break down your metrics for deeper insights. Examples of dimensions to include in your Facebook Ads report might be: * **Campaign**: Grouping metrics by campaign allows you to see which campaigns are performing best. * **Ad Set**: Provides insights into which sets of ads within campaigns are driving performance. * **Ad**: Breaks down performance to the individual ad level, showing which specific ads are most effective. * **Demographics**: Including dimensions such as age, gender, or location, can help you understand who your ads are reaching and how different groups are responding. By selecting a combination of metrics and dimensions, you can tailor your Facebook Ads report to provide a comprehensive analysis of your campaigns’ performance. The key is to choose metrics and dimensions that align with your specific business goals and objectives, ensuring that the report you create in Google Sheets using Uniquery delivers actionable insights. In the final step, you will be able to choose a metric that you want to sort the report by. You can choose a metric and sort the result by descending or ascending order. <figure><img src="/files/eO79wbALgEKQYfYEfIs7" alt=""><figcaption></figcaption></figure> ### Preview and run report Once you have configured your Facebook Ads report, you can preview it before importing data into Google Sheets. <figure><img src="/files/YEAe9WYLrcdaEoPsLiCl" alt=""><figcaption></figcaption></figure> If the result doesn’t exactly look like the data you want, you can simply close the preview window and change configurations on the sidebar, and preview the result again, until you are happy with the data you get. Once this is done, close the preview window and click “Run report”. <figure><img src="/files/gF3a8kwNRCcDye7SxURc" alt=""><figcaption></figcaption></figure> You will then be asked to choose a sheet(tab) and a cell to insert your data. We recommend the following setup: * Always use a standalone sheet(tab) for data imported. * Always insert the data from the A1 cell of a blank sheet. This setup will prevent your existing data from being overwritten by the imported data. In this example, we created a sheet called “data-sheet” and chose the A1 cell in that sheet for the Facebook Ads data import. **Scheduling Automatic Refreshes** After creating the report in Google Sheets using Uniquery, you have the option to schedule the report for automatic refreshes. This feature ensures that your report always contains the most up-to-date data without requiring manual updates. You can set up the report to refresh on an hourly, daily, or weekly basis, depending on your needs and how frequently your data changes. <figure><img src="/files/pCN5tHshc2aKFMReIcNB" alt=""><figcaption></figcaption></figure> If your data requires constant monitoring, you may opt for hourly refreshes. For reports that track longer-term trends, daily or weekly refreshes might be more appropriate. Once you have selected your preferred frequency, confirm your choice, and the system will automatically take care of the rest. Your report will refresh at the interval you’ve selected, ensuring that every time you access your report, you’re looking at the most current data available. Remember to consider the volume of data being processed and the potential impact on performance when choosing your refresh frequency. In some cases, less frequent refreshes (such as daily or weekly) may be more suitable to avoid system overload, especially for reports that aggregate large amounts of data. #### Conclusion Integrating Facebook Ads data into Google Sheets has never been easier, thanks to Uniquery. By following the steps outlined above, marketers can now efficiently analyze ad performance, gain impactful insights, and drive better decision-making. Uniquery’s simplicity and accessibility make it an indispensable tool in the arsenal of digital marketers focused on data-driven strategies. With your Facebook Ads data seamlessly integrated into Google Sheets, the possibilities for sophisticated analysis and actionable insights are limitless.<br> # Connect to Notion Integrating Notion with Google Sheets is a powerful way to automate and streamline your workflow, saving you time and effort. Uniquery, a versatile Google Sheets API connector, facilitates this integration by allowing you to create API queries with OAuth2 connections easily. This guide will walk you through the steps of connecting your Google Sheets to your Notion workspace via Uniquery. ### Step 1: Open the Uniquery Add-on 1. Open your Google Sheets document. 2. Go to the **Extensions** menu at the top toolbar. 3. Find **Uniquery** in the dropdown list and click to open the add-on panel within Google Sheets. ### Step 2: Create an OAuth2 Connection 1. Within the Uniquery panel, locate and open the menu to **Create “OAuth2 connection”**. <figure><img src="/files/ZVQOPpmsYUPjuUnEuVRl" alt=""><figcaption></figcaption></figure> * This option is designed to securely manage the authentication required to connect with external services like Notion. ### Step 3: Connect to Notion 1. In the list of available OAuth2 connections, expand the **Notion** option. 2. Click on **“Add connection”**. This action prompts Notion’s authorization process to start. ### Step 4: Authorize Uniquery in Notion 1. A pop-up window will appear, initiating the authorization process for your Notion workspace. 2. Log in to your Notion account if not already logged in. 3. **Choose the pages and databases** you wish to allow Uniquery access to. It’s important to select only the databases you plan to interact with through your Google Sheets. 4. Confirm your selections and grant the necessary permissions. <figure><img src="/files/YnPy6FzOYtmEsLQ5lo4a" alt=""><figcaption></figcaption></figure> ### Step 5: Finalize the Connection 1. After successfully authorizing Uniquery, the pop-up will close, and your Notion workspace should now be listed under your **OAuth2 connections** in the Uniquery panel. <figure><img src="/files/jSPL0HWjttYTZm9KKlk4" alt=""><figcaption></figcaption></figure> 1. You’ve now successfully established a link between your Google Sheets and Notion workspace. ### Step 6: Use the Authorization in API Queries 1. With the Notion workspace connected, you can proceed to create API queries that interact with your Notion data. 2. Go to the **Create query** editor page within the Uniquery panel. 3. Here, you’ll have the option to select your newly-established Notion OAuth2 connection for your queries. 4. Upon selection, Uniquery will automatically handle the OAuth2 authorization headers, streamlining the process of querying your Notion data. <figure><img src="/files/BNBtXDqYp7uHkxthL14j" alt=""><figcaption></figcaption></figure> By following these steps, you can now seamlessly integrate and manipulate your Notion databases from within Google Sheets using Uniquery. This connection not only optimizes your productivity but also opens a myriad of possibilities for managing and analyzing your Notion data more efficiently. Remember, with great power comes the responsibility to manage your connections and data securely. Always ensure that you authorize only the necessary access and keep your OAuth2 connections updated. # Multiple account issues ### 1. What if I see the "Multiple accounts detected" page? <figure><img src="/files/VBQlAn5pGJs9dr375giL" alt=""><figcaption></figcaption></figure> If you encounter the "Multiple accounts detected" page while using Uniquery, it is likely that you are logged into multiple Google accounts within the same browser profile. This situation can cause certain features of Uniquery to stop functioning correctly, as it is [a known issue with Google Sheets](https://developers.google.com/apps-script/guides/projects#fix-issues) and affects all Google Sheets add-ons. **Here’s what is happening:** When you are logged into multiple Google accounts within a single browser profile, Google Sheets can get confused about which account to use for the add-on, leading to inconsistent or non-functional behavior. This is due to the way Google handles authentication and session management across its services. **To resolve this problem, you can try one of the following methods:** First, consider creating a dedicated browser profile for your current Google account and use Uniquery exclusively within that profile. By ensuring that only one Google account is logged into that dedicated profile, you can avoid conflicts and ensure the smooth operation of Uniquery. To create a new browser profile, follow these steps to ensure that Uniquery operates smoothly without any conflicts from multiple logged-in Google accounts:<br> 1. **Open Your Browser**: Launch the web browser where you use Uniquery, such as Google Chrome.<br> 2. **Access Profile Settings**: In the upper-right corner of the browser window, you will see your current profile icon (usually an avatar or the first letter of your name). Click on this icon to open the profile menu.<br> 3. **Manage Profiles**: In the profile menu, look for the option that says "Manage profiles" or "Add another account." Click on this option to proceed.<br> 4. **Create a New Profile**: You will be directed to a screen where you can manage existing profiles or create a new one. Click on the "Add" button to create a new profile.<br> 5. **Set Up Your New Profile**: You will be prompted to choose a name and an avatar for your new profile. Fill in these details and click "Add." This will create a new browser profile.<br> 6. **Log Into Your Google Account**: Once the new profile is created, a new browser window will open with the new profile. In this window, navigate to Google and log into the Google account you wish to use with Uniquery. Ensure that no other Google accounts are logged in within this profile. Alternatively, you can log out of any other Google accounts from your current browser profile. This will help eliminate any confusion caused by multiple active sessions and allow Uniquery to properly authenticate with your intended Google account. If you continue to experience issues after trying these methods, please do not hesitate to contact our support team for further assistance. We are here to help and will work with you to ensure that you can use Uniquery without any interruptions. ### 2. When I try to connect to another Google account in account connection, I see a 401 error or "too many redirects" error. This issue arises when you are logged into one Google account (your primary account) but attempt to connect to a Google service (such as Google Ads or Google Analytics) that belongs to a different Google account. As a result, you may encounter a 401 error or a "This page redirected you too many times" error. To illustrate, imagine you are using Uniquery through the Google account <abc@gmail.com>, but you want to connect to the Google Ads account of <xyz@gmail.com>. You are likely to experience this error because Google Chrome is unable to distinguish which user is making the request, leading to authentication conflicts. This problem shares the same root cause as the "multiple user account" issue, where Google's session management becomes confused. To resolve this problem, follow these steps:<br> 1. **Create a Separate Chrome Profile:** Open a standalone Chrome profile dedicated to the Google account <xyz@gmail.com>. Ensure that only <xyz@gmail.com> is logged into this new profile. 2. **Connect Uniquery with the Desired Account:** Use the Manage Connections feature in Uniquery to connect with the Google Ads account of <xyz@gmail.com>. Once you have established the connection, click on "export connection." This action will copy a connection string to your clipboard. 3. **Switch Back to Your Primary Profile:** Open the standalone Chrome profile for your primary account <abc@gmail.com>, ensuring that only <abc@gmail.com> is logged into this profile. 4. **Import the Connection:** Go to the Manage Connections feature in Uniquery and import the connection string that you copied earlier. This will allow you to use the Google Ads connection belonging to <xyz@gmail.com> from within your primary account. By following these steps, you can successfully manage and use connections across different Google accounts without encountering errors. If you need further assistance, please feel free to contact our support team. We are here to help you make the most of Uniquery, your trusted marketing data platform. # Account and license ### 1. **Can I Change the Email Address Associated with My Uniquery License?** Yes, you can change the email address associated with your Uniquery license. If you initially signed up with one email address but need to access your account through another email, we can assist you with the transition. First, you'll need to create a new account using your desired email address. To do this, simply visit our website at <https://app.uniquery.io/> and log in using Google with your new email address. Once you have created the new account, please reply to us with a confirmation that the new account has been set up. After we've received confirmation of your new account, we will proceed to migrate your license to the new email address. This process ensures that you can seamlessly continue to access and utilize Uniquery for all your reporting needs under your professional email. # Data security ### Does Uniquery store my imported data on its servers? No, Uniquery does not store your imported data on its servers. All your data is stored directly in your Google Sheets. We prioritize your data privacy and security, ensuring that none of the imported data is stored on our servers. By keeping your data within your Google Sheets, you have full control over your information and can manage it as you see fit. No other parties, including Uniquery, can view your imported data without your permission. Uniquery acts as a conduit, facilitating the seamless transfer of data from various sources directly into your Google Sheets. This method minimizes the risk of data exposure or unauthorized access since your data does not pass through or reside on third-party servers. By leveraging the security infrastructure of Google Sheets, you can be confident that your data is protected by Google's robust security measures. ### **How Does Uniquery Handle My Account Connections, API Keys, and Credentials?** Uniquery securely stores your account connections, API keys, and credentials within your Google account. We utilize [Google Sheets' user property storage](https://developers.google.com/apps-script/guides/properties) feature to keep this information safe. This means that your credentials are stored "locally" within your Google account, and we do not have access to them. Only you can access and use these credentials, ensuring that your sensitive information remains protected and private. This approach provides an additional layer of security, as your credentials do not leave your Google account and cannot be accessed by anyone else, **including Uniquery**. ### **FAQ: Is My Data Secure When Using Uniquery?** Yes, your data is secure when using Uniquery. We do not store any of your imported data on our servers; it is all kept within your Google Sheets. Additionally, your account connections, API keys, and credentials are stored securely in your Google account using Google Sheets' user property storage feature. This approach ensures that only you have access to your credentials and that your data remains safe and private. We are committed to maintaining the highest standards of data security and privacy for our users. ### What Happens to My Data If I Stop Using Uniquery? If you decide to stop using Uniquery, your data remains secure and under your control in your Google Sheets. Since Uniquery does not store any of your imported data on its servers, all your data will continue to reside in your Google Sheets. This means that you retain full ownership and control over your data, and it will not be affected by your decision to discontinue using Uniquery. Your account connections, API keys, and credentials will be deleted from your Google Sheets and no one else will be able to access them.