Skip to Content

Google Ads Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8804 of the connector.

Get Started

Google Ads Version Support

The connector provides a relational view of Google Ads data for your Google account or Google Apps domain. The connector includes tables containing often-used dimensions and metrics; you can customize the table schemas or write your own to combine any valid set of dimensions and metrics.

Establish a Connection

Connect to Google Ads

Before you can add the properties needed to authenticate, you must provide the following connection properties:

  • DeveloperToken: The account developer token.
  • ClientCustomerId: Your Google Ads customer ID. To find your ClientCustomerId, click the Help icon at the upper right corner of the Google Ads UI, then look at the bottom of the help menu.
Retrieve Data from Multiple Accounts

A common use for the driver is retrieving data from multiple customer Ids. This is useful when you have a Google Ads MCC account that includes numerous accounts/ClientCustomerIds. You can query and get data from the accounts you want by specifying CustomerId in the WHERE clause. For example:

SELECT * FROM AdGroupAd WHERE CustomerId='3333333333'

SELECT * FROM AdGroupAd WHERE CustomerId IN ('1111111111', '2222222222')

When you specify the CustomerId in WHERE clauses, the driver ignores the ClientCustomerId connection property.

Authenticate to Google Ads

All connections to Google Ads are authenticated using OAuth. The connector supports using user accounts, service accounts and GCP instance accounts for authentication.

User Accounts (OAuth/OauthPKCE)

Google Ads provides embedded OAuth credentials that simplify connection from a Desktop application

. To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Google Ads from the available oauth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Google Ads, see Connection.

Desktop Applications

provides an embedded OAuth application that simplifies authentication at the desktop; that is, in situations where the user is using a local server not connected to the internet.

You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Google Ads console. For further information, see Creating a Custom OAuth Application.

Before you connect, set these properties:

  • InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
  • Custom OAuth applications only:
    • OAuthClientId: The client ID assigned when you registered your custom OAuth application.
    • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
    • CallbackURL: The redirect URI defined when you registered your custom OAuth application.

When you connect, the connector opens Google Ads's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the connector completes the OAuth process:

  1. Obtains an access token from Google Ads and uses it to request data.
  2. Saves the OAuth values in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Service Accounts (OAuthJWT)

To authenticate using a service account, you must create a new service account and have a copy of the account's certificate.

For a JSON file, set these properties:

  • AuthScheme: Set this to OAuthJWT.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthJWTCertType: Set this to GOOGLEJSON.
  • OAuthJWTCert: Set this to the path to the .json file provided by Google.
  • OAuthJWTSubject:The service account should be part of a GSuite domain, with delegation enabled. The value of this property should be the email address of the user whose data you want to access.

For a PFX file, set these properties:

  • AuthScheme: Set this to the email address of the service account. This address usually includes the domain iam.gserviceaccount.com.
  • OAuthJWTSubject: The service account must part of a GSuite domain, with delegation enabled. The value of this property is the email address of the user whose data you want to access.

If you do not already have a service account, you can create one by following the procedure in Creating a Custom OAuth Application.

GCP Instance Accounts

When running on a GCP virtual machine, the connector can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.

Create a Custom OAuth Application

Create a Custom OAuth Application

embeds OAuth Application Credentials with branding that can be used when connecting to Google Ads via a desktop application or a headless machine.

(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Google Ads".)

However, you must create a custom OAuth application to connect to Google Ads via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway. Custom OAuth applications are useful if you want to:

  • control branding of the authentication dialog;
  • control the redirect URI that the application redirects the user to after the user authenticates; or
  • customize the permissions that you are requesting from the user.

Custom applications work with both OAuth and OAuthPKCE authschemes.

The following sections describe how to enable the Directory API and create custom OAuth applications for user accounts (OAuth/OAuthPKCE) and Service Accounts (OAuth/JWT).

User Accounts (OAuth/OAuthPKCE)

For users whose AuthScheme is OAuth or OAuthPKCE, and who need to authenticate over a web application, you must always create a custom OAuth application. (For desktop and headless flows, creating a custom OAuth application is optional.)

Do the following:

  1. Navigate to the Google Cloud Console.
  2. Create a new project or select an existing project.
  3. At the left-hand navigation menu, select Credentials.
  4. If this project does not already have a consent screen configured, click CONFIGURE CONSENT SCREEN to create one. If you are not using a Google Workspace account, you are restricted to creating an External-type Consent Screen, which requires specifying a support email and developer contact email. Additional info is optional.
  5. On the Credentials page, select Create Credentials > OAuth Client ID.
  6. In the Application Type menu, select Web application.
  7. Specify a name for your custom OAuth application.
  8. Under Authorized redirect URIs, click ADD URI and enter a redirect URI.
  9. Click Enter, then CREATE. The Cloud Console returns you to the Credentials page.
  10. The Google Cloud Console opens a window that displays your client ID and client secret. Record the client ID and Client Secret for later use.

Note

The client secret remains accessible from from the Google Cloud Console.

Service Accounts (OAuthJWT)

Service accounts (AuthScheme OAuthJWT) are used in an OAuth flow to access Google APIs on behalf of users in a domain. A domain administrator can delegate domain-wide access to the service account.

To create a new service account:

  1. Navigate to the Google Cloud Console.

  2. Create a new project or select an existing project.

  3. At the left-hand navigation menu, select Credentials.

  4. Select Create Credentials > Service account.

  5. On the Create service account page, enter the Service account name, and the Service account ID. If desired, enter a description.

  6. Click DONE. The Cloud Console redisplays the Credentials page.

  7. In the Service Accounts section, select the service account you just created.

  8. Click the KEYS tab.

  9. Click ADD KEY > Create new key.

  10. Select any supported Key type (see OAuthJWTCert and OAuthJWTCertType).

  11. Click CREATE. The key is automatically downloaded to your device, and any additional information specific to the key is displayed.

    Record the additional information for future use.

  12. To complete the service account flow, generate a private key in the Google Cloud Console. In the service account flow, the driver exchanges a JSON Web token (JWT) for the OAuthAccessToken. The private key is required to sign the JWT; using it gives the driver the same permissions as those that were granted to the service account.

Fine-Tuning Data Access

Customize Google Ads Behavior

Use QueryPassthrough

Google Ads has its own query language (GAQL) that allow you to execute queries not supported by SQL-92 standard dialect which the driver uses by default. To execute these queries, set QueryPassthrough to True in order to bypass the SQL engine of the connector and execute GAQL queries to Google Ads. By default, queries are sent as-is to Google Ads.

Using QueryPassthrough with GAQL allows fine-tuned control while querying. When QueryPassthrough is True, the use must validate that queries are being built using the native dialect of the data source. It is recommended to have QueryPassthrough set to False in the connection manager when creating tables using this method.

Use APIVersion

This connection property controls the Google Ads APIVersion, defaulting currently to v8. The lastest Google Ads API version can be found in the Google Ads API documentation.

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Google Ads connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Google Ads and then processes the rest of the query in memory (client-side).

User Defined Views

The Google Ads connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM CampaignPerformance WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

Overview

The Google Ads connector models Google Ads entities in relational views and stored procedures. The provided views will give you access to your Google Ads data using the Google Ads API. The Google Ads connector for Google Ads models Google Ads entities in relational views and stored procedures. The provided views give you access to your Google Ads data using the Google Ads API.

Key Features

  • The connector models Google Ads entities like documents, folders, and groups as relational views, allowing you to write SQL to query Google Ads data.
  • Stored procedures allow you to execute operations to Google Ads.
  • Predefined Report views to make access to data easier.
  • Live connectivity to these objects means any changes to your Google Ads account are immediately reflected when using the connector.

Views

Views describes the available views. Two types of views are made available:

  • Base Views are statically defined to model Campaigns, AdGroups, Customers, and more. They are used to create your custom reports instead of being used standalone. By default. these views return data from all time aggregated into a single row.
  • Predefined Report Views are a set of standard reports that mimic exactly what you see in the Google Ads UI. All Predefined Report Views have "report" appended to their name. By default, these views return data from all time with a daily breakdown.

The Resources view shows the names of the resources, attribute resources and segmenting resources, which you need for the CreateReportSchema stored procedure.

Stored Procedures

Stored Procedures are function-like interfaces to Google Ads. They allow you to execute operations to Google Ads, the most important being CreateReportSchema, which is used to create views from resources (like 'distance_view') with attribute resources (like 'customer' in this case) and segmenting resources (like 'campaign' in this case).

Date Ranges and Aggregation

All tables and views support date ranges and aggregation.

Date Ranges

Date ranges can be defined in the WHERE clause using the Date field using =, <,>, between delimiters.

Additional predefined date fields are available, specifically:

  • week
  • month
  • quarter

When filtering on these, you can use the = operator with the date set to the first day of the time period. If you specify a different date, an error is returned.

For example, to specify the month of May in the year 2022, use the following condition, specifying the first day of that month:

month = '2022-05-01'

Aggregation

Aggregation can be applied at multiple levels:

“Date” returns daily data in the query results. For example,

SELECT CampaignBaseCampaign, CampaignName, CampaignStartDate, CampaignEndDate , Impressions, Clicks, "Date" FROM .GoogleAds.Campaign WHERE "Date" BETWEEN '2022-01-01' and '2023-01-31' and CampaignId = '17999934124'

“Hour” returns data aggregated by hour across the date range selected. For example, querying two years of data and selecting “Hour” returns 24 rows of data (one for each hour) with two years of data aggregated for each hour.

“DayofWeek” returns data aggregated by week across the date range selected. For example, querying two years of data and selecting “DayOfWeek” returns seven rows of data (one for each day) with two years of data aggregated for each day.

“Week” returns data aggregated by week across the date range selected. For example, querying two years of data and selecting “Week” returns 104 rows of data (one for each week) with data aggregated for each week.

“Month” returns data aggregated by month across the date range selected. For example, querying two years of data and selecting “Month” returns 24 rows of data (one for each month) with data aggregated for each month.

“MonthofYear” returns data aggregated by month across the date range selected. For example, querying two years of data and selecting “MonthofYear” returns 12 rows of data (one for each month) with two years of data aggregated for each month.

“Quarter” returns data aggregated by quarter across the date range selected. For example. querying two years of data and selecting “Quarter” return eight rows of data (one for each quarter). Note that a Quarter is defined as starting on the 1st of the month of January, April, July, and October.

“Year” returns data aggregated by year across the date range selected. For example, querying two years of data and selecting “Year” returns two rows of data (one for each year) with data aggregated by year.

Note

Selecting "Date" overrides any other date metric. It always returns daily data only.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Name Description
AccessibleBiddingStrategy Represents a view of BiddingStrategies owned by and shared with the customer. In contrast to BiddingStrategy, this resource includes strategies owned by managers of the customer and shared with this customer - in addition to strategies owned by this customer. This resource does not provide metrics and only exposes a limited subset of the BiddingStrategy attributes.
AccountBudget An account-level budget. It contains information about the budget itself, as well as the most recently approved changes to the budget and proposed changes that are pending approval. The proposed changes that are pending approval, if any, are found in 'pending_proposal'. Effective details about the budget are found in fields prefixed 'approved_', 'adjusted_' and those without a prefix. Since some effective details may differ from what the user had originally requested (for example, spending limit), these differences are juxtaposed through 'proposed_', 'approved_', and possibly 'adjusted_' fields. This resource is mutated using AccountBudgetProposal and cannot be mutated directly. A budget may have at most one pending proposal at any given time. It is read through pending_proposal. Once approved, a budget may be subject to adjustments, such as credit adjustments. Adjustments create differences between the 'approved' and 'adjusted' fields, which would otherwise be identical.
AccountBudgetProposal An account-level budget proposal. All fields prefixed with 'proposed' may not necessarily be applied directly. For example, proposed spending limits may be adjusted before their application. This is true if the 'proposed' field has an 'approved' counterpart, for example, spending limits. Note that the proposal type (proposal_type) changes which fields are required and which must remain empty.
AccountHourlyStatsReport Account-level performance stats by Ad Network and Device. Hourly data is returned with a default date range of the last 7 days not including today.
AccountLink Represents the data sharing connection between a Google Ads account and another account
AccountStatsReport Account-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
AdGroup An ad group.
AdGroupAd An ad group ad.
AdGroupAdAssetCombinationView A view on the usage of ad group ad asset combination. Now we only support AdGroupAdAssetCombinationView for Responsive Search Ads, with more ad types planned for the future.
AdGroupAdAssetView A link between an AdGroupAd and an Asset. Currently we only support AdGroupAdAssetView for AppAds and Responsive Search Ads.
AdGroupAdLabel A relationship between an ad group ad and a label.
AdGroupAsset A link between an ad group and an asset.
AdGroupAssetSet AdGroupAssetSet is the linkage between an ad group and an asset set. Creating an AdGroupAssetSet links an asset set with an ad group.
AdGroupAudienceView An ad group audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated at the audience level.
AdGroupBidModifier Represents an ad group bid modifier.
AdGroupCriterion An ad group criterion.
AdGroupCriterionCustomizer A customizer value for the associated CustomizerAttribute at the AdGroupCriterion level.
AdGroupCriterionLabel A relationship between an ad group criterion and a label.
AdGroupCriterionSimulation An ad group criterion simulation. Supported combinations of advertising channel type, criterion type, simulation type, and simulation modification method are detailed below respectively. Hotel AdGroupCriterion simulation operations starting in V5. 1. DISPLAY - KEYWORD - CPC_BID - UNIFORM 2. SEARCH - KEYWORD - CPC_BID - UNIFORM 3. SHOPPING - LISTING_GROUP - CPC_BID - UNIFORM 4. HOTEL - LISTING_GROUP - CPC_BID - UNIFORM 5. HOTEL - LISTING_GROUP - PERCENT_CPC_BID - UNIFORM
AdGroupCustomizer A customizer value for the associated CustomizerAttribute at the AdGroup level.
AdGroupExtensionSetting An ad group extension setting.
AdGroupFeed An ad group feed.
AdGroupHourlyStatsReport Ad Group-level performance stats by Ad Network and Device. Hourly data is returned with a default date range of the last 7 days not including today.
AdGroupLabel A relationship between an ad group and a label.
AdGroupSimulation An ad group simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively. 1. SEARCH - CPC_BID - DEFAULT 2. SEARCH - CPC_BID - UNIFORM 3. SEARCH - TARGET_CPA - UNIFORM 4. SEARCH - TARGET_ROAS - UNIFORM 5. DISPLAY - CPC_BID - DEFAULT 6. DISPLAY - CPC_BID - UNIFORM 7. DISPLAY - TARGET_CPA - UNIFORM
AdGroupStatsReport Ad Group-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
AdParameter An ad parameter that is used to update numeric values (such as prices or inventory levels) in any text line of an ad (including URLs). There can be a maximum of two AdParameters per ad group criterion. (One with parameter_index = 1 and one with parameter_index = 2.) In the ad the parameters are referenced by a placeholder of the form '{param#:value}'. For example, '{param1:$17}'
AdScheduleView An ad schedule view summarizes the performance of campaigns by AdSchedule criteria.
AdStatsReport Ad-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
AgeRangeView An age range view.
AndroidPrivacySharedKeyGoogleAdGroup An Android privacy shared key view for Google ad group key.
AndroidPrivacySharedKeyGoogleCampaign An Android privacy shared key view for Google campaign key.
AndroidPrivacySharedKeyGoogleNetworkType An Android privacy shared key view for Google network type key.
Asset Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YouTubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it.
AssetFieldTypeView An asset field type view. This view reports non-overcounted metrics for each asset field type when the asset is used as extension.
AssetGroup An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group.
AssetGroupAsset AssetGroupAsset is the link between an asset and an asset group. Adding an AssetGroupAsset links an asset with an asset group.
AssetGroupListingGroupFilter AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group.
AssetGroupSignal AssetGroupSignal represents a signal in an asset group. The existence of a signal tells the performance max campaign who's most likely to convert. Performance Max uses the signal to look for new people with similar or stronger intent to find conversions across Search, Display, Video, and more.
AssetGroupTopCombinationView A view on the usage of ad group ad asset combination.
AssetSet An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set.
AssetSetAsset AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set.
AssetSetTypeView An asset set type view. This view reports non-overcounted metrics for each asset set type. Child asset set types are not included in this report. Their stats are aggregated under the parent asset set type.
Audience Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.
AudienceStatsReport Audience-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
BatchJob A list of mutates being processed asynchronously. The mutates are uploaded by the user. The mutates themselves aren't readable and the results of the job can only be read using BatchJobService.ListBatchJobResults.
BiddingDataExclusion Represents a bidding data exclusion. See 'About data exclusions' at https://support.google.com/google-ads/answer/10370710.
BiddingSeasonalityAdjustment Represents a bidding seasonality adjustment. See 'About seasonality adjustments' at https://support.google.com/google-ads/answer/10369906.
BiddingStrategy A bidding strategy.
BiddingStrategySimulation A bidding strategy simulation. Supported combinations of simulation type and simulation modification method are detailed below respectively. 1. TARGET_CPA - UNIFORM 2. TARGET_ROAS - UNIFORM
BillingSetup A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser.
CallView A call view that includes data for call tracking of call-only ads or call extensions.
Campaign A campaign.
CampaignAsset A link between a Campaign and an Asset.
CampaignAssetSet CampaignAssetSet is the linkage between a campaign and an asset set. Adding a CampaignAssetSet links an asset set with a campaign.
CampaignAudienceView A campaign audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated by campaign and audience criterion. This view only includes audiences attached at the campaign level.
CampaignBidModifier Represents a bid-modifiable only criterion at the campaign level.
CampaignBudget A campaign budget shared amongst various budget recommendation types.
CampaignConversionGoal The biddability setting for the specified campaign only for all conversion actions with a matching category and origin.
CampaignCriterion A campaign criterion.
CampaignCustomizer A customizer value for the associated CustomizerAttribute at the Campaign level.
CampaignDraft A campaign draft.
CampaignExtensionSetting A campaign extension setting.
CampaignFeed A campaign feed.
CampaignGroup A campaign group.
CampaignHourlyStatsReport Campaign-level performance stats by Ad Network and Device. Hourly data is returned with a default date range of the last 7 days not including today.
CampaignLabel Represents a relationship between a campaign and a label.
CampaignLifecycleGoal Campaign level customer lifecycle goal settings.
CampaignSearchTermInsight A Campaign search term view. Historical data is available starting March 2023.
CampaignSharedSet CampaignSharedSets are used for managing the shared sets associated with a campaign.
CampaignSimulation A campaign simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively. * SEARCH - CPC_BID - UNIFORM * SEARCH - CPC_BID - SCALING * SEARCH - TARGET_CPA - UNIFORM * SEARCH - TARGET_CPA - SCALING * SEARCH - TARGET_ROAS - UNIFORM * SEARCH - TARGET_IMPRESSION_SHARE - UNIFORM * SEARCH - BUDGET - UNIFORM * SHOPPING - BUDGET - UNIFORM * SHOPPING - TARGET_ROAS - UNIFORM * MULTI_CHANNEL - TARGET_CPA - UNIFORM * DISCOVERY - TARGET_CPA - DEFAULT * DISPLAY - TARGET_CPA - UNIFORM * PERFORMANCE_MAX - TARGET_CPA - UNIFORM * PERFORMANCE_MAX - TARGET_ROAS - UNIFORM * PERFORMANCE_MAX - BUDGET - UNIFORM
CampaignStatsReport Campaign-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
CarrierConstant A carrier criterion that can be used in campaign targeting.
ChangeEvent Describes the granular change of returned resources of certain resource types. Changes made through the UI or API in the past 30 days are included. Previous and new values of the changed fields are shown. ChangeEvent could have up to 3 minutes delay to reflect a new change.
ChangeStatus Describes the status of returned resource. ChangeStatus could have up to 3 minutes delay to reflect a new change.
ClickView A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-Search campaigns, metrics.clicks represents the number of valid and invalid interactions. Queries including ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.
ClickViewFilteredReport A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-Search campaigns, metrics.clicks represents the number of valid and invalid interactions. Queries including ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.
CombinedAudience Describe a resource for combined audiences which includes different audiences.
ConversionAction A conversion action.
ConversionCustomVariable A conversion custom variable See 'About custom variables for conversions' at https://support.google.com/google-ads/answer/9964350
ConversionGoalCampaignConfig Conversion goal settings for a Campaign.
ConversionValueRule A conversion value rule
ConversionValueRuleSet A conversion value rule set
CurrencyConstant A currency constant.
CustomAudience A custom audience. This is a list of users by interest.
CustomConversionGoal Custom conversion goal that can make arbitrary conversion actions biddable.
Customer A customer.
CustomerAsset A link between a customer and an asset.
CustomerAssetSet CustomerAssetSet is the linkage between a customer and an asset set. Adding a CustomerAssetSet links an asset set with a customer.
CustomerClient A link between the given customer and a client customer. CustomerClients only exist for manager customers. All direct and indirect client customers are included, as well as the manager itself.
CustomerClientLink The links between customer client accounts and manager accounts
CustomerConversionGoal Biddability control for conversion actions with a matching category and origin.
CustomerCustomizer A customizer value for the associated CustomizerAttribute at the Customer level.
CustomerExtensionSetting A customer extension setting.
CustomerFeed A customer feed.
CustomerLabel Represents a relationship between a customer and a label. This customer may not have access to all the labels attached to it. Additional CustomerLabels may be returned by increasing permissions with login-customer-id.
CustomerLifecycleGoal Account level customer lifecycle goal settings.
CustomerManagerLink Represents customer-manager link relationship.
CustomerNegativeCriterion A negative criterion for exclusions at the customer level.
CustomerSearchTermInsight A Customer search term view. Historical data is available starting March 2023.
CustomerUserAccess Represents the permission of a single user onto a single customer.
CustomerUserAccessInvitation Represent an invitation to a new user on this customer account.
CustomInterest A custom interest. This is a list of users by interest.
CustomizerAttribute A customizer attribute. Use CustomerCustomizer, CampaignCustomizer, AdGroupCustomizer, or AdGroupCriterionCustomizer to associate a customizer attribute and set its value at the customer, campaign, ad group, or ad group criterion level, respectively.
DetailedDemographic A detailed demographic: a particular interest-based vertical to be targeted to reach users based on long-term life facts.
DetailPlacementView A view with metrics aggregated by ad group and URL or YouTube video.
DisplayKeywordView A display keyword view.
DistanceView A distance view with metrics aggregated by the user's distance from an advertiser's location extensions. Each DistanceBucket includes all impressions that fall within its distance and a single impression will contribute to the metrics for all DistanceBuckets that include the user's distance.
DomainCategory A category generated automatically by crawling a domain. If a campaign uses the DynamicSearchAdsSetting, then domain categories will be generated for the domain. The categories can be targeted using WebpageConditionInfo. See: https://support.google.com/google-ads/answer/2471185
DynamicSearchAdsSearchTermView A dynamic search ads search term view.
ExpandedLandingPageView A landing page view with metrics aggregated at the expanded final URL level.
Experiment A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.
ExperimentArm A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.
ExtensionFeedItem An extension feed item.
Feed A feed.
FeedItem A feed item.
FeedItemSet Represents a set of feed items. The set can be used and shared among certain feed item features. For instance, the set can be referenced within the matching functions of CustomerFeed, CampaignFeed, and AdGroupFeed.
FeedItemSetLink Represents a link between a FeedItem and a FeedItemSet.
FeedItemTarget A feed item target.
FeedMapping A feed mapping.
FeedPlaceholderView A feed placeholder view.
GenderView A gender view.
GeographicView A geographic view. Geographic View includes all metrics aggregated at the country level, one row per country. It reports metrics at either actual physical location of the user or an area of interest. If other segment fields are used, you may get more than one row per country.
GeoTargetConstant A geo target constant.
GroupPlacementView A group placement view.
HotelGroupView A hotel group view.
HotelPerformanceView A hotel performance view.
HotelReconciliation A hotel reconciliation. It contains conversion information from Hotel bookings to reconcile with advertiser records. These rows may be updated or canceled before billing through Bulk Uploads.
IncomeRangeView An income range view.
KeywordPlan A Keyword Planner plan. Max number of saved keyword plans: 10000. It's possible to remove plans if limit is reached.
KeywordPlanAdGroup A Keyword Planner ad group. Max number of keyword plan ad groups per plan: 200.
KeywordPlanAdGroupKeyword A Keyword Plan ad group keyword. Max number of keyword plan keywords per plan: 10000.
KeywordPlanCampaign A Keyword Plan campaign. Max number of keyword plan campaigns per plan allowed: 1.
KeywordPlanCampaignKeyword A Keyword Plan Campaign keyword. Only negative keywords are supported for Campaign Keyword.
KeywordStatsReport Keyword-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
KeywordThemeConstant A Smart Campaign keyword theme constant.
KeywordView A keyword view.
Label A label.
LandingPageView A landing page view with metrics aggregated at the unexpanded final URL level.
LanguageConstant A language.
LeadFormSubmissionData Data from lead form submissions.
LifeEvent A life event: a particular interest-based vertical to be targeted to reach users when they are in the midst of important life milestones.
LocalServicesLead Data from Local Services Lead. Contains details of Lead which is generated when user calls, messages or books service from advertiser. More info: https://ads.google.com/local-services-ads
LocalServicesLeadConversation Data from Local Services Lead Conversation. Contains details of Lead Conversation which is generated when user calls, messages or books service from advertiser. These are appended to a Lead. More info: https://ads.google.com/local-services-ads
LocalServicesVerificationArtifact A local services verification resource.
LocationView A location view summarizes the performance of campaigns by Location criteria.
ManagedPlacementView A managed placement view.
MediaFile A media file.
MobileAppCategoryConstant A mobile application category constant.
MobileDeviceConstant A mobile device constant.
OfflineConversionUploadClientSummary Offline conversion upload client summary.
OfflineUserDataJob A job containing offline user data of store visitors, or user list members that will be processed asynchronously. The uploaded data isn't readable and the processing results of the job can only be read using GoogleAdsService.Search/SearchStream.
OperatingSystemVersionConstant A mobile operating system version or a range of versions, depending on operator_type. List of available mobile platforms at https://developers.google.com/google-ads/api/reference/data/codes-formats#mobile-platforms
PaidOrganicSearchTermView A paid organic search term view providing a view of search stats across ads and organic listings aggregated by search term at the ad group level.
ParentalStatusView A parental status view.
PerStoreView A per store view. This view provides per store impression reach and local action conversion stats for advertisers.
ProductBiddingCategoryConstant A Product Bidding Category.
ProductCategoryConstant A Product Category.
ProductGroupView A product group view.
ProductLink Represents the data sharing connection between a Google Ads customer and another product.
ProductLinkInvitation Represents an invitation for data sharing connection between a Google Ads account and another account.
QualifyingQuestion Qualifying Questions for Lead Form.
Recommendation A recommendation.
RecommendationSubscription Recommendation Subscription resource
RemarketingAction A remarketing action. A snippet of JavaScript code that will collect the product ID and the type of page people visited (product page, shopping cart page, purchase page, general site visit) on an advertiser's website.
Resources List of resources that can be used in order to generate new Reports or re-generate the old one.
SearchTermView A search term view with metrics aggregated by search term at the ad group level.
SharedCriterion A criterion belonging to a shared set.
SharedSet SharedSets are used for sharing criterion exclusions across multiple campaigns.
ShoppingPerformanceView Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded.
SmartCampaignSearchTermView A Smart campaign search term view.
SmartCampaignSetting Settings for configuring Smart campaigns.
ThirdPartyAppAnalyticsLink A data sharing connection, allowing the import of third party app analytics into a Google Ads Customer.
TopicConstant Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, 'Pets & Animals/Pets/Dogs').
TopicView A topic view.
TravelActivityGroupView A travel activity group view.
TravelActivityPerformanceView A travel activity performance view.
UserInterest A user interest: a particular interest-based vertical to be targeted.
UserList A user list. This is a list of users a customer may target.
UserLocationView A user location view. User Location View includes all metrics aggregated at the country level, one row per country. It reports metrics at the actual physical location of the user by targeted or not targeted location. If other segment fields are used, you may get more than one row per country.
Video A video.
WebpageView A webpage view.

AccessibleBiddingStrategy

Represents a view of BiddingStrategies owned by and shared with the customer. In contrast to BiddingStrategy, this resource includes strategies owned by managers of the customer and shared with this customer - in addition to strategies owned by this customer. This resource does not provide metrics and only exposes a limited subset of the BiddingStrategy attributes.

Columns
Name Type Behavior Description
AccessibleBiddingStrategyId Long ATTRIBUTE Output only. The ID of the bidding strategy.
AccessibleBiddingStrategyMaximizeConversionValueTargetRoas Double ATTRIBUTE Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
AccessibleBiddingStrategyMaximizeConversionsTargetCpaMicros Long ATTRIBUTE Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
AccessibleBiddingStrategyName String ATTRIBUTE Output only. The name of the bidding strategy.
AccessibleBiddingStrategyOwnerCustomerId Long ATTRIBUTE Output only. The ID of the Customer which owns the bidding strategy.
AccessibleBiddingStrategyOwnerDescriptiveName String ATTRIBUTE Output only. descriptive_name of the Customer which owns the bidding strategy.
AccessibleBiddingStrategyResourceName String ATTRIBUTE Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form: customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}
AccessibleBiddingStrategyTargetCpaTargetCpaMicros Long ATTRIBUTE Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
AccessibleBiddingStrategyTargetImpressionShareCpcBidCeilingMicros Long ATTRIBUTE Output only. The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
AccessibleBiddingStrategyTargetImpressionShareLocation String ATTRIBUTE Output only. The targeted location on the search results page. The allowed values are ABSOLUTE_TOP_OF_PAGE, ANYWHERE_ON_PAGE, TOP_OF_PAGE, UNKNOWN, UNSPECIFIED.
AccessibleBiddingStrategyTargetImpressionShareLocationFractionMicros Long ATTRIBUTE The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10, 000.
AccessibleBiddingStrategyTargetRoasTargetRoas Double ATTRIBUTE Output only. The chosen revenue (based on conversion data) per unit of spend.
AccessibleBiddingStrategyTargetSpendCpcBidCeilingMicros Long ATTRIBUTE Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
AccessibleBiddingStrategyTargetSpendTargetSpendMicros Long ATTRIBUTE Output only. The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
AccessibleBiddingStrategyType String ATTRIBUTE Output only. The type of the bidding strategy. The allowed values are COMMISSION, ENHANCED_CPC, INVALID, MANUAL_CPA, MANUAL_CPC, MANUAL_CPM, MANUAL_CPV, MAXIMIZE_CONVERSIONS, MAXIMIZE_CONVERSION_VALUE, PAGE_ONE_PROMOTED, PERCENT_CPC, TARGET_CPA, TARGET_CPM, TARGET_IMPRESSION_SHARE, TARGET_OUTRANK_SHARE, TARGET_ROAS, TARGET_SPEND, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AccountBudget

An account-level budget. It contains information about the budget itself, as well as the most recently approved changes to the budget and proposed changes that are pending approval. The proposed changes that are pending approval, if any, are found in 'pending_proposal'. Effective details about the budget are found in fields prefixed 'approved_', 'adjusted_' and those without a prefix. Since some effective details may differ from what the user had originally requested (for example, spending limit), these differences are juxtaposed through 'proposed_', 'approved_', and possibly 'adjusted_' fields. This resource is mutated using AccountBudgetProposal and cannot be mutated directly. A budget may have at most one pending proposal at any given time. It is read through pending_proposal. Once approved, a budget may be subject to adjustments, such as credit adjustments. Adjustments create differences between the 'approved' and 'adjusted' fields, which would otherwise be identical.

Columns
Name Type Behavior Description
AccountBudgetAdjustedSpendingLimitMicros Long ATTRIBUTE Output only. The adjusted spending limit in micros. One million is equivalent to one unit. If the approved spending limit is finite, the adjusted spending limit may vary depending on the types of adjustments applied to this budget, if applicable. The different kinds of adjustments are described here: https://support.google.com/google-ads/answer/1704323 For example, a debit adjustment reduces how much the account is allowed to spend.
AccountBudgetAdjustedSpendingLimitType String ATTRIBUTE Output only. The adjusted spending limit as a well-defined type, for example, INFINITE. This will only be populated if the adjusted spending limit is INFINITE, which is guaranteed to be true if the approved spending limit is INFINITE. The allowed values are INFINITE, UNKNOWN, UNSPECIFIED.
AccountBudgetAmountServedMicros Long ATTRIBUTE Output only. The value of Ads that have been served, in micros. This includes overdelivery costs, in which case a credit might be automatically applied to the budget (see total_adjustments_micros).
AccountBudgetApprovedEndDateTime Datetime ATTRIBUTE Output only. The approved end time in yyyy-MM-dd HH🇲🇲ss format.
AccountBudgetApprovedEndTimeType String ATTRIBUTE Output only. The approved end time as a well-defined type, for example, FOREVER. The allowed values are FOREVER, NOW, UNKNOWN, UNSPECIFIED.
AccountBudgetApprovedSpendingLimitMicros Long ATTRIBUTE Output only. The approved spending limit in micros. One million is equivalent to one unit. This will only be populated if the proposed spending limit is finite, and will always be greater than or equal to the proposed spending limit.
AccountBudgetApprovedSpendingLimitType String ATTRIBUTE Output only. The approved spending limit as a well-defined type, for example, INFINITE. This will only be populated if the approved spending limit is INFINITE. The allowed values are INFINITE, UNKNOWN, UNSPECIFIED.
AccountBudgetApprovedStartDateTime Datetime ATTRIBUTE Output only. The approved start time of the account-level budget in yyyy-MM-dd HH🇲🇲ss format. For example, if a new budget is approved after the proposed start time, the approved start time is the time of approval.
AccountBudgetBillingSetup String ATTRIBUTE Output only. The resource name of the billing setup associated with this account-level budget. BillingSetup resource names have the form: customers/{customer_id}/billingSetups/{billing_setup_id}
AccountBudgetId Long ATTRIBUTE Output only. The ID of the account-level budget.
AccountBudgetName String ATTRIBUTE Output only. The name of the account-level budget.
AccountBudgetNotes String ATTRIBUTE Output only. Notes associated with the budget.
AccountBudgetPendingProposalAccountBudgetProposal String ATTRIBUTE Output only. The resource name of the proposal. AccountBudgetProposal resource names have the form: customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}
AccountBudgetPendingProposalCreationDateTime Datetime ATTRIBUTE Output only. The time when this account-level budget proposal was created. Formatted as yyyy-MM-dd HH🇲🇲ss.
AccountBudgetPendingProposalEndDateTime Datetime ATTRIBUTE Output only. The end time in yyyy-MM-dd HH🇲🇲ss format.
AccountBudgetPendingProposalEndTimeType String ATTRIBUTE Output only. The end time as a well-defined type, for example, FOREVER. The allowed values are FOREVER, NOW, UNKNOWN, UNSPECIFIED.
AccountBudgetPendingProposalName String ATTRIBUTE Output only. The name to assign to the account-level budget.
AccountBudgetPendingProposalNotes String ATTRIBUTE Output only. Notes associated with this budget.
AccountBudgetPendingProposalProposalType String ATTRIBUTE Output only. The type of this proposal, for example, END to end the budget associated with this proposal. The allowed values are CREATE, END, REMOVE, UNKNOWN, UNSPECIFIED, UPDATE.
AccountBudgetPendingProposalPurchaseOrderNumber String ATTRIBUTE Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.
AccountBudgetPendingProposalSpendingLimitMicros Long ATTRIBUTE Output only. The spending limit in micros. One million is equivalent to one unit.
AccountBudgetPendingProposalSpendingLimitType String ATTRIBUTE Output only. The spending limit as a well-defined type, for example, INFINITE. The allowed values are INFINITE, UNKNOWN, UNSPECIFIED.
AccountBudgetPendingProposalStartDateTime Datetime ATTRIBUTE Output only. The start time in yyyy-MM-dd HH🇲🇲ss format.
AccountBudgetProposedEndDateTime Datetime ATTRIBUTE Output only. The proposed end time in yyyy-MM-dd HH🇲🇲ss format.
AccountBudgetProposedEndTimeType String ATTRIBUTE Output only. The proposed end time as a well-defined type, for example, FOREVER. The allowed values are FOREVER, NOW, UNKNOWN, UNSPECIFIED.
AccountBudgetProposedSpendingLimitMicros Long ATTRIBUTE Output only. The proposed spending limit in micros. One million is equivalent to one unit.
AccountBudgetProposedSpendingLimitType String ATTRIBUTE Output only. The proposed spending limit as a well-defined type, for example, INFINITE. The allowed values are INFINITE, UNKNOWN, UNSPECIFIED.
AccountBudgetProposedStartDateTime Datetime ATTRIBUTE Output only. The proposed start time of the account-level budget in yyyy-MM-dd HH🇲🇲ss format. If a start time type of NOW was proposed, this is the time of request.
AccountBudgetPurchaseOrderNumber String ATTRIBUTE Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.
AccountBudgetResourceName String ATTRIBUTE Output only. The resource name of the account-level budget. AccountBudget resource names have the form: customers/{customer_id}/accountBudgets/{account_budget_id}
AccountBudgetStatus String ATTRIBUTE Output only. The status of this account-level budget. The allowed values are APPROVED, CANCELLED, PENDING, UNKNOWN, UNSPECIFIED.
AccountBudgetTotalAdjustmentsMicros Long ATTRIBUTE Output only. The total adjustments amount. An example of an adjustment is courtesy credits.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AccountBudgetProposal

An account-level budget proposal. All fields prefixed with 'proposed' may not necessarily be applied directly. For example, proposed spending limits may be adjusted before their application. This is true if the 'proposed' field has an 'approved' counterpart, for example, spending limits. Note that the proposal type (proposal_type) changes which fields are required and which must remain empty.

Columns
Name Type Behavior Description
AccountBudgetProposalAccountBudget String ATTRIBUTE Immutable. The resource name of the account-level budget associated with this proposal.
AccountBudgetProposalApprovalDateTime Date ATTRIBUTE Output only. The date time when this account-level budget was approved, if applicable.
AccountBudgetProposalApprovedEndDateTime Datetime ATTRIBUTE Output only. The approved end date time in yyyy-mm-dd hh🇲🇲ss format.
AccountBudgetProposalApprovedEndTimeType String ATTRIBUTE Output only. The approved end date time as a well-defined type, for example, FOREVER. The allowed values are FOREVER, NOW, UNKNOWN, UNSPECIFIED.
AccountBudgetProposalApprovedSpendingLimitMicros Long ATTRIBUTE Output only. The approved spending limit in micros. One million is equivalent to one unit.
AccountBudgetProposalApprovedSpendingLimitType String ATTRIBUTE Output only. The approved spending limit as a well-defined type, for example, INFINITE. The allowed values are INFINITE, UNKNOWN, UNSPECIFIED.
AccountBudgetProposalApprovedStartDateTime Datetime ATTRIBUTE Output only. The approved start date time in yyyy-mm-dd hh🇲🇲ss format.
AccountBudgetProposalBillingSetup String ATTRIBUTE Immutable. The resource name of the billing setup associated with this proposal.
AccountBudgetProposalCreationDateTime Date ATTRIBUTE Output only. The date time when this account-level budget proposal was created, which is not the same as its approval date time, if applicable.
AccountBudgetProposalId Long ATTRIBUTE Output only. The ID of the proposal.
AccountBudgetProposalProposalType String ATTRIBUTE Immutable. The type of this proposal, for example, END to end the budget associated with this proposal. The allowed values are CREATE, END, REMOVE, UNKNOWN, UNSPECIFIED, UPDATE.
AccountBudgetProposalProposedEndDateTime Datetime ATTRIBUTE Immutable. The proposed end date time in yyyy-mm-dd hh🇲🇲ss format.
AccountBudgetProposalProposedEndTimeType String ATTRIBUTE Immutable. The proposed end date time as a well-defined type, for example, FOREVER. The allowed values are FOREVER, NOW, UNKNOWN, UNSPECIFIED.
AccountBudgetProposalProposedName String ATTRIBUTE Immutable. The name to assign to the account-level budget.
AccountBudgetProposalProposedNotes String ATTRIBUTE Immutable. Notes associated with this budget.
AccountBudgetProposalProposedPurchaseOrderNumber String ATTRIBUTE Immutable. A purchase order number is a value that enables the user to help them reference this budget in their monthly invoices.
AccountBudgetProposalProposedSpendingLimitMicros Long ATTRIBUTE Immutable. The proposed spending limit in micros. One million is equivalent to one unit.
AccountBudgetProposalProposedSpendingLimitType String ATTRIBUTE Immutable. The proposed spending limit as a well-defined type, for example, INFINITE. The allowed values are INFINITE, UNKNOWN, UNSPECIFIED.
AccountBudgetProposalProposedStartDateTime Datetime ATTRIBUTE Immutable. The proposed start date time in yyyy-mm-dd hh🇲🇲ss format.
AccountBudgetProposalResourceName String ATTRIBUTE Immutable. The resource name of the proposal. AccountBudgetProposal resource names have the form: customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}
AccountBudgetProposalStatus String ATTRIBUTE Output only. The status of this proposal. When a new proposal is created, the status defaults to PENDING. The allowed values are APPROVED, APPROVED_HELD, CANCELLED, PENDING, REJECTED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AccountHourlyStatsReport

Account-level performance stats by Ad Network and Device. Hourly data is returned with a default date range of the last 7 days not including today.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ActiveViewCpm Double METRIC Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr Double METRIC Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE_SEARCH, YOUTUBE_WATCH.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
Hour Int SEGMENT Hour of day as a number between 0 and 23, inclusive.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.

Represents the data sharing connection between a Google Ads account and another account

Columns
Name Type Behavior Description
AccountLinkAccountLinkId Long ATTRIBUTE Output only. The ID of the link. This field is read only.
AccountLinkAdvertisingPartnerCustomer String ATTRIBUTE Immutable. The resource name of the advertising partner Google Ads account. This field is required and should not be empty when creating a new Advertising Partner link. It is unable to be modified after the creation of the link.
AccountLinkDataPartnerDataPartnerId Long ATTRIBUTE Immutable. The customer ID of the Data partner account. This field is required and should not be empty when creating a new data partner link. It is unable to be modified after the creation of the link.
AccountLinkGoogleAdsCustomer String ATTRIBUTE Immutable. The resource name of the Google Ads account. This field is required and should not be empty when creating a new Google Ads link. It is unable to be modified after the creation of the link.
AccountLinkResourceName String ATTRIBUTE Immutable. Resource name of the account link. AccountLink resource names have the form: customers/{customer_id}/accountLinks/{account_link_id}
AccountLinkStatus String ATTRIBUTE The status of the link. The allowed values are ENABLED, PENDING_APPROVAL, REJECTED, REMOVED, REQUESTED, REVOKED, UNKNOWN, UNSPECIFIED.
AccountLinkThirdPartyAppAnalyticsAppAnalyticsProviderId Long ATTRIBUTE Immutable. The ID of the app analytics provider. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
AccountLinkThirdPartyAppAnalyticsAppId String ATTRIBUTE Immutable. A string that uniquely identifies a mobile application from which the data was collected to the Google Ads API. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, '422689480' for 'Gmail' whose App Store link is https://apps.apple.com/us/app/gmail-email-by-google/id422689480). For Android, the ID string is the application's package name (for example, 'com.google.android.gm' for 'Gmail' given Google Play link https://play.google.com/store/apps/details?id=com.google.android.gm) This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
AccountLinkThirdPartyAppAnalyticsAppVendor String ATTRIBUTE Immutable. The vendor of the app. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link. The allowed values are APPLE_APP_STORE, GOOGLE_APP_STORE, UNKNOWN, UNSPECIFIED.
AccountLinkType String ATTRIBUTE Output only. The type of the linked account. The allowed values are ADVERTISING_PARTNER, DATA_PARTNER, GOOGLE_ADS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AccountStatsReport

Account-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE_SEARCH, YOUTUBE_WATCH.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.

AdGroup

An ad group.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
AdGroupAdRotationMode String ATTRIBUTE The ad rotation mode of the ad group. The allowed values are OPTIMIZE, ROTATE_FOREVER, UNKNOWN, UNSPECIFIED.
AdGroupAudienceSettingUseAudienceGrouped Bool ATTRIBUTE Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
AdGroupBaseAdGroup String ATTRIBUTE Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
AdGroupCampaign String ATTRIBUTE Immutable. The campaign to which the ad group belongs.
AdGroupCpcBidMicros Long ATTRIBUTE The maximum CPC (cost-per-click) bid.
AdGroupCpmBidMicros Long ATTRIBUTE The maximum CPM (cost-per-thousand viewable impressions) bid.
AdGroupCpvBidMicros Long ATTRIBUTE The CPV (cost-per-view) bid.
AdGroupDisplayCustomBidDimension String ATTRIBUTE Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search. The allowed values are AGE_RANGE, AUDIENCE, GENDER, INCOME_RANGE, KEYWORD, PARENTAL_STATUS, PLACEMENT, TOPIC, UNKNOWN, UNSPECIFIED.
AdGroupEffectiveCpcBidMicros Long ATTRIBUTE Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.
AdGroupEffectiveTargetCpaMicros Long ATTRIBUTE Output only. The effective target CPA (cost-per-acquisition). This field is read-only.
AdGroupEffectiveTargetCpaSource String ATTRIBUTE Output only. Source of the effective target CPA. This field is read-only. The allowed values are AD_GROUP, AD_GROUP_CRITERION, CAMPAIGN_BIDDING_STRATEGY, UNKNOWN, UNSPECIFIED.
AdGroupEffectiveTargetRoas Double ATTRIBUTE Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.
AdGroupEffectiveTargetRoasSource String ATTRIBUTE Output only. Source of the effective target ROAS. This field is read-only. The allowed values are AD_GROUP, AD_GROUP_CRITERION, CAMPAIGN_BIDDING_STRATEGY, UNKNOWN, UNSPECIFIED.
AdGroupExcludedParentAssetFieldTypes String ATTRIBUTE The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels. The allowed values are AD_IMAGE, BOOK_ON_GOOGLE, BUSINESS_LOGO, BUSINESS_NAME, CALL, CALLOUT, CALL_TO_ACTION_SELECTION, DESCRIPTION, HEADLINE, HOTEL_CALLOUT, HOTEL_PROPERTY, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MANDATORY_AD_TEXT, MARKETING_IMAGE, MEDIA_BUNDLE, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, VIDEO, YOUTUBE_VIDEO.
AdGroupExcludedParentAssetSetTypes String ATTRIBUTE The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported. The allowed values are BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, DYNAMIC_CUSTOM, DYNAMIC_EDUCATION, DYNAMIC_FLIGHTS, DYNAMIC_HOTELS_AND_RENTALS, DYNAMIC_JOBS, DYNAMIC_LOCAL, DYNAMIC_REAL_ESTATE, DYNAMIC_TRAVEL, HOTEL_PROPERTY, LOCATION_SYNC, MERCHANT_CENTER_FEED, PAGE_FEED, STATIC_LOCATION_GROUP, UNKNOWN, UNSPECIFIED.
AdGroupFinalUrlSuffix String ATTRIBUTE URL template for appending params to Final URL.
AdGroupId Long ATTRIBUTE Output only. The ID of the ad group.
AdGroupLabels String ATTRIBUTE Output only. The resource names of labels attached to this ad group.
AdGroupName String ATTRIBUTE The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
AdGroupOptimizedTargetingEnabled Bool ATTRIBUTE True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.
AdGroupPercentCpcBidMicros Long ATTRIBUTE The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0, 1) and the value stored here is 1, 000, 000 * [fraction].
AdGroupResourceName String ATTRIBUTE Immutable. The resource name of the ad group. Ad group resource names have the form: customers/{customer_id}/adGroups/{ad_group_id}
AdGroupStatus String ATTRIBUTE The status of the ad group. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
AdGroupTargetCpaMicros Long ATTRIBUTE The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored.
AdGroupTargetCpmMicros Long ATTRIBUTE Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
AdGroupTargetRoas Double ATTRIBUTE The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored.
AdGroupTargetingSettingTargetRestrictions String ATTRIBUTE The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
AdGroupTrackingUrlTemplate String ATTRIBUTE The URL template for constructing a tracking URL.
AdGroupType String ATTRIBUTE Immutable. The type of the ad group. The allowed values are DISPLAY_STANDARD, HOTEL_ADS, PROMOTED_HOTEL_ADS, SEARCH_DYNAMIC_ADS, SEARCH_STANDARD, SHOPPING_COMPARISON_LISTING_ADS, SHOPPING_PRODUCT_ADS, SHOPPING_SMART_ADS, SMART_CAMPAIGN_ADS, TRAVEL_ADS, UNKNOWN, UNSPECIFIED, VIDEO_BUMPER, VIDEO_EFFICIENT_REACH, VIDEO_NON_SKIPPABLE_IN_STREAM, VIDEO_OUTSTREAM, VIDEO_RESPONSIVE, VIDEO_TRUE_VIEW_IN_DISPLAY, VIDEO_TRUE_VIEW_IN_STREAM.
AdGroupUrlCustomParameters String ATTRIBUTE The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
ActiveViewCpm Double METRIC Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr Double METRIC Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsByConversionDate Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AllConversionsValueByConversionDate Double METRIC The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllNewCustomerLifetimeValue Double METRIC All of new customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for both biddable and non-biddable conversions. If your campaign has adopted the customer acquisition goal and selected 'bid higher for new customers', these values will be included in 'all_conversions_value'. See https://support.google.com/google-ads/answer/12080169 for more details.
AverageCartSize Double METRIC Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
AverageOrderValueMicros Long METRIC Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is \(15 = (\)10 + $15 + $20)/3. This metric is only available if you report conversions with cart data.
AveragePageViews Double METRIC Average number of pages viewed per session.
AverageTimeOnSite Double METRIC Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
BounceRate Double METRIC Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
Clicks Long METRIC The number of clicks.
ContentImpressionShare Double METRIC The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
ContentRankLostImpressionShare Double METRIC The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsByConversionDate Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValueByConversionDate Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostOfGoodsSoldMicros Long METRIC Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostPerCurrentModelAttributedConversion Double METRIC The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
CrossSellCostOfGoodsSoldMicros Long METRIC Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data.
CrossSellGrossProfitMicros Long METRIC Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data.
CrossSellRevenueMicros Long METRIC Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data.
CrossSellUnitsSold Double METRIC Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
CurrentModelAttributedConversions Double METRIC Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CurrentModelAttributedConversionsValue Double METRIC The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
GmailForwards Long METRIC The number of times the ad was forwarded to someone else as a message.
GmailSaves Long METRIC The number of times someone has saved your Gmail ad to their inbox as a message.
GmailSecondaryClicks Long METRIC The number of clicks to the landing page on the expanded state of Gmail ads.
GrossProfitMargin Double METRIC Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced \(20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = (\)10 - \(3)/\)10 x 100%. This metric is only available if you report conversions with cart data.
GrossProfitMicros Long METRIC Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
LeadCostOfGoodsSoldMicros Long METRIC Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data.
LeadGrossProfitMicros Long METRIC Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data.
LeadRevenueMicros Long METRIC Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data.
LeadUnitsSold Double METRIC Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
NewCustomerLifetimeValue Double METRIC New customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for biddable conversions. If your campaign has adopted the customer acquisition goal and selected 'bid higher for new customers', these values will be included in 'conversions_value' for optimization. See https://support.google.com/google-ads/answer/12080169 for more details.
Orders Double METRIC Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data.
PercentNewVisitors Double METRIC Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
PhoneCalls Long METRIC Number of offline phone calls.
PhoneImpressions Long METRIC Number of offline phone impressions.
PhoneThroughRate Double METRIC Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
RelativeCtr Double METRIC Your clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites.
RevenueMicros Long METRIC Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is \(25 = (\)10 + $20) - $5. This metric is only available if you report conversions with cart data.
SearchAbsoluteTopImpressionShare Double METRIC The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/google-ads/answer/7501826 for details. Any value below 0.1 is reported as 0.0999.
SearchBudgetLostAbsoluteTopImpressionShare Double METRIC The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchBudgetLostTopImpressionShare Double METRIC The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchExactMatchImpressionShare Double METRIC The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
SearchImpressionShare Double METRIC The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
SearchRankLostAbsoluteTopImpressionShare Double METRIC The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchRankLostImpressionShare Double METRIC The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchRankLostTopImpressionShare Double METRIC The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchTopImpressionShare Double METRIC The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown anywhere above the organic search results.
UnitsSold Double METRIC Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerAllConversionsByConversionDate Double METRIC The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ValuePerConversionsByConversionDate Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ValuePerCurrentModelAttributedConversion Double METRIC The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoQuartileP100Rate Double METRIC Percentage of impressions where the viewer watched all of your video.
VideoQuartileP25Rate Double METRIC Percentage of impressions where the viewer watched 25% of your video.
VideoQuartileP50Rate Double METRIC Percentage of impressions where the viewer watched 50% of your video.
VideoQuartileP75Rate Double METRIC Percentage of impressions where the viewer watched 75% of your video.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
AdDestinationType String SEGMENT Ad Destination type. The allowed values are APP_DEEP_LINK, APP_STORE, LEAD_FORM, LOCATION_LISTING, MAP_DIRECTIONS, MESSAGE, NOT_APPLICABLE, PHONE_CALL, UNKNOWN, UNMODELED_FOR_CONVERSIONS, UNSPECIFIED, WEBSITE, YOUTUBE.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
AssetInteractionTargetAsset String SEGMENT The asset resource name.
AssetInteractionTargetInteractionOnThisAsset Bool SEGMENT Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
AuctionInsightDomain String SEGMENT Domain (visible URL) of a participant in the Auction Insights report.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
ConversionAdjustment Bool SEGMENT This segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.
ConversionLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion. The allowed values are EIGHT_TO_NINE_DAYS, ELEVEN_TO_TWELVE_DAYS, FIVE_TO_SIX_DAYS, FORTY_FIVE_TO_SIXTY_DAYS, FOURTEEN_TO_TWENTY_ONE_DAYS, FOUR_TO_FIVE_DAYS, LESS_THAN_ONE_DAY, NINE_TO_TEN_DAYS, ONE_TO_TWO_DAYS, SEVEN_TO_EIGHT_DAYS, SIXTY_TO_NINETY_DAYS, SIX_TO_SEVEN_DAYS, TEN_TO_ELEVEN_DAYS, THIRTEEN_TO_FOURTEEN_DAYS, THIRTY_TO_FORTY_FIVE_DAYS, THREE_TO_FOUR_DAYS, TWELVE_TO_THIRTEEN_DAYS, TWENTY_ONE_TO_THIRTY_DAYS, TWO_TO_THREE_DAYS, UNKNOWN, UNSPECIFIED.
ConversionOrAdjustmentLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion. The allowed values are ADJUSTMENT_EIGHT_TO_NINE_DAYS, ADJUSTMENT_ELEVEN_TO_TWELVE_DAYS, ADJUSTMENT_FIVE_TO_SIX_DAYS, ADJUSTMENT_FORTY_FIVE_TO_SIXTY_DAYS, ADJUSTMENT_FOURTEEN_TO_TWENTY_ONE_DAYS, ADJUSTMENT_FOUR_TO_FIVE_DAYS, ADJUSTMENT_LESS_THAN_ONE_DAY, ADJUSTMENT_NINETY_TO_ONE_HUNDRED_AND_FORTY_FIVE_DAYS, ADJUSTMENT_NINE_TO_TEN_DAYS, ADJUSTMENT_ONE_TO_TWO_DAYS, ADJUSTMENT_SEVEN_TO_EIGHT_DAYS, ADJUSTMENT_SIXTY_TO_NINETY_DAYS, ADJUSTMENT_SIX_TO_SEVEN_DAYS, ADJUSTMENT_TEN_TO_ELEVEN_DAYS, ADJUSTMENT_THIRTEEN_TO_FOURTEEN_DAYS, ADJUSTMENT_THIRTY_TO_FORTY_FIVE_DAYS, ADJUSTMENT_THREE_TO_FOUR_DAYS, ADJUSTMENT_TWELVE_TO_THIRTEEN_DAYS, ADJUSTMENT_TWENTY_ONE_TO_THIRTY_DAYS, ADJUSTMENT_TWO_TO_THREE_DAYS, ADJUSTMENT_UNKNOWN, CONVERSION_EIGHT_TO_NINE_DAYS, CONVERSION_ELEVEN_TO_TWELVE_DAYS, CONVERSION_FIVE_TO_SIX_DAYS, CONVERSION_FORTY_FIVE_TO_SIXTY_DAYS, CONVERSION_FOURTEEN_TO_TWENTY_ONE_DAYS, CONVERSION_FOUR_TO_FIVE_DAYS, CONVERSION_LESS_THAN_ONE_DAY, CONVERSION_NINE_TO_TEN_DAYS, CONVERSION_ONE_TO_TWO_DAYS, CONVERSION_SEVEN_TO_EIGHT_DAYS, CONVERSION_SIXTY_TO_NINETY_DAYS, CONVERSION_SIX_TO_SEVEN_DAYS, CONVERSION_TEN_TO_ELEVEN_DAYS, CONVERSION_THIRTEEN_TO_FOURTEEN_DAYS, CONVERSION_THIRTY_TO_FORTY_FIVE_DAYS, CONVERSION_THREE_TO_FOUR_DAYS, CONVERSION_TWELVE_TO_THIRTEEN_DAYS, CONVERSION_TWENTY_ONE_TO_THIRTY_DAYS, CONVERSION_TWO_TO_THREE_DAYS, CONVERSION_UNKNOWN, UNKNOWN, UNSPECIFIED.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Hour Int SEGMENT Hour of day as a number between 0 and 23, inclusive.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
NewVersusReturningCustomers String SEGMENT This is for segmenting conversions by whether the user is a new customer or a returning customer. This segmentation is typically used to measure the impact of customer acquisition goal. The allowed values are NEW, NEW_AND_HIGH_LTV, RETURNING, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupAd

An ad group ad.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
AdGroupAdActionItems String ATTRIBUTE Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be 'Try adding a few more unique headlines or unpinning some assets.'.
AdGroupAdAdAddedByGoogleAds Bool ATTRIBUTE Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing.
AdGroupAdAdAppAdDescriptions String ATTRIBUTE List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
AdGroupAdAdAppAdHeadlines String ATTRIBUTE List of text assets for headlines. When the ad serves the headlines will be selected from this list.
AdGroupAdAdAppAdHtml5MediaBundles String ATTRIBUTE List of media bundle assets that may be used with the ad.
AdGroupAdAdAppAdImages String ATTRIBUTE List of image assets that may be displayed with the ad.
AdGroupAdAdAppAdMandatoryAdText String ATTRIBUTE Mandatory ad text.
AdGroupAdAdAppAdYoutubeVideos String ATTRIBUTE List of YouTube video assets that may be displayed with the ad.
AdGroupAdAdAppEngagementAdDescriptions String ATTRIBUTE List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
AdGroupAdAdAppEngagementAdHeadlines String ATTRIBUTE List of text assets for headlines. When the ad serves the headlines will be selected from this list.
AdGroupAdAdAppEngagementAdImages String ATTRIBUTE List of image assets that may be displayed with the ad.
AdGroupAdAdAppEngagementAdVideos String ATTRIBUTE List of video assets that may be displayed with the ad.
AdGroupAdAdAppPreRegistrationAdDescriptions String ATTRIBUTE List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
AdGroupAdAdAppPreRegistrationAdHeadlines String ATTRIBUTE List of text assets for headlines. When the ad serves the headlines will be selected from this list.
AdGroupAdAdAppPreRegistrationAdImages String ATTRIBUTE List of image asset IDs whose images may be displayed with the ad.
AdGroupAdAdAppPreRegistrationAdYoutubeVideos String ATTRIBUTE List of YouTube video asset IDs whose videos may be displayed with the ad.
AdGroupAdAdCallAdBusinessName String ATTRIBUTE The business name in the ad.
AdGroupAdAdCallAdCallTracked Bool ATTRIBUTE Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions.
AdGroupAdAdCallAdConversionAction String ATTRIBUTE The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracked is set to true. Otherwise this field is ignored.
AdGroupAdAdCallAdConversionReportingState String ATTRIBUTE The call conversion behavior of this call ad. It can use its own call conversion setting, inherit the account level setting, or be disabled. The allowed values are DISABLED, UNKNOWN, UNSPECIFIED, USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION, USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
AdGroupAdAdCallAdCountryCode String ATTRIBUTE The country code in the ad.
AdGroupAdAdCallAdDescription1 String ATTRIBUTE The first line of the ad's description.
AdGroupAdAdCallAdDescription2 String ATTRIBUTE The second line of the ad's description.
AdGroupAdAdCallAdDisableCallConversion Bool ATTRIBUTE Whether to disable call conversion for the creative. If set to true, disables call conversions even when call_tracked is true. If call_tracked is false, this field is ignored.
AdGroupAdAdCallAdHeadline1 String ATTRIBUTE First headline in the ad.
AdGroupAdAdCallAdHeadline2 String ATTRIBUTE Second headline in the ad.
AdGroupAdAdCallAdPath1 String ATTRIBUTE First part of text that can be appended to the URL in the ad. Optional.
AdGroupAdAdCallAdPath2 String ATTRIBUTE Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set. Optional.
AdGroupAdAdCallAdPhoneNumber String ATTRIBUTE The phone number in the ad.
AdGroupAdAdCallAdPhoneNumberVerificationUrl String ATTRIBUTE The URL to be used for phone number verification.
AdGroupAdAdDevicePreference String ATTRIBUTE The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, for example, if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
AdGroupAdAdDiscoveryCarouselAdBusinessName String ATTRIBUTE Required. The Advertiser/brand name.
AdGroupAdAdDiscoveryCarouselAdCallToActionText String ATTRIBUTE Call to action text.
AdGroupAdAdDiscoveryCarouselAdCarouselCards String ATTRIBUTE Required. Carousel cards that will display with the ad. Min 2 max 10.
AdGroupAdAdDiscoveryCarouselAdDescription String ATTRIBUTE Required. The descriptive text of the ad.
AdGroupAdAdDiscoveryCarouselAdHeadline String ATTRIBUTE Required. Headline of the ad.
AdGroupAdAdDiscoveryCarouselAdLogoImage String ATTRIBUTE Required. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1(+-1%).
AdGroupAdAdDiscoveryMultiAssetAdBusinessName String ATTRIBUTE The Advertiser/brand name. Maximum display width is 25. Required.
AdGroupAdAdDiscoveryMultiAssetAdCallToActionText String ATTRIBUTE Call to action text.
AdGroupAdAdDiscoveryMultiAssetAdDescriptions String ATTRIBUTE The descriptive text of the ad. Maximum display width is 90. At least 1 and max 5 descriptions can be specified.
AdGroupAdAdDiscoveryMultiAssetAdHeadlines String ATTRIBUTE Headline text asset of the ad. Maximum display width is 30. At least 1 and max 5 headlines can be specified.
AdGroupAdAdDiscoveryMultiAssetAdLeadFormOnly Bool ATTRIBUTE Boolean option that indicates if this ad must be served with lead form.
AdGroupAdAdDiscoveryMultiAssetAdLogoImages String ATTRIBUTE Logo image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1(+-1%). At least 1 and max 5 logo images can be specified.
AdGroupAdAdDiscoveryMultiAssetAdMarketingImages String ATTRIBUTE Marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). Required if square_marketing_images is not present. Combined with square_marketing_images and portrait_marketing_images the maximum is 20.
AdGroupAdAdDiscoveryMultiAssetAdPortraitMarketingImages String ATTRIBUTE Portrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 480x600 and the aspect ratio must be 4:5 (+-1%). Combined with marketing_images and square_marketing_images the maximum is 20.
AdGroupAdAdDiscoveryMultiAssetAdSquareMarketingImages String ATTRIBUTE Square marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). Required if marketing_images is not present. Combined with marketing_images and portrait_marketing_images the maximum is 20.
AdGroupAdAdDiscoveryVideoResponsiveAdBreadcrumb1 String ATTRIBUTE First part of text that appears in the ad with the displayed URL.
AdGroupAdAdDiscoveryVideoResponsiveAdBreadcrumb2 String ATTRIBUTE Second part of text that appears in the ad with the displayed URL.
AdGroupAdAdDiscoveryVideoResponsiveAdBusinessName String ATTRIBUTE Required. The advertiser/brand name.
AdGroupAdAdDiscoveryVideoResponsiveAdCallToActions String ATTRIBUTE Assets of type CallToActionAsset used for the 'Call To Action' button.
AdGroupAdAdDiscoveryVideoResponsiveAdDescriptions String ATTRIBUTE List of text assets used for the description.
AdGroupAdAdDiscoveryVideoResponsiveAdHeadlines String ATTRIBUTE List of text assets used for the short headline, for example, the 'Call To Action' banner.
AdGroupAdAdDiscoveryVideoResponsiveAdLogoImages String ATTRIBUTE Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1(+-1%).
AdGroupAdAdDiscoveryVideoResponsiveAdLongHeadlines String ATTRIBUTE List of text assets used for the long headline.
AdGroupAdAdDiscoveryVideoResponsiveAdVideos String ATTRIBUTE List of YouTube video assets used for the ad.
AdGroupAdAdDisplayUploadAdDisplayUploadProductType String ATTRIBUTE The product type of this ad. See comments on the enum for details. The allowed values are DYNAMIC_HTML5_CUSTOM_AD, DYNAMIC_HTML5_EDUCATION_AD, DYNAMIC_HTML5_FLIGHT_AD, DYNAMIC_HTML5_HOTEL_AD, DYNAMIC_HTML5_HOTEL_RENTAL_AD, DYNAMIC_HTML5_JOB_AD, DYNAMIC_HTML5_LOCAL_AD, DYNAMIC_HTML5_REAL_ESTATE_AD, DYNAMIC_HTML5_TRAVEL_AD, HTML5_UPLOAD_AD, UNKNOWN, UNSPECIFIED.
AdGroupAdAdDisplayUploadAdMediaBundle String ATTRIBUTE A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096 Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898 for more information.
AdGroupAdAdDisplayUrl String ATTRIBUTE The URL that appears in the ad description for some ad formats.
AdGroupAdAdExpandedDynamicSearchAdDescription String ATTRIBUTE The description of the ad.
AdGroupAdAdExpandedDynamicSearchAdDescription2 String ATTRIBUTE The second description of the ad.
AdGroupAdAdExpandedTextAdDescription String ATTRIBUTE The description of the ad.
AdGroupAdAdExpandedTextAdDescription2 String ATTRIBUTE The second description of the ad.
AdGroupAdAdExpandedTextAdHeadlinePart1 String ATTRIBUTE The first part of the ad's headline.
AdGroupAdAdExpandedTextAdHeadlinePart2 String ATTRIBUTE The second part of the ad's headline.
AdGroupAdAdExpandedTextAdHeadlinePart3 String ATTRIBUTE The third part of the ad's headline.
AdGroupAdAdExpandedTextAdPath1 String ATTRIBUTE The text that can appear alongside the ad's displayed URL.
AdGroupAdAdExpandedTextAdPath2 String ATTRIBUTE Additional text that can appear alongside the ad's displayed URL.
AdGroupAdAdFinalAppUrls String ATTRIBUTE A list of final app URLs that will be used on mobile if the user has the specific app installed.
AdGroupAdAdFinalMobileUrls String ATTRIBUTE The list of possible final mobile URLs after all cross-domain redirects for the ad.
AdGroupAdAdFinalUrlSuffix String ATTRIBUTE The suffix to use when constructing a final URL.
AdGroupAdAdFinalUrls String ATTRIBUTE The list of possible final URLs after all cross-domain redirects for the ad.
AdGroupAdAdHotelAd String ATTRIBUTE Details pertaining to a hotel ad.
AdGroupAdAdId Long ATTRIBUTE Output only. The ID of the ad.
AdGroupAdAdImageAdImageUrl String ATTRIBUTE URL of the full size image.
AdGroupAdAdImageAdMimeType String ATTRIBUTE The mime type of the image. The allowed values are AUDIO_MP3, AUDIO_WAV, FLASH, HTML5_AD_ZIP, IMAGE_GIF, IMAGE_JPEG, IMAGE_PNG, MSEXCEL, MSWORD, PDF, RTF, TEXT_HTML, UNKNOWN, UNSPECIFIED.
AdGroupAdAdImageAdName String ATTRIBUTE The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty.
AdGroupAdAdImageAdPixelHeight Long ATTRIBUTE Height in pixels of the full size image.
AdGroupAdAdImageAdPixelWidth Long ATTRIBUTE Width in pixels of the full size image.
AdGroupAdAdImageAdPreviewImageUrl String ATTRIBUTE URL of the preview size image.
AdGroupAdAdImageAdPreviewPixelHeight Long ATTRIBUTE Height in pixels of the preview size image.
AdGroupAdAdImageAdPreviewPixelWidth Long ATTRIBUTE Width in pixels of the preview size image.
AdGroupAdAdLegacyAppInstallAd String ATTRIBUTE Immutable. Details pertaining to a legacy app install ad.
AdGroupAdAdLegacyResponsiveDisplayAdAccentColor String ATTRIBUTE The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
AdGroupAdAdLegacyResponsiveDisplayAdAllowFlexibleColor Bool ATTRIBUTE Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set.
AdGroupAdAdLegacyResponsiveDisplayAdBusinessName String ATTRIBUTE The business name in the ad.
AdGroupAdAdLegacyResponsiveDisplayAdCallToActionText String ATTRIBUTE The call-to-action text for the ad.
AdGroupAdAdLegacyResponsiveDisplayAdDescription String ATTRIBUTE The description of the ad.
AdGroupAdAdLegacyResponsiveDisplayAdFormatSetting String ATTRIBUTE Specifies which format the ad will be served in. Default is ALL_FORMATS. The allowed values are ALL_FORMATS, NATIVE, NON_NATIVE, UNKNOWN, UNSPECIFIED.
AdGroupAdAdLegacyResponsiveDisplayAdLogoImage String ATTRIBUTE The MediaFile resource name of the logo image used in the ad.
AdGroupAdAdLegacyResponsiveDisplayAdLongHeadline String ATTRIBUTE The long version of the ad's headline.
AdGroupAdAdLegacyResponsiveDisplayAdMainColor String ATTRIBUTE The main color of the ad in hexadecimal, for example, #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
AdGroupAdAdLegacyResponsiveDisplayAdMarketingImage String ATTRIBUTE The MediaFile resource name of the marketing image used in the ad.
AdGroupAdAdLegacyResponsiveDisplayAdPricePrefix String ATTRIBUTE Prefix before price. For example, 'as low as'.
AdGroupAdAdLegacyResponsiveDisplayAdPromoText String ATTRIBUTE Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
AdGroupAdAdLegacyResponsiveDisplayAdShortHeadline String ATTRIBUTE The short version of the ad's headline.
AdGroupAdAdLegacyResponsiveDisplayAdSquareLogoImage String ATTRIBUTE The MediaFile resource name of the square logo image used in the ad.
AdGroupAdAdLegacyResponsiveDisplayAdSquareMarketingImage String ATTRIBUTE The MediaFile resource name of the square marketing image used in the ad.
AdGroupAdAdLocalAdCallToActions String ATTRIBUTE List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. At least 1 and at most 5 call-to-actions must be specified.
AdGroupAdAdLocalAdDescriptions String ATTRIBUTE List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified.
AdGroupAdAdLocalAdHeadlines String ATTRIBUTE List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified.
AdGroupAdAdLocalAdLogoImages String ATTRIBUTE List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified.
AdGroupAdAdLocalAdMarketingImages String ATTRIBUTE List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified.
AdGroupAdAdLocalAdPath1 String ATTRIBUTE First part of optional text that can be appended to the URL in the ad.
AdGroupAdAdLocalAdPath2 String ATTRIBUTE Second part of optional text that can be appended to the URL in the ad. This field can only be set when path1 is also set.
AdGroupAdAdLocalAdVideos String ATTRIBUTE List of YouTube video assets that may be displayed with the ad. At least 1 and at most 20 video assets must be specified.
AdGroupAdAdName String ATTRIBUTE Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd.
AdGroupAdAdResourceName String ATTRIBUTE Immutable. The resource name of the ad. Ad resource names have the form: customers/{customer_id}/ads/{ad_id}
AdGroupAdAdResponsiveDisplayAdAccentColor String ATTRIBUTE The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
AdGroupAdAdResponsiveDisplayAdAllowFlexibleColor Bool ATTRIBUTE Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set.
AdGroupAdAdResponsiveDisplayAdBusinessName String ATTRIBUTE The advertiser/brand name. Maximum display width is 25.
AdGroupAdAdResponsiveDisplayAdCallToActionText String ATTRIBUTE The call-to-action text for the ad. Maximum display width is 30.
AdGroupAdAdResponsiveDisplayAdControlSpecEnableAssetEnhancements Bool ATTRIBUTE Whether the advertiser has opted into the asset enhancements feature.
AdGroupAdAdResponsiveDisplayAdControlSpecEnableAutogenVideo Bool ATTRIBUTE Whether the advertiser has opted into auto-gen video feature.
AdGroupAdAdResponsiveDisplayAdDescriptions String ATTRIBUTE Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified.
AdGroupAdAdResponsiveDisplayAdFormatSetting String ATTRIBUTE Specifies which format the ad will be served in. Default is ALL_FORMATS. The allowed values are ALL_FORMATS, NATIVE, NON_NATIVE, UNKNOWN, UNSPECIFIED.
AdGroupAdAdResponsiveDisplayAdHeadlines String ATTRIBUTE Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified.
AdGroupAdAdResponsiveDisplayAdLogoImages String ATTRIBUTE Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images, the maximum is 5.
AdGroupAdAdResponsiveDisplayAdLongHeadline String ATTRIBUTE A required long format headline. The maximum length is 90 characters.
AdGroupAdAdResponsiveDisplayAdMainColor String ATTRIBUTE The main color of the ad in hexadecimal, for example, #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
AdGroupAdAdResponsiveDisplayAdMarketingImages String ATTRIBUTE Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images, the maximum is 15.
AdGroupAdAdResponsiveDisplayAdPricePrefix String ATTRIBUTE Prefix before price. For example, 'as low as'.
AdGroupAdAdResponsiveDisplayAdPromoText String ATTRIBUTE Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
AdGroupAdAdResponsiveDisplayAdSquareLogoImages String ATTRIBUTE Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with logo_images, the maximum is 5.
AdGroupAdAdResponsiveDisplayAdSquareMarketingImages String ATTRIBUTE Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images, the maximum is 15.
AdGroupAdAdResponsiveDisplayAdYoutubeVideos String ATTRIBUTE Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
AdGroupAdAdResponsiveSearchAdDescriptions String ATTRIBUTE List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
AdGroupAdAdResponsiveSearchAdHeadlines String ATTRIBUTE List of text assets for headlines. When the ad serves the headlines will be selected from this list.
AdGroupAdAdResponsiveSearchAdPath1 String ATTRIBUTE First part of text that can be appended to the URL in the ad.
AdGroupAdAdResponsiveSearchAdPath2 String ATTRIBUTE Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set.
AdGroupAdAdShoppingComparisonListingAdHeadline String ATTRIBUTE Headline of the ad. This field is required. Allowed length is between 25 and 45 characters.
AdGroupAdAdShoppingProductAd String ATTRIBUTE Details pertaining to a Shopping product ad.
AdGroupAdAdShoppingSmartAd String ATTRIBUTE Details pertaining to a Smart Shopping ad.
AdGroupAdAdSmartCampaignAdDescriptions String ATTRIBUTE List of text assets, each of which corresponds to a description when the ad serves. This list consists of a minimum of 2 and up to 4 text assets.
AdGroupAdAdSmartCampaignAdHeadlines String ATTRIBUTE List of text assets, each of which corresponds to a headline when the ad serves. This list consists of a minimum of 3 and up to 15 text assets.
AdGroupAdAdSystemManagedResourceSource String ATTRIBUTE Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. The allowed values are AD_VARIATIONS, UNKNOWN, UNSPECIFIED.
AdGroupAdAdTextAdDescription1 String ATTRIBUTE The first line of the ad's description.
AdGroupAdAdTextAdDescription2 String ATTRIBUTE The second line of the ad's description.
AdGroupAdAdTextAdHeadline String ATTRIBUTE The headline of the ad.
AdGroupAdAdTrackingUrlTemplate String ATTRIBUTE The URL template for constructing a tracking URL.
AdGroupAdAdTravelAd String ATTRIBUTE Details pertaining to a travel ad.
AdGroupAdAdType String ATTRIBUTE Output only. The type of ad. The allowed values are APP_AD, APP_ENGAGEMENT_AD, APP_PRE_REGISTRATION_AD, CALL_AD, DISCOVERY_CAROUSEL_AD, DISCOVERY_MULTI_ASSET_AD, DISCOVERY_VIDEO_RESPONSIVE_AD, DYNAMIC_HTML5_AD, EXPANDED_DYNAMIC_SEARCH_AD, EXPANDED_TEXT_AD, HOTEL_AD, HTML5_UPLOAD_AD, IMAGE_AD, IN_FEED_VIDEO_AD, LEGACY_APP_INSTALL_AD, LEGACY_RESPONSIVE_DISPLAY_AD, LOCAL_AD, RESPONSIVE_DISPLAY_AD, RESPONSIVE_SEARCH_AD, SHOPPING_COMPARISON_LISTING_AD, SHOPPING_PRODUCT_AD, SHOPPING_SMART_AD, SMART_CAMPAIGN_AD, TEXT_AD, TRAVEL_AD, UNKNOWN, UNSPECIFIED, VIDEO_AD, VIDEO_BUMPER_AD, VIDEO_NON_SKIPPABLE_IN_STREAM_AD, VIDEO_OUTSTREAM_AD, VIDEO_RESPONSIVE_AD, VIDEO_TRUEVIEW_IN_STREAM_AD.
AdGroupAdAdUrlCollections String ATTRIBUTE Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.
AdGroupAdAdUrlCustomParameters String ATTRIBUTE The list of mappings that can be used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. For mutates, use URL custom parameter operations.
AdGroupAdAdVideoAdBumperActionButtonLabel String ATTRIBUTE Label on the 'Call To Action' button taking the user to the video ad's final URL.
AdGroupAdAdVideoAdBumperActionHeadline String ATTRIBUTE Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.
AdGroupAdAdVideoAdBumperCompanionBannerAsset String ATTRIBUTE The Asset resource name of this image.
AdGroupAdAdVideoAdInFeedDescription1 String ATTRIBUTE First text line for the ad.
AdGroupAdAdVideoAdInFeedDescription2 String ATTRIBUTE Second text line for the ad.
AdGroupAdAdVideoAdInFeedHeadline String ATTRIBUTE The headline of the ad.
AdGroupAdAdVideoAdInFeedThumbnail String ATTRIBUTE Video thumbnail image to use. The allowed values are DEFAULT_THUMBNAIL, THUMBNAIL_1, THUMBNAIL_2, THUMBNAIL_3, UNKNOWN, UNSPECIFIED.
AdGroupAdAdVideoAdInStreamActionButtonLabel String ATTRIBUTE Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise.
AdGroupAdAdVideoAdInStreamActionHeadline String ATTRIBUTE Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.
AdGroupAdAdVideoAdInStreamCompanionBannerAsset String ATTRIBUTE The Asset resource name of this image.
AdGroupAdAdVideoAdNonSkippableActionButtonLabel String ATTRIBUTE Label on the 'Call To Action' button taking the user to the video ad's final URL.
AdGroupAdAdVideoAdNonSkippableActionHeadline String ATTRIBUTE Additional text displayed with the 'Call To Action' button to give context and encourage clicking on the button.
AdGroupAdAdVideoAdNonSkippableCompanionBannerAsset String ATTRIBUTE The Asset resource name of this image.
AdGroupAdAdVideoAdOutStreamDescription String ATTRIBUTE The description line.
AdGroupAdAdVideoAdOutStreamHeadline String ATTRIBUTE The headline of the ad.
AdGroupAdAdVideoAdVideoAsset String ATTRIBUTE The Asset resource name of this video.
AdGroupAdAdVideoResponsiveAdBreadcrumb1 String ATTRIBUTE First part of text that appears in the ad with the displayed URL.
AdGroupAdAdVideoResponsiveAdBreadcrumb2 String ATTRIBUTE Second part of text that appears in the ad with the displayed URL.
AdGroupAdAdVideoResponsiveAdCallToActions String ATTRIBUTE List of text assets used for the button, for example, the 'Call To Action' button. Currently, only a single value for the button is supported.
AdGroupAdAdVideoResponsiveAdCompanionBanners String ATTRIBUTE List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported.
AdGroupAdAdVideoResponsiveAdDescriptions String ATTRIBUTE List of text assets used for the description. Currently, only a single value for the description is supported.
AdGroupAdAdVideoResponsiveAdHeadlines String ATTRIBUTE List of text assets used for the short headline, for example, the 'Call To Action' banner. Currently, only a single value for the short headline is supported.
AdGroupAdAdVideoResponsiveAdLongHeadlines String ATTRIBUTE List of text assets used for the long headline. Currently, only a single value for the long headline is supported.
AdGroupAdAdVideoResponsiveAdVideos String ATTRIBUTE List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported.
AdGroupAdAdGroup String ATTRIBUTE Immutable. The ad group to which the ad belongs.
AdGroupAdAdStrength String ATTRIBUTE Output only. Overall ad strength for this ad group ad. The allowed values are AVERAGE, EXCELLENT, GOOD, NO_ADS, PENDING, POOR, UNKNOWN, UNSPECIFIED.
AdGroupAdLabels String ATTRIBUTE Output only. The resource names of labels attached to this ad group ad.
AdGroupAdPolicySummaryApprovalStatus String ATTRIBUTE Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries. The allowed values are APPROVED, APPROVED_LIMITED, AREA_OF_INTEREST_ONLY, DISAPPROVED, UNKNOWN, UNSPECIFIED.
AdGroupAdPolicySummaryPolicyTopicEntries String ATTRIBUTE Output only. The list of policy findings for this ad.
AdGroupAdPolicySummaryReviewStatus String ATTRIBUTE Output only. Where in the review process this ad is. The allowed values are ELIGIBLE_MAY_SERVE, REVIEWED, REVIEW_IN_PROGRESS, UNDER_APPEAL, UNKNOWN, UNSPECIFIED.
AdGroupAdResourceName String ATTRIBUTE Immutable. The resource name of the ad. Ad group ad resource names have the form: customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}
AdGroupAdStatus String ATTRIBUTE The status of the ad. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
ActiveViewCpm Double METRIC Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr Double METRIC Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsByConversionDate Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AllConversionsValueByConversionDate Double METRIC The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllNewCustomerLifetimeValue Double METRIC All of new customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for both biddable and non-biddable conversions. If your campaign has adopted the customer acquisition goal and selected 'bid higher for new customers', these values will be included in 'all_conversions_value'. See https://support.google.com/google-ads/answer/12080169 for more details.
AverageCartSize Double METRIC Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
AverageOrderValueMicros Long METRIC Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is \(15 = (\)10 + $15 + $20)/3. This metric is only available if you report conversions with cart data.
AveragePageViews Double METRIC Average number of pages viewed per session.
AverageTimeOnSite Double METRIC Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
BounceRate Double METRIC Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsByConversionDate Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValueByConversionDate Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostOfGoodsSoldMicros Long METRIC Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostPerCurrentModelAttributedConversion Double METRIC The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
CrossSellCostOfGoodsSoldMicros Long METRIC Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data.
CrossSellGrossProfitMicros Long METRIC Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data.
CrossSellRevenueMicros Long METRIC Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data.
CrossSellUnitsSold Double METRIC Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
CurrentModelAttributedConversions Double METRIC Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CurrentModelAttributedConversionsValue Double METRIC The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
GmailForwards Long METRIC The number of times the ad was forwarded to someone else as a message.
GmailSaves Long METRIC The number of times someone has saved your Gmail ad to their inbox as a message.
GmailSecondaryClicks Long METRIC The number of clicks to the landing page on the expanded state of Gmail ads.
GrossProfitMargin Double METRIC Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced \(20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = (\)10 - \(3)/\)10 x 100%. This metric is only available if you report conversions with cart data.
GrossProfitMicros Long METRIC Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
LeadCostOfGoodsSoldMicros Long METRIC Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data.
LeadGrossProfitMicros Long METRIC Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data.
LeadRevenueMicros Long METRIC Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data.
LeadUnitsSold Double METRIC Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
NewCustomerLifetimeValue Double METRIC New customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for biddable conversions. If your campaign has adopted the customer acquisition goal and selected 'bid higher for new customers', these values will be included in 'conversions_value' for optimization. See https://support.google.com/google-ads/answer/12080169 for more details.
Orders Double METRIC Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data.
PercentNewVisitors Double METRIC Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
RevenueMicros Long METRIC Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is \(25 = (\)10 + $20) - $5. This metric is only available if you report conversions with cart data.
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown anywhere above the organic search results.
UnitsSold Double METRIC Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerAllConversionsByConversionDate Double METRIC The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ValuePerConversionsByConversionDate Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ValuePerCurrentModelAttributedConversion Double METRIC The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoQuartileP100Rate Double METRIC Percentage of impressions where the viewer watched all of your video.
VideoQuartileP25Rate Double METRIC Percentage of impressions where the viewer watched 25% of your video.
VideoQuartileP50Rate Double METRIC Percentage of impressions where the viewer watched 50% of your video.
VideoQuartileP75Rate Double METRIC Percentage of impressions where the viewer watched 75% of your video.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
AdDestinationType String SEGMENT Ad Destination type. The allowed values are APP_DEEP_LINK, APP_STORE, LEAD_FORM, LOCATION_LISTING, MAP_DIRECTIONS, MESSAGE, NOT_APPLICABLE, PHONE_CALL, UNKNOWN, UNMODELED_FOR_CONVERSIONS, UNSPECIFIED, WEBSITE, YOUTUBE.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
ConversionAdjustment Bool SEGMENT This segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.
ConversionLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion. The allowed values are EIGHT_TO_NINE_DAYS, ELEVEN_TO_TWELVE_DAYS, FIVE_TO_SIX_DAYS, FORTY_FIVE_TO_SIXTY_DAYS, FOURTEEN_TO_TWENTY_ONE_DAYS, FOUR_TO_FIVE_DAYS, LESS_THAN_ONE_DAY, NINE_TO_TEN_DAYS, ONE_TO_TWO_DAYS, SEVEN_TO_EIGHT_DAYS, SIXTY_TO_NINETY_DAYS, SIX_TO_SEVEN_DAYS, TEN_TO_ELEVEN_DAYS, THIRTEEN_TO_FOURTEEN_DAYS, THIRTY_TO_FORTY_FIVE_DAYS, THREE_TO_FOUR_DAYS, TWELVE_TO_THIRTEEN_DAYS, TWENTY_ONE_TO_THIRTY_DAYS, TWO_TO_THREE_DAYS, UNKNOWN, UNSPECIFIED.
ConversionOrAdjustmentLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion. The allowed values are ADJUSTMENT_EIGHT_TO_NINE_DAYS, ADJUSTMENT_ELEVEN_TO_TWELVE_DAYS, ADJUSTMENT_FIVE_TO_SIX_DAYS, ADJUSTMENT_FORTY_FIVE_TO_SIXTY_DAYS, ADJUSTMENT_FOURTEEN_TO_TWENTY_ONE_DAYS, ADJUSTMENT_FOUR_TO_FIVE_DAYS, ADJUSTMENT_LESS_THAN_ONE_DAY, ADJUSTMENT_NINETY_TO_ONE_HUNDRED_AND_FORTY_FIVE_DAYS, ADJUSTMENT_NINE_TO_TEN_DAYS, ADJUSTMENT_ONE_TO_TWO_DAYS, ADJUSTMENT_SEVEN_TO_EIGHT_DAYS, ADJUSTMENT_SIXTY_TO_NINETY_DAYS, ADJUSTMENT_SIX_TO_SEVEN_DAYS, ADJUSTMENT_TEN_TO_ELEVEN_DAYS, ADJUSTMENT_THIRTEEN_TO_FOURTEEN_DAYS, ADJUSTMENT_THIRTY_TO_FORTY_FIVE_DAYS, ADJUSTMENT_THREE_TO_FOUR_DAYS, ADJUSTMENT_TWELVE_TO_THIRTEEN_DAYS, ADJUSTMENT_TWENTY_ONE_TO_THIRTY_DAYS, ADJUSTMENT_TWO_TO_THREE_DAYS, ADJUSTMENT_UNKNOWN, CONVERSION_EIGHT_TO_NINE_DAYS, CONVERSION_ELEVEN_TO_TWELVE_DAYS, CONVERSION_FIVE_TO_SIX_DAYS, CONVERSION_FORTY_FIVE_TO_SIXTY_DAYS, CONVERSION_FOURTEEN_TO_TWENTY_ONE_DAYS, CONVERSION_FOUR_TO_FIVE_DAYS, CONVERSION_LESS_THAN_ONE_DAY, CONVERSION_NINE_TO_TEN_DAYS, CONVERSION_ONE_TO_TWO_DAYS, CONVERSION_SEVEN_TO_EIGHT_DAYS, CONVERSION_SIXTY_TO_NINETY_DAYS, CONVERSION_SIX_TO_SEVEN_DAYS, CONVERSION_TEN_TO_ELEVEN_DAYS, CONVERSION_THIRTEEN_TO_FOURTEEN_DAYS, CONVERSION_THIRTY_TO_FORTY_FIVE_DAYS, CONVERSION_THREE_TO_FOUR_DAYS, CONVERSION_TWELVE_TO_THIRTEEN_DAYS, CONVERSION_TWENTY_ONE_TO_THIRTY_DAYS, CONVERSION_TWO_TO_THREE_DAYS, CONVERSION_UNKNOWN, UNKNOWN, UNSPECIFIED.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
KeywordAdGroupCriterion String SEGMENT The AdGroupCriterion resource name.
KeywordInfoMatchType String SEGMENT The match type of the keyword. The allowed values are BROAD, EXACT, PHRASE, UNKNOWN, UNSPECIFIED.
KeywordInfoText String SEGMENT The text of the keyword (at most 80 characters and 10 words).
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
NewVersusReturningCustomers String SEGMENT This is for segmenting conversions by whether the user is a new customer or a returning customer. This segmentation is typically used to measure the impact of customer acquisition goal. The allowed values are NEW, NEW_AND_HIGH_LTV, RETURNING, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupAdAssetCombinationView

A view on the usage of ad group ad asset combination. Now we only support AdGroupAdAssetCombinationView for Responsive Search Ads, with more ad types planned for the future.

Columns
Name Type Behavior Description
AdGroupAdAssetCombinationViewEnabled Bool ATTRIBUTE Output only. The status between the asset combination and the latest version of the ad. If true, the asset combination is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.
AdGroupAdAssetCombinationViewResourceName String ATTRIBUTE Output only. The resource name of the ad group ad asset combination view. The combination ID is 128 bits long, where the upper 64 bits are stored in asset_combination_id_high, and the lower 64 bits are stored in asset_combination_id_low. AdGroupAd Asset Combination view resource names have the form: customers/{customer_id}/adGroupAdAssetCombinationViews/{AdGroupAd.ad_group_id}~{AdGroupAd.ad.ad_id}~{AssetCombination.asset_combination_id_low}~{AssetCombination.asset_combination_id_high}
AdGroupAdAssetCombinationViewServedAssets String ATTRIBUTE Output only. Served assets.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupAdAssetView

A link between an AdGroupAd and an Asset. Currently we only support AdGroupAdAssetView for AppAds and Responsive Search Ads.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
AdGroupAdAssetViewAdGroupAd String ATTRIBUTE Output only. The ad group ad to which the asset is linked.
AdGroupAdAssetViewAsset String ATTRIBUTE Output only. The asset which is linked to the ad group ad.
AdGroupAdAssetViewEnabled Bool ATTRIBUTE Output only. The status between the asset and the latest version of the ad. If true, the asset is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.
AdGroupAdAssetViewFieldType String ATTRIBUTE Output only. Role that the asset takes in the ad. The allowed values are AD_IMAGE, BOOK_ON_GOOGLE, BUSINESS_LOGO, BUSINESS_NAME, CALL, CALLOUT, CALL_TO_ACTION_SELECTION, DESCRIPTION, HEADLINE, HOTEL_CALLOUT, HOTEL_PROPERTY, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MANDATORY_AD_TEXT, MARKETING_IMAGE, MEDIA_BUNDLE, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, VIDEO, YOUTUBE_VIDEO.
AdGroupAdAssetViewPerformanceLabel String ATTRIBUTE Output only. Performance of an asset linkage. The allowed values are BEST, GOOD, LEARNING, LOW, PENDING, UNKNOWN, UNSPECIFIED.
AdGroupAdAssetViewPinnedField String ATTRIBUTE Output only. Pinned field. The allowed values are AD_IMAGE, BUSINESS_LOGO, BUSINESS_NAME, BUSINESS_NAME_IN_PORTRAIT, CALL, CALLOUT, CALL_TO_ACTION, DESCRIPTION, DESCRIPTION_1, DESCRIPTION_2, DESCRIPTION_IN_PORTRAIT, HEADLINE, HEADLINE_1, HEADLINE_2, HEADLINE_3, HEADLINE_IN_PORTRAIT, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MARKETING_IMAGE, MARKETING_IMAGE_IN_PORTRAIT, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, YOU_TUBE_VIDEO.
AdGroupAdAssetViewPolicySummary String ATTRIBUTE Output only. Policy information for the ad group ad asset.
AdGroupAdAssetViewResourceName String ATTRIBUTE Output only. The resource name of the ad group ad asset view. Ad group ad asset view resource names have the form (Before V4): customers/{customer_id}/adGroupAdAssets/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type} Ad group ad asset view resource names have the form (Beginning from V4): customers/{customer_id}/adGroupAdAssetViews/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}
AdGroupAdAssetViewSource String ATTRIBUTE Output only. Source of the ad group ad asset. The allowed values are ADVERTISER, AUTOMATICALLY_CREATED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsValue Double METRIC The value of all conversions.
AllConversionsValuePerCost Double METRIC The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
BiddableAppInstallConversions Double METRIC Number of app installs.
BiddableAppPostInstallConversions Double METRIC Number of in-app actions.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValuePerCost Double METRIC The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
ConversionAction String SEGMENT Resource name of the conversion action.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupAdLabel

A relationship between an ad group ad and a label.

Columns
Name Type Behavior Description
AdGroupAdLabelAdGroupAd String ATTRIBUTE Immutable. The ad group ad to which the label is attached.
AdGroupAdLabelLabel String ATTRIBUTE Immutable. The label assigned to the ad group ad.
AdGroupAdLabelResourceName String ATTRIBUTE Immutable. The resource name of the ad group ad label. Ad group ad label resource names have the form: customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupAsset

A link between an ad group and an asset.

Columns
Name Type Behavior Description
AdGroupAssetAdGroup String ATTRIBUTE Required. Immutable. The ad group to which the asset is linked.
AdGroupAssetAsset String ATTRIBUTE Required. Immutable. The asset which is linked to the ad group.
AdGroupAssetFieldType String ATTRIBUTE Required. Immutable. Role that the asset takes under the linked ad group. The allowed values are AD_IMAGE, BOOK_ON_GOOGLE, BUSINESS_LOGO, BUSINESS_NAME, CALL, CALLOUT, CALL_TO_ACTION_SELECTION, DESCRIPTION, HEADLINE, HOTEL_CALLOUT, HOTEL_PROPERTY, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MANDATORY_AD_TEXT, MARKETING_IMAGE, MEDIA_BUNDLE, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, VIDEO, YOUTUBE_VIDEO.
AdGroupAssetPrimaryStatus String ATTRIBUTE Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain 'status' field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state. The allowed values are ELIGIBLE, LIMITED, NOT_ELIGIBLE, PAUSED, PENDING, REMOVED, UNKNOWN, UNSPECIFIED.
AdGroupAssetPrimaryStatusDetails String ATTRIBUTE Output only. Provides the details of the primary status and its associated reasons.
AdGroupAssetPrimaryStatusReasons String ATTRIBUTE Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity. The allowed values are ASSET_APPROVED_LABELED, ASSET_DISAPPROVED, ASSET_LINK_PAUSED, ASSET_LINK_REMOVED, ASSET_UNDER_REVIEW, UNKNOWN, UNSPECIFIED.
AdGroupAssetResourceName String ATTRIBUTE Immutable. The resource name of the ad group asset. AdGroupAsset resource names have the form: customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}
AdGroupAssetSource String ATTRIBUTE Output only. Source of the adgroup asset link. The allowed values are ADVERTISER, AUTOMATICALLY_CREATED, UNKNOWN, UNSPECIFIED.
AdGroupAssetStatus String ATTRIBUTE Status of the ad group asset. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
PhoneCalls Long METRIC Number of offline phone calls.
PhoneImpressions Long METRIC Number of offline phone impressions.
PhoneThroughRate Double METRIC Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown anywhere above the organic search results.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
AssetInteractionTargetAsset String SEGMENT The asset resource name.
AssetInteractionTargetInteractionOnThisAsset Bool SEGMENT Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupAssetSet

AdGroupAssetSet is the linkage between an ad group and an asset set. Creating an AdGroupAssetSet links an asset set with an ad group.

Columns
Name Type Behavior Description
AdGroupAssetSetAdGroup String ATTRIBUTE Immutable. The ad group to which this asset set is linked.
AdGroupAssetSetAssetSet String ATTRIBUTE Immutable. The asset set which is linked to the ad group.
AdGroupAssetSetResourceName String ATTRIBUTE Immutable. The resource name of the ad group asset set. Ad group asset set resource names have the form: customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}
AdGroupAssetSetStatus String ATTRIBUTE Output only. The status of the ad group asset set. Read-only. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupAudienceView

An ad group audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated at the audience level.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
AdGroupAudienceViewResourceName String ATTRIBUTE Output only. The resource name of the ad group audience view. Ad group audience view resource names have the form: customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
ActiveViewCpm Double METRIC Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr Double METRIC Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsByConversionDate Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsFromInteractionsValuePerInteraction Double METRIC The value of all conversions from interactions divided by the total number of interactions.
AllConversionsValue Double METRIC The value of all conversions.
AllConversionsValueByConversionDate Double METRIC The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllConversionsValuePerCost Double METRIC The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsByConversionDate Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValueByConversionDate Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
GmailForwards Long METRIC The number of times the ad was forwarded to someone else as a message.
GmailSaves Long METRIC The number of times someone has saved your Gmail ad to their inbox as a message.
GmailSecondaryClicks Long METRIC The number of clicks to the landing page on the expanded state of Gmail ads.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown anywhere above the organic search results.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerAllConversionsByConversionDate Double METRIC The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ValuePerConversionsByConversionDate Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
VideoQuartileP100Rate Double METRIC Percentage of impressions where the viewer watched all of your video.
VideoQuartileP25Rate Double METRIC Percentage of impressions where the viewer watched 25% of your video.
VideoQuartileP50Rate Double METRIC Percentage of impressions where the viewer watched 50% of your video.
VideoQuartileP75Rate Double METRIC Percentage of impressions where the viewer watched 75% of your video.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
HotelDateSelectionType String SEGMENT Hotel date selection type. The allowed values are DEFAULT_SELECTION, UNKNOWN, UNSPECIFIED, USER_SELECTED.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupBidModifier

Represents an ad group bid modifier.

Columns
Name Type Behavior Description
AdGroupBidModifierAdGroup String ATTRIBUTE Immutable. The ad group to which this criterion belongs.
AdGroupBidModifierBaseAdGroup String ATTRIBUTE Output only. The base ad group from which this draft/trial adgroup bid modifier was created. If ad_group is a base ad group then this field will be equal to ad_group. If the ad group was created in the draft or trial and has no corresponding base ad group, then this field will be null. This field is readonly.
AdGroupBidModifierBidModifier Double ATTRIBUTE The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent. Use 0 to opt out of a Device type.
AdGroupBidModifierBidModifierSource String ATTRIBUTE Output only. Bid modifier source. The allowed values are AD_GROUP, CAMPAIGN, UNKNOWN, UNSPECIFIED.
AdGroupBidModifierCriterionId Long ATTRIBUTE Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
AdGroupBidModifierDeviceType String ATTRIBUTE Type of the device. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
AdGroupBidModifierHotelAdvanceBookingWindowMaxDays Long ATTRIBUTE High end of the number of days prior to the stay.
AdGroupBidModifierHotelAdvanceBookingWindowMinDays Long ATTRIBUTE Low end of the number of days prior to the stay.
AdGroupBidModifierHotelCheckInDateRangeEndDate String ATTRIBUTE End date in the YYYY-MM-DD format.
AdGroupBidModifierHotelCheckInDateRangeStartDate String ATTRIBUTE Start date in the YYYY-MM-DD format.
AdGroupBidModifierHotelCheckInDayDayOfWeek String ATTRIBUTE The day of the week. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
AdGroupBidModifierHotelDateSelectionTypeType String ATTRIBUTE Type of the hotel date selection The allowed values are DEFAULT_SELECTION, UNKNOWN, UNSPECIFIED, USER_SELECTED.
AdGroupBidModifierHotelLengthOfStayMaxNights Long ATTRIBUTE High end of the number of nights in the stay.
AdGroupBidModifierHotelLengthOfStayMinNights Long ATTRIBUTE Low end of the number of nights in the stay.
AdGroupBidModifierResourceName String ATTRIBUTE Immutable. The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form: customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupCriterion

An ad group criterion.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
AdGroupCriterionAdGroup String ATTRIBUTE Immutable. The ad group to which the criterion belongs.
AdGroupCriterionAgeRangeType String ATTRIBUTE Type of the age range. The allowed values are AGE_RANGE_18_24, AGE_RANGE_25_34, AGE_RANGE_35_44, AGE_RANGE_45_54, AGE_RANGE_55_64, AGE_RANGE_65_UP, AGE_RANGE_UNDETERMINED, UNKNOWN, UNSPECIFIED.
AdGroupCriterionAppPaymentModelType String ATTRIBUTE Type of the app payment model. The allowed values are PAID, UNKNOWN, UNSPECIFIED.
AdGroupCriterionApprovalStatus String ATTRIBUTE Output only. Approval status of the criterion. The allowed values are APPROVED, DISAPPROVED, PENDING_REVIEW, UNDER_REVIEW, UNKNOWN, UNSPECIFIED.
AdGroupCriterionAudienceAudience String ATTRIBUTE The Audience resource name.
AdGroupCriterionBidModifier Double ATTRIBUTE The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.
AdGroupCriterionCombinedAudienceCombinedAudience String ATTRIBUTE The CombinedAudience resource name.
AdGroupCriterionCpcBidMicros Long ATTRIBUTE The CPC (cost-per-click) bid.
AdGroupCriterionCpmBidMicros Long ATTRIBUTE The CPM (cost-per-thousand viewable impressions) bid.
AdGroupCriterionCpvBidMicros Long ATTRIBUTE The CPV (cost-per-view) bid.
AdGroupCriterionCriterionId Long ATTRIBUTE Output only. The ID of the criterion. This field is ignored for mutates.
AdGroupCriterionCustomAffinityCustomAffinity String ATTRIBUTE The CustomInterest resource name.
AdGroupCriterionCustomAudienceCustomAudience String ATTRIBUTE The CustomAudience resource name.
AdGroupCriterionCustomIntentCustomIntent String ATTRIBUTE The CustomInterest resource name.
AdGroupCriterionDisapprovalReasons String ATTRIBUTE Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942 This field is read-only.
AdGroupCriterionDisplayName String ATTRIBUTE Output only. The display name of the criterion. This field is ignored for mutates.
AdGroupCriterionEffectiveCpcBidMicros Long ATTRIBUTE Output only. The effective CPC (cost-per-click) bid.
AdGroupCriterionEffectiveCpcBidSource String ATTRIBUTE Output only. Source of the effective CPC bid. The allowed values are AD_GROUP, AD_GROUP_CRITERION, CAMPAIGN_BIDDING_STRATEGY, UNKNOWN, UNSPECIFIED.
AdGroupCriterionEffectiveCpmBidMicros Long ATTRIBUTE Output only. The effective CPM (cost-per-thousand viewable impressions) bid.
AdGroupCriterionEffectiveCpmBidSource String ATTRIBUTE Output only. Source of the effective CPM bid. The allowed values are AD_GROUP, AD_GROUP_CRITERION, CAMPAIGN_BIDDING_STRATEGY, UNKNOWN, UNSPECIFIED.
AdGroupCriterionEffectiveCpvBidMicros Long ATTRIBUTE Output only. The effective CPV (cost-per-view) bid.
AdGroupCriterionEffectiveCpvBidSource String ATTRIBUTE Output only. Source of the effective CPV bid. The allowed values are AD_GROUP, AD_GROUP_CRITERION, CAMPAIGN_BIDDING_STRATEGY, UNKNOWN, UNSPECIFIED.
AdGroupCriterionEffectivePercentCpcBidMicros Long ATTRIBUTE Output only. The effective Percent CPC bid amount.
AdGroupCriterionEffectivePercentCpcBidSource String ATTRIBUTE Output only. Source of the effective Percent CPC bid. The allowed values are AD_GROUP, AD_GROUP_CRITERION, CAMPAIGN_BIDDING_STRATEGY, UNKNOWN, UNSPECIFIED.
AdGroupCriterionFinalMobileUrls String ATTRIBUTE The list of possible final mobile URLs after all cross-domain redirects.
AdGroupCriterionFinalUrlSuffix String ATTRIBUTE URL template for appending params to final URL.
AdGroupCriterionFinalUrls String ATTRIBUTE The list of possible final URLs after all cross-domain redirects for the ad.
AdGroupCriterionGenderType String ATTRIBUTE Type of the gender. The allowed values are FEMALE, MALE, UNDETERMINED, UNKNOWN, UNSPECIFIED.
AdGroupCriterionIncomeRangeType String ATTRIBUTE Type of the income range. The allowed values are INCOME_RANGE_0_50, INCOME_RANGE_50_60, INCOME_RANGE_60_70, INCOME_RANGE_70_80, INCOME_RANGE_80_90, INCOME_RANGE_90_UP, INCOME_RANGE_UNDETERMINED, UNKNOWN, UNSPECIFIED.
AdGroupCriterionKeywordMatchType String ATTRIBUTE The match type of the keyword. The allowed values are BROAD, EXACT, PHRASE, UNKNOWN, UNSPECIFIED.
AdGroupCriterionKeywordText String ATTRIBUTE The text of the keyword (at most 80 characters and 10 words).
AdGroupCriterionLabels String ATTRIBUTE Output only. The resource names of labels attached to this ad group criterion.
AdGroupCriterionLanguageLanguageConstant String ATTRIBUTE The language constant resource name.
AdGroupCriterionListingGroupCaseValueActivityCountryValue String ATTRIBUTE String value of the activity country. The Geo Target Constant resource name.
AdGroupCriterionListingGroupCaseValueActivityIdValue String ATTRIBUTE String value of the activity ID.
AdGroupCriterionListingGroupCaseValueActivityRatingValue Long ATTRIBUTE Long value of the activity rating.
AdGroupCriterionListingGroupCaseValueHotelCityCityCriterion String ATTRIBUTE The Geo Target Constant resource name.
AdGroupCriterionListingGroupCaseValueHotelClassValue Long ATTRIBUTE Long value of the hotel class.
AdGroupCriterionListingGroupCaseValueHotelCountryRegionCountryRegionCriterion String ATTRIBUTE The Geo Target Constant resource name.
AdGroupCriterionListingGroupCaseValueHotelIdValue String ATTRIBUTE String value of the hotel ID.
AdGroupCriterionListingGroupCaseValueHotelStateStateCriterion String ATTRIBUTE The Geo Target Constant resource name.
AdGroupCriterionListingGroupCaseValueProductBrandValue String ATTRIBUTE String value of the product brand.
AdGroupCriterionListingGroupCaseValueProductCategoryCategoryId Long ATTRIBUTE ID of the product category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
AdGroupCriterionListingGroupCaseValueProductCategoryLevel String ATTRIBUTE Level of the product category. The allowed values are LEVEL1, LEVEL2, LEVEL3, LEVEL4, LEVEL5, UNKNOWN, UNSPECIFIED.
AdGroupCriterionListingGroupCaseValueProductChannelChannel String ATTRIBUTE Value of the locality. The allowed values are LOCAL, ONLINE, UNKNOWN, UNSPECIFIED.
AdGroupCriterionListingGroupCaseValueProductChannelExclusivityChannelExclusivity String ATTRIBUTE Value of the availability. The allowed values are MULTI_CHANNEL, SINGLE_CHANNEL, UNKNOWN, UNSPECIFIED.
AdGroupCriterionListingGroupCaseValueProductConditionCondition String ATTRIBUTE Value of the condition. The allowed values are NEW, REFURBISHED, UNKNOWN, UNSPECIFIED, USED.
AdGroupCriterionListingGroupCaseValueProductCustomAttributeIndex String ATTRIBUTE Indicates the index of the custom attribute. The allowed values are INDEX0, INDEX1, INDEX2, INDEX3, INDEX4, UNKNOWN, UNSPECIFIED.
AdGroupCriterionListingGroupCaseValueProductCustomAttributeValue String ATTRIBUTE String value of the product custom attribute.
AdGroupCriterionListingGroupCaseValueProductItemIdValue String ATTRIBUTE Value of the id.
AdGroupCriterionListingGroupCaseValueProductTypeLevel String ATTRIBUTE Level of the type. The allowed values are LEVEL1, LEVEL2, LEVEL3, LEVEL4, LEVEL5, UNKNOWN, UNSPECIFIED.
AdGroupCriterionListingGroupCaseValueProductTypeValue String ATTRIBUTE Value of the type.
AdGroupCriterionListingGroupParentAdGroupCriterion String ATTRIBUTE Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group.
AdGroupCriterionListingGroupPath String ATTRIBUTE The path of dimensions defining this listing group.
AdGroupCriterionListingGroupType String ATTRIBUTE Type of the listing group. The allowed values are SUBDIVISION, UNIT, UNKNOWN, UNSPECIFIED.
AdGroupCriterionLocationGeoTargetConstant String ATTRIBUTE The geo target constant resource name.
AdGroupCriterionMobileAppCategoryMobileAppCategoryConstant String ATTRIBUTE The mobile app category constant resource name.
AdGroupCriterionMobileApplicationAppId String ATTRIBUTE A string that uniquely identifies a mobile application to Google Ads API. The format of this string is '{platform}-{platform_native_id}', where platform is '1' for iOS apps and '2' for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (for example, '476943146' for 'Flood-It! 2' whose App Store link is 'http://itunes.apple.com/us/app/flood-it!-2/id476943146'). For Android, this native identifier is the application's package name (for example, 'com.labpixies.colordrips' for 'Color Drips' given Google Play link 'https://play.google.com/store/apps/details?id=com.labpixies.colordrips'). A well formed app ID for Google Ads API would thus be '1-476943146' for iOS and '2-com.labpixies.colordrips' for Android. This field is required and must be set in CREATE operations.
AdGroupCriterionMobileApplicationName String ATTRIBUTE Name of this mobile application.
AdGroupCriterionNegative Bool ATTRIBUTE Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it.
AdGroupCriterionParentalStatusType String ATTRIBUTE Type of the parental status. The allowed values are NOT_A_PARENT, PARENT, UNDETERMINED, UNKNOWN, UNSPECIFIED.
AdGroupCriterionPercentCpcBidMicros Long ATTRIBUTE The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0, 1) and the value stored here is 1, 000, 000 * [fraction].
AdGroupCriterionPlacementUrl String ATTRIBUTE URL of the placement. For example, 'http://www.domain.com'.
AdGroupCriterionPositionEstimatesEstimatedAddClicksAtFirstPositionCpc Long ATTRIBUTE Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros.
AdGroupCriterionPositionEstimatesEstimatedAddCostAtFirstPositionCpc Long ATTRIBUTE Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.
AdGroupCriterionPositionEstimatesFirstPageCpcMicros Long ATTRIBUTE Output only. The estimate of the CPC bid required for ad to be shown on first page of search results.
AdGroupCriterionPositionEstimatesFirstPositionCpcMicros Long ATTRIBUTE Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results.
AdGroupCriterionPositionEstimatesTopOfPageCpcMicros Long ATTRIBUTE Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
AdGroupCriterionQualityInfoCreativeQualityScore String ATTRIBUTE Output only. The performance of the ad compared to other advertisers. The allowed values are ABOVE_AVERAGE, AVERAGE, BELOW_AVERAGE, UNKNOWN, UNSPECIFIED.
AdGroupCriterionQualityInfoPostClickQualityScore String ATTRIBUTE Output only. The quality score of the landing page. The allowed values are ABOVE_AVERAGE, AVERAGE, BELOW_AVERAGE, UNKNOWN, UNSPECIFIED.
AdGroupCriterionQualityInfoQualityScore Int ATTRIBUTE Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value.
AdGroupCriterionQualityInfoSearchPredictedCtr String ATTRIBUTE Output only. The click-through rate compared to that of other advertisers. The allowed values are ABOVE_AVERAGE, AVERAGE, BELOW_AVERAGE, UNKNOWN, UNSPECIFIED.
AdGroupCriterionResourceName String ATTRIBUTE Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}
AdGroupCriterionStatus String ATTRIBUTE The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as 'enabled', since they're eligible to see the ads; but AdGroupCriterion.status will show 'removed', since no positive criterion was added. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
AdGroupCriterionSystemServingStatus String ATTRIBUTE Output only. Serving status of the criterion. The allowed values are ELIGIBLE, RARELY_SERVED, UNKNOWN, UNSPECIFIED.
AdGroupCriterionTopicPath String ATTRIBUTE The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, 'Pets & Animals', 'Pets', 'Dogs' represents the 'Pets & Animals/Pets/Dogs' category.
AdGroupCriterionTopicTopicConstant String ATTRIBUTE The Topic Constant resource name.
AdGroupCriterionTrackingUrlTemplate String ATTRIBUTE The URL template for constructing a tracking URL.
AdGroupCriterionType String ATTRIBUTE Output only. The type of the criterion. The allowed values are AD_SCHEDULE, AGE_RANGE, APP_PAYMENT_MODEL, AUDIENCE, BRAND, BRAND_LIST, CARRIER, COMBINED_AUDIENCE, CONTENT_LABEL, CUSTOM_AFFINITY, CUSTOM_AUDIENCE, CUSTOM_INTENT, DEVICE, GENDER, INCOME_RANGE, IP_BLOCK, KEYWORD, KEYWORD_THEME, LANGUAGE, LISTING_GROUP, LISTING_SCOPE, LOCAL_SERVICE_ID, LOCATION, LOCATION_GROUP, MOBILE_APPLICATION, MOBILE_APP_CATEGORY, MOBILE_DEVICE, NEGATIVE_KEYWORD_LIST, OPERATING_SYSTEM_VERSION, PARENTAL_STATUS, PLACEMENT, PROXIMITY, SEARCH_THEME, TOPIC, UNKNOWN, UNSPECIFIED, USER_INTEREST, USER_LIST, WEBPAGE, YOUTUBE_CHANNEL, YOUTUBE_VIDEO.
AdGroupCriterionUrlCustomParameters String ATTRIBUTE The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.
AdGroupCriterionUserInterestUserInterestCategory String ATTRIBUTE The UserInterest resource name.
AdGroupCriterionUserListUserList String ATTRIBUTE The User List resource name.
AdGroupCriterionWebpageConditions String ATTRIBUTE Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
AdGroupCriterionWebpageCoveragePercentage Double ATTRIBUTE Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.
AdGroupCriterionWebpageCriterionName String ATTRIBUTE The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
AdGroupCriterionWebpageSampleSampleUrls String ATTRIBUTE Webpage sample URLs
AdGroupCriterionYoutubeChannelChannelId String ATTRIBUTE The YouTube uploader channel ID or the channel code of a YouTube channel.
AdGroupCriterionYoutubeVideoVideoId String ATTRIBUTE YouTube video ID as it appears on the YouTube watch page.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupCriterionCustomizer

A customizer value for the associated CustomizerAttribute at the AdGroupCriterion level.

Columns
Name Type Behavior Description
AdGroupCriterionCustomizerAdGroupCriterion String ATTRIBUTE Immutable. The ad group criterion to which the customizer attribute is linked. It must be a keyword criterion.
AdGroupCriterionCustomizerCustomizerAttribute String ATTRIBUTE Required. Immutable. The customizer attribute which is linked to the ad group criterion.
AdGroupCriterionCustomizerResourceName String ATTRIBUTE Immutable. The resource name of the ad group criterion customizer. Ad group criterion customizer resource names have the form: customers/{customer_id}/adGroupCriterionCustomizers/{ad_group_id}~{criterion_id}~{customizer_attribute_id}
AdGroupCriterionCustomizerStatus String ATTRIBUTE Output only. The status of the ad group criterion customizer. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
AdGroupCriterionCustomizerValueStringValue String ATTRIBUTE Required. Value to insert in creative text. Customizer values of all types are stored as string to make formatting unambiguous.
AdGroupCriterionCustomizerValueType String ATTRIBUTE Required. The data type for the customizer value. It must match the attribute type. The string_value content must match the constraints associated with the type. The allowed values are NUMBER, PERCENT, PRICE, TEXT, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupCriterionLabel

A relationship between an ad group criterion and a label.

Columns
Name Type Behavior Description
AdGroupCriterionLabelAdGroupCriterion String ATTRIBUTE Immutable. The ad group criterion to which the label is attached.
AdGroupCriterionLabelLabel String ATTRIBUTE Immutable. The label assigned to the ad group criterion.
AdGroupCriterionLabelResourceName String ATTRIBUTE Immutable. The resource name of the ad group criterion label. Ad group criterion label resource names have the form: customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupCriterionSimulation

An ad group criterion simulation. Supported combinations of advertising channel type, criterion type, simulation type, and simulation modification method are detailed below respectively. Hotel AdGroupCriterion simulation operations starting in V5. 1. DISPLAY - KEYWORD - CPC_BID - UNIFORM 2. SEARCH - KEYWORD - CPC_BID - UNIFORM 3. SHOPPING - LISTING_GROUP - CPC_BID - UNIFORM 4. HOTEL - LISTING_GROUP - CPC_BID - UNIFORM 5. HOTEL - LISTING_GROUP - PERCENT_CPC_BID - UNIFORM

Columns
Name Type Behavior Description
AdGroupCriterionSimulationAdGroupId Long ATTRIBUTE Output only. AdGroup ID of the simulation.
AdGroupCriterionSimulationCpcBidPointListPoints String ATTRIBUTE Projected metrics for a series of CPC bid amounts.
AdGroupCriterionSimulationCriterionId Long ATTRIBUTE Output only. Criterion ID of the simulation.
AdGroupCriterionSimulationEndDate Date ATTRIBUTE Output only. Last day on which the simulation is based, in YYYY-MM-DD format.
AdGroupCriterionSimulationModificationMethod String ATTRIBUTE Output only. How the simulation modifies the field. The allowed values are DEFAULT, SCALING, UNIFORM, UNKNOWN, UNSPECIFIED.
AdGroupCriterionSimulationPercentCpcBidPointListPoints String ATTRIBUTE Projected metrics for a series of percent CPC bid amounts.
AdGroupCriterionSimulationResourceName String ATTRIBUTE Output only. The resource name of the ad group criterion simulation. Ad group criterion simulation resource names have the form: customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}
AdGroupCriterionSimulationStartDate Date ATTRIBUTE Output only. First day on which the simulation is based, in YYYY-MM-DD format.
AdGroupCriterionSimulationType String ATTRIBUTE Output only. The field that the simulation modifies. The allowed values are BID_MODIFIER, BUDGET, CPC_BID, CPV_BID, PERCENT_CPC_BID, TARGET_CPA, TARGET_IMPRESSION_SHARE, TARGET_ROAS, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupCustomizer

A customizer value for the associated CustomizerAttribute at the AdGroup level.

Columns
Name Type Behavior Description
AdGroupCustomizerAdGroup String ATTRIBUTE Immutable. The ad group to which the customizer attribute is linked.
AdGroupCustomizerCustomizerAttribute String ATTRIBUTE Required. Immutable. The customizer attribute which is linked to the ad group.
AdGroupCustomizerResourceName String ATTRIBUTE Immutable. The resource name of the ad group customizer. Ad group customizer resource names have the form: customers/{customer_id}/adGroupCustomizers/{ad_group_id}~{customizer_attribute_id}
AdGroupCustomizerStatus String ATTRIBUTE Output only. The status of the ad group customizer. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
AdGroupCustomizerValueStringValue String ATTRIBUTE Required. Value to insert in creative text. Customizer values of all types are stored as string to make formatting unambiguous.
AdGroupCustomizerValueType String ATTRIBUTE Required. The data type for the customizer value. It must match the attribute type. The string_value content must match the constraints associated with the type. The allowed values are NUMBER, PERCENT, PRICE, TEXT, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupExtensionSetting

An ad group extension setting.

Columns
Name Type Behavior Description
AdGroupExtensionSettingAdGroup String ATTRIBUTE Immutable. The resource name of the ad group. The linked extension feed items will serve under this ad group. AdGroup resource names have the form: customers/{customer_id}/adGroups/{ad_group_id}
AdGroupExtensionSettingDevice String ATTRIBUTE The device for which the extensions will serve. Optional. The allowed values are DESKTOP, MOBILE, UNKNOWN, UNSPECIFIED.
AdGroupExtensionSettingExtensionFeedItems String ATTRIBUTE The resource names of the extension feed items to serve under the ad group. ExtensionFeedItem resource names have the form: customers/{customer_id}/extensionFeedItems/{feed_item_id}
AdGroupExtensionSettingExtensionType String ATTRIBUTE Immutable. The extension type of the ad group extension setting. The allowed values are AFFILIATE_LOCATION, APP, CALL, CALLOUT, HOTEL_CALLOUT, IMAGE, LOCATION, MESSAGE, NONE, PRICE, PROMOTION, SITELINK, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED.
AdGroupExtensionSettingResourceName String ATTRIBUTE Immutable. The resource name of the ad group extension setting. AdGroupExtensionSetting resource names have the form: customers/{customer_id}/adGroupExtensionSettings/{ad_group_id}~{extension_type}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupFeed

An ad group feed.

Columns
Name Type Behavior Description
AdGroupFeedAdGroup String ATTRIBUTE Immutable. The ad group being linked to the feed.
AdGroupFeedFeed String ATTRIBUTE Immutable. The feed being linked to the ad group.
AdGroupFeedMatchingFunctionFunctionString String ATTRIBUTE String representation of the Function. Examples: 1. IDENTITY(true) or IDENTITY(false). All or no feed items served. 2. EQUALS(CONTEXT.DEVICE, 'Mobile') 3. IN(FEED_ITEM_ID, {1000001, 1000002, 1000003}) 4. CONTAINS_ANY(FeedAttribute[12345678, 0], {'Mars cruise', 'Venus cruise'}) 5. AND(IN(FEED_ITEM_ID, {10001, 10002}), EQUALS(CONTEXT.DEVICE, 'Mobile')) For more details, visit https://developers.google.com/google-ads/api/docs/extensions/feeds/matching-functions Note that because multiple strings may represent the same underlying function (whitespace and single versus double quotation marks, for example), the value returned may not be identical to the string sent in a mutate request.
AdGroupFeedMatchingFunctionLeftOperands String ATTRIBUTE The operands on the left hand side of the equation. This is also the operand to be used for single operand expressions such as NOT.
AdGroupFeedMatchingFunctionOperator String ATTRIBUTE Operator for a function. The allowed values are AND, CONTAINS_ANY, EQUALS, IDENTITY, IN, UNKNOWN, UNSPECIFIED.
AdGroupFeedMatchingFunctionRightOperands String ATTRIBUTE The operands on the right hand side of the equation.
AdGroupFeedPlaceholderTypes String ATTRIBUTE Indicates which placeholder types the feed may populate under the connected ad group. Required. The allowed values are AD_CUSTOMIZER, AFFILIATE_LOCATION, APP, CALL, CALLOUT, DYNAMIC_CUSTOM, DYNAMIC_EDUCATION, DYNAMIC_FLIGHT, DYNAMIC_HOTEL, DYNAMIC_JOB, DYNAMIC_LOCAL, DYNAMIC_REAL_ESTATE, DYNAMIC_TRAVEL, IMAGE, LOCATION, MESSAGE, PRICE, PROMOTION, SITELINK, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED.
AdGroupFeedResourceName String ATTRIBUTE Immutable. The resource name of the ad group feed. Ad group feed resource names have the form: `customers/{customer_id}/adGroupFeeds/{ad_group_id}~{feed_id}
AdGroupFeedStatus String ATTRIBUTE Output only. Status of the ad group feed. This field is read-only. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupHourlyStatsReport

Ad Group-level performance stats by Ad Network and Device. Hourly data is returned with a default date range of the last 7 days not including today.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ActiveViewCpm Double METRIC Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr Double METRIC Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE_SEARCH, YOUTUBE_WATCH.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AdGroupBaseAdGroup String ATTRIBUTE Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
CampaignBaseCampaign String ATTRIBUTE Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only.
CampaignId Long ATTRIBUTE Output only. The ID of the campaign.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
Hour Int SEGMENT Hour of day as a number between 0 and 23, inclusive.
AdGroupId Long ATTRIBUTE Output only. The ID of the ad group.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.

AdGroupLabel

A relationship between an ad group and a label.

Columns
Name Type Behavior Description
AdGroupLabelAdGroup String ATTRIBUTE Immutable. The ad group to which the label is attached.
AdGroupLabelLabel String ATTRIBUTE Immutable. The label assigned to the ad group.
AdGroupLabelResourceName String ATTRIBUTE Immutable. The resource name of the ad group label. Ad group label resource names have the form: customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupSimulation

An ad group simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively. 1. SEARCH - CPC_BID - DEFAULT 2. SEARCH - CPC_BID - UNIFORM 3. SEARCH - TARGET_CPA - UNIFORM 4. SEARCH - TARGET_ROAS - UNIFORM 5. DISPLAY - CPC_BID - DEFAULT 6. DISPLAY - CPC_BID - UNIFORM 7. DISPLAY - TARGET_CPA - UNIFORM

Columns
Name Type Behavior Description
AdGroupSimulationAdGroupId Long ATTRIBUTE Output only. Ad group ID of the simulation.
AdGroupSimulationCpcBidPointListPoints String ATTRIBUTE Projected metrics for a series of CPC bid amounts.
AdGroupSimulationCpvBidPointListPoints String ATTRIBUTE Projected metrics for a series of CPV bid amounts.
AdGroupSimulationEndDate Date ATTRIBUTE Output only. Last day on which the simulation is based, in YYYY-MM-DD format
AdGroupSimulationModificationMethod String ATTRIBUTE Output only. How the simulation modifies the field. The allowed values are DEFAULT, SCALING, UNIFORM, UNKNOWN, UNSPECIFIED.
AdGroupSimulationResourceName String ATTRIBUTE Output only. The resource name of the ad group simulation. Ad group simulation resource names have the form: customers/{customer_id}/adGroupSimulations/{ad_group_id}~{type}~{modification_method}~{start_date}~{end_date}
AdGroupSimulationStartDate Date ATTRIBUTE Output only. First day on which the simulation is based, in YYYY-MM-DD format.
AdGroupSimulationTargetCpaPointListPoints String ATTRIBUTE Projected metrics for a series of target CPA amounts.
AdGroupSimulationTargetRoasPointListPoints String ATTRIBUTE Projected metrics for a series of target ROAS amounts.
AdGroupSimulationType String ATTRIBUTE Output only. The field that the simulation modifies. The allowed values are BID_MODIFIER, BUDGET, CPC_BID, CPV_BID, PERCENT_CPC_BID, TARGET_CPA, TARGET_IMPRESSION_SHARE, TARGET_ROAS, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdGroupStatsReport

Ad Group-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE_SEARCH, YOUTUBE_WATCH.
AdGroupBaseAdGroup String ATTRIBUTE Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
CampaignBaseCampaign String ATTRIBUTE Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only.
CampaignId Long ATTRIBUTE Output only. The ID of the campaign.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
AdGroupId Long ATTRIBUTE Output only. The ID of the ad group.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.

AdParameter

An ad parameter that is used to update numeric values (such as prices or inventory levels) in any text line of an ad (including URLs). There can be a maximum of two AdParameters per ad group criterion. (One with parameter_index = 1 and one with parameter_index = 2.) In the ad the parameters are referenced by a placeholder of the form '{param#:value}'. For example, '{param1:$17}'

Columns
Name Type Behavior Description
AdParameterAdGroupCriterion String ATTRIBUTE Immutable. The ad group criterion that this ad parameter belongs to.
AdParameterInsertionText String ATTRIBUTE Numeric value to insert into the ad text. The following restrictions apply: - Can use comma or period as a separator, with an optional period or comma (respectively) for fractional values. For example, 1, 000, 000.00 and 2.000.000, 10 are valid. - Can be prepended or appended with a currency symbol. For example, $99.99 is valid. - Can be prepended or appended with a currency code. For example, 99.99USD and EUR200 are valid. - Can use '%'. For example, 1.0% and 1, 0% are valid. - Can use plus or minus. For example, -10.99 and 25+ are valid. - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are valid.
AdParameterParameterIndex Long ATTRIBUTE Immutable. The unique index of this ad parameter. Must be either 1 or 2.
AdParameterResourceName String ATTRIBUTE Immutable. The resource name of the ad parameter. Ad parameter resource names have the form: customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdScheduleView

An ad schedule view summarizes the performance of campaigns by AdSchedule criteria.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
AdScheduleViewResourceName String ATTRIBUTE Output only. The resource name of the ad schedule view. AdSchedule view resource names have the form: customers/{customer_id}/adScheduleViews/{campaign_id}~{criterion_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoQuartileP100Rate Double METRIC Percentage of impressions where the viewer watched all of your video.
VideoQuartileP25Rate Double METRIC Percentage of impressions where the viewer watched 25% of your video.
VideoQuartileP50Rate Double METRIC Percentage of impressions where the viewer watched 50% of your video.
VideoQuartileP75Rate Double METRIC Percentage of impressions where the viewer watched 75% of your video.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AdStatsReport

Ad-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AdGroupBaseAdGroup String ATTRIBUTE Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
AdGroupId Long ATTRIBUTE Output only. The ID of the ad group.
AdGroupAdAdId Long ATTRIBUTE Output only. The ID of the ad.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE_SEARCH, YOUTUBE_WATCH.
CampaignBaseCampaign String ATTRIBUTE Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only.
CampaignId Long ATTRIBUTE Output only. The ID of the campaign.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.

AgeRangeView

An age range view.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
AgeRangeViewResourceName String ATTRIBUTE Output only. The resource name of the age range view. Age range view resource names have the form: customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
ActiveViewCpm Double METRIC Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr Double METRIC Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsFromInteractionsValuePerInteraction Double METRIC The value of all conversions from interactions divided by the total number of interactions.
AllConversionsValue Double METRIC The value of all conversions.
AllConversionsValuePerCost Double METRIC The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
GmailForwards Long METRIC The number of times the ad was forwarded to someone else as a message.
GmailSaves Long METRIC The number of times someone has saved your Gmail ad to their inbox as a message.
GmailSecondaryClicks Long METRIC The number of clicks to the landing page on the expanded state of Gmail ads.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoQuartileP100Rate Double METRIC Percentage of impressions where the viewer watched all of your video.
VideoQuartileP25Rate Double METRIC Percentage of impressions where the viewer watched 25% of your video.
VideoQuartileP50Rate Double METRIC Percentage of impressions where the viewer watched 50% of your video.
VideoQuartileP75Rate Double METRIC Percentage of impressions where the viewer watched 75% of your video.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AndroidPrivacySharedKeyGoogleAdGroup

An Android privacy shared key view for Google ad group key.

Columns
Name Type Behavior Description
AndroidPrivacySharedKeyGoogleAdGroupAdGroupId Long ATTRIBUTE Output only. The ad group ID used in the share key encoding.
AndroidPrivacySharedKeyGoogleAdGroupAndroidPrivacyInteractionDate Date ATTRIBUTE Output only. The interaction date used in the shared key encoding in the format of 'YYYY-MM-DD' in UTC timezone.
AndroidPrivacySharedKeyGoogleAdGroupAndroidPrivacyInteractionType String ATTRIBUTE Output only. The interaction type enum used in the share key encoding. The allowed values are CLICK, ENGAGED_VIEW, UNKNOWN, UNSPECIFIED, VIEW.
AndroidPrivacySharedKeyGoogleAdGroupAndroidPrivacyNetworkType String ATTRIBUTE Output only. The network type enum used in the share key encoding. The allowed values are DISPLAY, SEARCH, UNKNOWN, UNSPECIFIED, YOUTUBE.
AndroidPrivacySharedKeyGoogleAdGroupCampaignId Long ATTRIBUTE Output only. The campaign ID used in the share key encoding.
AndroidPrivacySharedKeyGoogleAdGroupResourceName String ATTRIBUTE Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: customers/{customer_id}/androidPrivacySharedKeyGoogleAdGroups/{campaign_id}~{ad_group_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}
AndroidPrivacySharedKeyGoogleAdGroupSharedAdGroupKey String ATTRIBUTE Output only. 128 bit hex string of the encoded shared ad group key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AndroidPrivacySharedKeyGoogleCampaign

An Android privacy shared key view for Google campaign key.

Columns
Name Type Behavior Description
AndroidPrivacySharedKeyGoogleCampaignAndroidPrivacyInteractionDate Date ATTRIBUTE Output only. The interaction date used in the shared key encoding in the format of 'YYYY-MM-DD' in UTC timezone.
AndroidPrivacySharedKeyGoogleCampaignAndroidPrivacyInteractionType String ATTRIBUTE Output only. The interaction type enum used in the share key encoding. The allowed values are CLICK, ENGAGED_VIEW, UNKNOWN, UNSPECIFIED, VIEW.
AndroidPrivacySharedKeyGoogleCampaignCampaignId Long ATTRIBUTE Output only. The campaign ID used in the share key encoding.
AndroidPrivacySharedKeyGoogleCampaignResourceName String ATTRIBUTE Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: customers/{customer_id}/androidPrivacySharedKeyGoogleCampaigns/{campaign_id}~{android_privacy_interaction_type}~{android_privacy_interaction_date(yyyy-mm-dd)}
AndroidPrivacySharedKeyGoogleCampaignSharedCampaignKey String ATTRIBUTE Output only. 128 bit hex string of the encoded shared campaign key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AndroidPrivacySharedKeyGoogleNetworkType

An Android privacy shared key view for Google network type key.

Columns
Name Type Behavior Description
AndroidPrivacySharedKeyGoogleNetworkTypeAndroidPrivacyInteractionDate Date ATTRIBUTE Output only. The interaction date used in the shared key encoding in the format of 'YYYY-MM-DD' in UTC timezone.
AndroidPrivacySharedKeyGoogleNetworkTypeAndroidPrivacyInteractionType String ATTRIBUTE Output only. The interaction type enum used in the share key encoding. The allowed values are CLICK, ENGAGED_VIEW, UNKNOWN, UNSPECIFIED, VIEW.
AndroidPrivacySharedKeyGoogleNetworkTypeAndroidPrivacyNetworkType String ATTRIBUTE Output only. The network type enum used in the share key encoding. The allowed values are DISPLAY, SEARCH, UNKNOWN, UNSPECIFIED, YOUTUBE.
AndroidPrivacySharedKeyGoogleNetworkTypeCampaignId Long ATTRIBUTE Output only. The campaign ID used in the share key encoding.
AndroidPrivacySharedKeyGoogleNetworkTypeResourceName String ATTRIBUTE Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: customers/{customer_id}/androidPrivacySharedKeyGoogleNetworkTypes/{campaign_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}
AndroidPrivacySharedKeyGoogleNetworkTypeSharedNetworkTypeKey String ATTRIBUTE Output only. 128 bit hex string of the encoded shared network type key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

Asset

Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YouTubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
AssetBookOnGoogleAsset String ATTRIBUTE A book on google asset.
AssetCallAssetAdScheduleTargets String ATTRIBUTE List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
AssetCallAssetCallConversionAction String ATTRIBUTE The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
AssetCallAssetCallConversionReportingState String ATTRIBUTE Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion. The allowed values are DISABLED, UNKNOWN, UNSPECIFIED, USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION, USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
AssetCallAssetCountryCode String ATTRIBUTE Required. Two-letter country code of the phone number. Examples: 'US', 'us'.
AssetCallAssetPhoneNumber String ATTRIBUTE Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'
AssetCallToActionAssetCallToAction String ATTRIBUTE Call to action. The allowed values are APPLY_NOW, BOOK_NOW, BUY_NOW, CONTACT_US, DONATE_NOW, DOWNLOAD, GET_QUOTE, LEARN_MORE, ORDER_NOW, PLAY_NOW, SEE_MORE, SHOP_NOW, SIGN_UP, START_NOW, SUBSCRIBE, UNKNOWN, UNSPECIFIED, VISIT_SITE, WATCH_NOW.
AssetCalloutAssetAdScheduleTargets String ATTRIBUTE List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
AssetCalloutAssetCalloutText String ATTRIBUTE Required. The callout text. The length of this string should be between 1 and 25, inclusive.
AssetCalloutAssetEndDate Date ATTRIBUTE Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
AssetCalloutAssetStartDate Date ATTRIBUTE Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
AssetDiscoveryCarouselCardAssetCallToActionText String ATTRIBUTE Call to action text.
AssetDiscoveryCarouselCardAssetHeadline String ATTRIBUTE Required. Headline of the carousel card.
AssetDiscoveryCarouselCardAssetMarketingImageAsset String ATTRIBUTE Asset resource name of the associated 1.91:1 marketing image. This and/or square marketing image asset is required.
AssetDiscoveryCarouselCardAssetPortraitMarketingImageAsset String ATTRIBUTE Asset resource name of the associated 4:5 portrait marketing image.
AssetDiscoveryCarouselCardAssetSquareMarketingImageAsset String ATTRIBUTE Asset resource name of the associated square marketing image. This and/or a marketing image asset is required.
AssetDynamicCustomAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicCustomAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Sedans, 4 door sedans.
AssetDynamicCustomAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $20, 000.00.
AssetDynamicCustomAssetFormattedSalePrice String ATTRIBUTE Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $15, 000.00.
AssetDynamicCustomAssetId String ATTRIBUTE Required. ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag, for example, sedan. Required.
AssetDynamicCustomAssetId2 String ATTRIBUTE ID2 which can be any sequence of letters and digits, for example, red. ID sequence (ID + ID2) must be unique.
AssetDynamicCustomAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicCustomAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicCustomAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicCustomAssetItemAddress String ATTRIBUTE Item address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
AssetDynamicCustomAssetItemCategory String ATTRIBUTE Item category, for example, Sedans.
AssetDynamicCustomAssetItemDescription String ATTRIBUTE Item description, for example, Best selling mid-size car.
AssetDynamicCustomAssetItemSubtitle String ATTRIBUTE Item subtitle, for example, At your Mountain View dealership.
AssetDynamicCustomAssetItemTitle String ATTRIBUTE Required. Item title, for example, Mid-size sedan. Required.
AssetDynamicCustomAssetPrice String ATTRIBUTE Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 20, 000.00 USD.
AssetDynamicCustomAssetSalePrice String ATTRIBUTE Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 15, 000.00 USD. Must be less than the 'price' field.
AssetDynamicCustomAssetSimilarIds String ATTRIBUTE Similar IDs.
AssetDynamicEducationAssetAddress String ATTRIBUTE School address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
AssetDynamicEducationAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicEducationAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Nursing certification, Health, Mountain View.
AssetDynamicEducationAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicEducationAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicEducationAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicEducationAssetLocationId String ATTRIBUTE Location ID which can be any sequence of letters and digits and must be unique.
AssetDynamicEducationAssetProgramDescription String ATTRIBUTE Program description, for example, Nursing Certification.
AssetDynamicEducationAssetProgramId String ATTRIBUTE Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicEducationAssetProgramName String ATTRIBUTE Required. Program name, for example, Nursing. Required.
AssetDynamicEducationAssetSchoolName String ATTRIBUTE School name, for example, Mountain View School of Nursing.
AssetDynamicEducationAssetSimilarProgramIds String ATTRIBUTE Similar program IDs.
AssetDynamicEducationAssetSubject String ATTRIBUTE Subject of study, for example, Health.
AssetDynamicEducationAssetThumbnailImageUrl String ATTRIBUTE Thumbnail image URL, for example, http://www.example.com/thumbnail.png. The thumbnail image will not be uploaded as image asset.
AssetDynamicFlightsAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicFlightsAssetCustomMapping String ATTRIBUTE A custom field which can be multiple key to values mapping separated by delimiters (', ', '|' and ':'), in the forms of ': , , ... , | : , ... , | ... | : , ... , ' for example, wifi: most | aircraft: 320, 77W | flights: 42 | legroom: 32'.
AssetDynamicFlightsAssetDestinationId String ATTRIBUTE Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicFlightsAssetDestinationName String ATTRIBUTE Destination name, for example, Paris.
AssetDynamicFlightsAssetFlightDescription String ATTRIBUTE Required. Flight description, for example, Book your ticket. Required.
AssetDynamicFlightsAssetFlightPrice String ATTRIBUTE Flight price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
AssetDynamicFlightsAssetFlightSalePrice String ATTRIBUTE Flight sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'flight_price' field.
AssetDynamicFlightsAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
AssetDynamicFlightsAssetFormattedSalePrice String ATTRIBUTE Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
AssetDynamicFlightsAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicFlightsAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicFlightsAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicFlightsAssetOriginId String ATTRIBUTE Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.
AssetDynamicFlightsAssetOriginName String ATTRIBUTE Origin name, for example, London.
AssetDynamicFlightsAssetSimilarDestinationIds String ATTRIBUTE Similar destination IDs, for example, PAR, LON.
AssetDynamicHotelsAndRentalsAssetAddress String ATTRIBUTE Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
AssetDynamicHotelsAndRentalsAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicHotelsAndRentalsAssetCategory String ATTRIBUTE Category, for example, Hotel suite.
AssetDynamicHotelsAndRentalsAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Mountain View 'Hotels', South Bay hotels.
AssetDynamicHotelsAndRentalsAssetDescription String ATTRIBUTE Description, for example, Close to SJC Airport.
AssetDynamicHotelsAndRentalsAssetDestinationName String ATTRIBUTE Destination name, for example, Downtown Mountain View.
AssetDynamicHotelsAndRentalsAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
AssetDynamicHotelsAndRentalsAssetFormattedSalePrice String ATTRIBUTE Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
AssetDynamicHotelsAndRentalsAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicHotelsAndRentalsAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicHotelsAndRentalsAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicHotelsAndRentalsAssetPrice String ATTRIBUTE Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
AssetDynamicHotelsAndRentalsAssetPropertyId String ATTRIBUTE Required. Property ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicHotelsAndRentalsAssetPropertyName String ATTRIBUTE Required. Property name, for example, Mountain View Hotel. Required.
AssetDynamicHotelsAndRentalsAssetSalePrice String ATTRIBUTE ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
AssetDynamicHotelsAndRentalsAssetSimilarPropertyIds String ATTRIBUTE Similar property IDs.
AssetDynamicHotelsAndRentalsAssetStarRating Long ATTRIBUTE Star rating. Must be a number between 1 to 5, inclusive.
AssetDynamicJobsAssetAddress String ATTRIBUTE Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
AssetDynamicJobsAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicJobsAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Software engineering job.
AssetDynamicJobsAssetDescription String ATTRIBUTE Description, for example, Apply your technical skills.
AssetDynamicJobsAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicJobsAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicJobsAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicJobsAssetJobCategory String ATTRIBUTE Job category, for example, Technical.
AssetDynamicJobsAssetJobId String ATTRIBUTE Required. Job ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicJobsAssetJobSubtitle String ATTRIBUTE Job subtitle, for example, Level II.
AssetDynamicJobsAssetJobTitle String ATTRIBUTE Required. Job title, for example, Software engineer. Required.
AssetDynamicJobsAssetLocationId String ATTRIBUTE Location ID which can be any sequence of letters and digits. The ID sequence (job ID + location ID) must be unique.
AssetDynamicJobsAssetSalary String ATTRIBUTE Salary, for example, $100, 000.
AssetDynamicJobsAssetSimilarJobIds String ATTRIBUTE Similar job IDs, for example, 1275.
AssetDynamicLocalAssetAddress String ATTRIBUTE Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
AssetDynamicLocalAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicLocalAssetCategory String ATTRIBUTE Category, for example, Food.
AssetDynamicLocalAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Save groceries coupons.
AssetDynamicLocalAssetDealId String ATTRIBUTE Required. Deal ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicLocalAssetDealName String ATTRIBUTE Required. Deal name, for example, 50% off at Mountain View Grocers. Required.
AssetDynamicLocalAssetDescription String ATTRIBUTE Description, for example, Save on your weekly bill.
AssetDynamicLocalAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
AssetDynamicLocalAssetFormattedSalePrice String ATTRIBUTE Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
AssetDynamicLocalAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicLocalAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicLocalAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicLocalAssetPrice String ATTRIBUTE Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
AssetDynamicLocalAssetSalePrice String ATTRIBUTE Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
AssetDynamicLocalAssetSimilarDealIds String ATTRIBUTE Similar deal IDs, for example, 1275.
AssetDynamicLocalAssetSubtitle String ATTRIBUTE Subtitle, for example, Groceries.
AssetDynamicRealEstateAssetAddress String ATTRIBUTE Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
AssetDynamicRealEstateAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicRealEstateAssetCityName String ATTRIBUTE City name, for example, Mountain View, California.
AssetDynamicRealEstateAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, For sale; Houses for sale.
AssetDynamicRealEstateAssetDescription String ATTRIBUTE Description, for example, 3 beds, 2 baths, 1568 sq. ft.
AssetDynamicRealEstateAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $200, 000.00.
AssetDynamicRealEstateAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicRealEstateAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicRealEstateAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicRealEstateAssetListingId String ATTRIBUTE Required. Listing ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicRealEstateAssetListingName String ATTRIBUTE Required. Listing name, for example, Boulevard Bungalow. Required.
AssetDynamicRealEstateAssetListingType String ATTRIBUTE Listing type, for example, For sale.
AssetDynamicRealEstateAssetPrice String ATTRIBUTE Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 200, 000.00 USD.
AssetDynamicRealEstateAssetPropertyType String ATTRIBUTE Property type, for example, House.
AssetDynamicRealEstateAssetSimilarListingIds String ATTRIBUTE Similar listing IDs.
AssetDynamicTravelAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicTravelAssetCategory String ATTRIBUTE Category, for example, Express.
AssetDynamicTravelAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Paris trains.
AssetDynamicTravelAssetDestinationAddress String ATTRIBUTE Destination address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
AssetDynamicTravelAssetDestinationId String ATTRIBUTE Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicTravelAssetDestinationName String ATTRIBUTE Destination name, for example, Paris.
AssetDynamicTravelAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
AssetDynamicTravelAssetFormattedSalePrice String ATTRIBUTE Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
AssetDynamicTravelAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicTravelAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicTravelAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicTravelAssetOriginId String ATTRIBUTE Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.
AssetDynamicTravelAssetOriginName String ATTRIBUTE Origin name, for example, London.
AssetDynamicTravelAssetPrice String ATTRIBUTE Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
AssetDynamicTravelAssetSalePrice String ATTRIBUTE Sale price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
AssetDynamicTravelAssetSimilarDestinationIds String ATTRIBUTE Similar destination IDs, for example, NYC.
AssetDynamicTravelAssetTitle String ATTRIBUTE Required. Title, for example, Book your train ticket. Required.
AssetFieldTypePolicySummaries String ATTRIBUTE Output only. Policy information for the asset for each FieldType.
AssetFinalMobileUrls String ATTRIBUTE A list of possible final mobile URLs after all cross domain redirects.
AssetFinalUrlSuffix String ATTRIBUTE URL template for appending params to landing page URLs served with parallel tracking.
AssetFinalUrls String ATTRIBUTE A list of possible final URLs after all cross domain redirects.
AssetHotelCalloutAssetLanguageCode String ATTRIBUTE Required. The language of the hotel callout. Represented as BCP 47 language tag.
AssetHotelCalloutAssetText String ATTRIBUTE Required. The text of the hotel callout asset. The length of this string should be between 1 and 25, inclusive.
AssetHotelPropertyAssetHotelAddress String ATTRIBUTE Address of the hotel. Read-only.
AssetHotelPropertyAssetHotelName String ATTRIBUTE Name of the hotel. Read-only.
AssetHotelPropertyAssetPlaceId String ATTRIBUTE Place IDs uniquely identify a place in the Google Places database and on Google Maps. See https://developers.google.com/places/web-service/place-id to learn more.
AssetId Long ATTRIBUTE Output only. The ID of the asset.
AssetImageAssetFileSize Long ATTRIBUTE File size of the image asset in bytes.
AssetImageAssetFullSizeHeightPixels Long ATTRIBUTE Height of the image.
AssetImageAssetFullSizeUrl String ATTRIBUTE A URL that returns the image with this height and width.
AssetImageAssetFullSizeWidthPixels Long ATTRIBUTE Width of the image.
AssetImageAssetMimeType String ATTRIBUTE MIME type of the image asset. The allowed values are AUDIO_MP3, AUDIO_WAV, FLASH, HTML5_AD_ZIP, IMAGE_GIF, IMAGE_JPEG, IMAGE_PNG, MSEXCEL, MSWORD, PDF, RTF, TEXT_HTML, UNKNOWN, UNSPECIFIED.
AssetLeadFormAssetBackgroundImageAsset String ATTRIBUTE Asset resource name of the background image. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%).
AssetLeadFormAssetBusinessName String ATTRIBUTE Required. The name of the business being advertised.
AssetLeadFormAssetCallToActionDescription String ATTRIBUTE Required. Text giving a clear value proposition of what users expect once they expand the form.
AssetLeadFormAssetCallToActionType String ATTRIBUTE Required. Pre-defined display text that encourages user to expand the form. The allowed values are APPLY_NOW, BOOK_NOW, CONTACT_US, DOWNLOAD, GET_INFO, GET_OFFER, GET_QUOTE, GET_STARTED, JOIN_NOW, LEARN_MORE, REGISTER, REQUEST_DEMO, SIGN_UP, SUBSCRIBE, UNKNOWN, UNSPECIFIED.
AssetLeadFormAssetCustomDisclosure String ATTRIBUTE Custom disclosure shown along with Google disclaimer on the lead form. Accessible to allowed customers only.
AssetLeadFormAssetCustomQuestionFields String ATTRIBUTE Ordered list of custom question fields. This field is subject to a limit of 5 qualifying questions per form.
AssetLeadFormAssetDeliveryMethods String ATTRIBUTE Configured methods for collected lead data to be delivered to advertiser. Only one method typed as WebhookDelivery can be configured.
AssetLeadFormAssetDescription String ATTRIBUTE Required. Detailed description of the expanded form to describe what the form is asking for or facilitating.
AssetLeadFormAssetDesiredIntent String ATTRIBUTE Chosen intent for the lead form, for example, more volume or more qualified. The allowed values are HIGH_INTENT, LOW_INTENT, UNKNOWN, UNSPECIFIED.
AssetLeadFormAssetFields String ATTRIBUTE Ordered list of input fields. This field can be updated by reordering questions, but not by adding or removing questions.
AssetLeadFormAssetHeadline String ATTRIBUTE Required. Headline of the expanded form to describe what the form is asking for or facilitating.
AssetLeadFormAssetPostSubmitCallToActionType String ATTRIBUTE Pre-defined display text that encourages user action after the form is submitted. The allowed values are DOWNLOAD, LEARN_MORE, SHOP_NOW, UNKNOWN, UNSPECIFIED, VISIT_SITE.
AssetLeadFormAssetPostSubmitDescription String ATTRIBUTE Detailed description shown after form submission that describes how the advertiser will follow up with the user.
AssetLeadFormAssetPostSubmitHeadline String ATTRIBUTE Headline of text shown after form submission that describes how the advertiser will follow up with the user.
AssetLeadFormAssetPrivacyPolicyUrl String ATTRIBUTE Required. Link to a page describing the policy on how the collected data is handled by the advertiser/business.
AssetLocationAssetBusinessProfileLocations String ATTRIBUTE The list of business locations for the customer. This will only be returned if the Location Asset is syncing from the Business Profile account. It is possible to have multiple Business Profile listings under the same account that point to the same Place ID.
AssetLocationAssetLocationOwnershipType String ATTRIBUTE The type of location ownership. If the type is BUSINESS_OWNER, it will be served as a location extension. If the type is AFFILIATE, it will be served as an affiliate location. The allowed values are AFFILIATE, BUSINESS_OWNER, UNKNOWN, UNSPECIFIED.
AssetLocationAssetPlaceId String ATTRIBUTE Place IDs uniquely identify a place in the Google Places database and on Google Maps. This field is unique for a given customer ID and asset type. See https://developers.google.com/places/web-service/place-id to learn more about Place ID.
AssetMobileAppAssetAppId String ATTRIBUTE Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like 'com.android.ebay' for Android or '12345689' for iOS.
AssetMobileAppAssetAppStore String ATTRIBUTE Required. The application store that distributes this specific app. The allowed values are APPLE_APP_STORE, GOOGLE_APP_STORE, UNKNOWN, UNSPECIFIED.
AssetMobileAppAssetEndDate Date ATTRIBUTE Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
AssetMobileAppAssetLinkText String ATTRIBUTE Required. The visible text displayed when the link is rendered in an ad. The length of this string should be between 1 and 25, inclusive.
AssetMobileAppAssetStartDate Date ATTRIBUTE Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
AssetName String ATTRIBUTE Optional name of the asset.
AssetPageFeedAssetLabels String ATTRIBUTE Labels used to group the page URLs.
AssetPageFeedAssetPageUrl String ATTRIBUTE Required. The webpage that advertisers want to target.
AssetPolicySummaryApprovalStatus String ATTRIBUTE Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries. The allowed values are APPROVED, APPROVED_LIMITED, AREA_OF_INTEREST_ONLY, DISAPPROVED, UNKNOWN, UNSPECIFIED.
AssetPolicySummaryPolicyTopicEntries String ATTRIBUTE Output only. The list of policy findings for this asset.
AssetPolicySummaryReviewStatus String ATTRIBUTE Output only. Where in the review process this asset is. The allowed values are ELIGIBLE_MAY_SERVE, REVIEWED, REVIEW_IN_PROGRESS, UNDER_APPEAL, UNKNOWN, UNSPECIFIED.
AssetPriceAssetLanguageCode String ATTRIBUTE Required. The language of the price asset. Represented as BCP 47 language tag.
AssetPriceAssetPriceOfferings String ATTRIBUTE The price offerings of the price asset. The size of this collection should be between 3 and 8, inclusive.
AssetPriceAssetPriceQualifier String ATTRIBUTE The price qualifier of the price asset. The allowed values are AVERAGE, FROM, UNKNOWN, UNSPECIFIED, UP_TO.
AssetPriceAssetType String ATTRIBUTE Required. The type of the price asset. The allowed values are BRANDS, EVENTS, LOCATIONS, NEIGHBORHOODS, PRODUCT_CATEGORIES, PRODUCT_TIERS, SERVICES, SERVICE_CATEGORIES, SERVICE_TIERS, UNKNOWN, UNSPECIFIED.
AssetPromotionAssetAdScheduleTargets String ATTRIBUTE List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
AssetPromotionAssetDiscountModifier String ATTRIBUTE A modifier for qualification of the discount. The allowed values are UNKNOWN, UNSPECIFIED, UP_TO.
AssetPromotionAssetEndDate Date ATTRIBUTE Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
AssetPromotionAssetLanguageCode String ATTRIBUTE The language of the promotion. Represented as BCP 47 language tag.
AssetPromotionAssetMoneyAmountOffAmountMicros Long ATTRIBUTE Amount in micros. One million is equivalent to one unit.
AssetPromotionAssetMoneyAmountOffCurrencyCode String ATTRIBUTE Three-character ISO 4217 currency code.
AssetPromotionAssetOccasion String ATTRIBUTE The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion. The allowed values are BACK_TO_SCHOOL, BLACK_FRIDAY, BOXING_DAY, CARNIVAL, CHINESE_NEW_YEAR, CHRISTMAS, CYBER_MONDAY, DIWALI, EASTER, EID_AL_ADHA, EID_AL_FITR, END_OF_SEASON, EPIPHANY, FALL_SALE, FATHERS_DAY, HALLOWEEN, HANUKKAH, HOLI, INDEPENDENCE_DAY, LABOR_DAY, MOTHERS_DAY, NATIONAL_DAY, NAVRATRI, NEW_YEARS, PARENTS_DAY, PASSOVER, RAMADAN, ROSH_HASHANAH, SINGLES_DAY, SONGKRAN, SPRING_SALE, ST_NICHOLAS_DAY, SUMMER_SALE, UNKNOWN, UNSPECIFIED, VALENTINES_DAY, WINTER_SALE, WOMENS_DAY, YEAR_END_GIFT.
AssetPromotionAssetOrdersOverAmountAmountMicros Long ATTRIBUTE Amount in micros. One million is equivalent to one unit.
AssetPromotionAssetOrdersOverAmountCurrencyCode String ATTRIBUTE Three-character ISO 4217 currency code.
AssetPromotionAssetPercentOff Long ATTRIBUTE Percentage off discount in the promotion. 1, 000, 000 = 100%. Either this or money_amount_off is required.
AssetPromotionAssetPromotionCode String ATTRIBUTE A code the user should use in order to be eligible for the promotion.
AssetPromotionAssetPromotionTarget String ATTRIBUTE Required. A freeform description of what the promotion is targeting.
AssetPromotionAssetRedemptionEndDate Date ATTRIBUTE Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.
AssetPromotionAssetRedemptionStartDate Date ATTRIBUTE Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.
AssetPromotionAssetStartDate Date ATTRIBUTE Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
AssetResourceName String ATTRIBUTE Immutable. The resource name of the asset. Asset resource names have the form: customers/{customer_id}/assets/{asset_id}
AssetSitelinkAssetAdScheduleTargets String ATTRIBUTE List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
AssetSitelinkAssetDescription1 String ATTRIBUTE First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set.
AssetSitelinkAssetDescription2 String ATTRIBUTE Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set.
AssetSitelinkAssetEndDate Date ATTRIBUTE Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
AssetSitelinkAssetLinkText String ATTRIBUTE Required. URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
AssetSitelinkAssetStartDate Date ATTRIBUTE Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
AssetSource String ATTRIBUTE Output only. Source of the asset. The allowed values are ADVERTISER, AUTOMATICALLY_CREATED, UNKNOWN, UNSPECIFIED.
AssetStructuredSnippetAssetHeader String ATTRIBUTE Required. The header of the snippet. This string should be one of the predefined values at https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers
AssetStructuredSnippetAssetValues String ATTRIBUTE Required. The values in the snippet. The size of this collection should be between 3 and 10, inclusive. The length of each value should be between 1 and 25 characters, inclusive.
AssetTextAssetText String ATTRIBUTE Text content of the text asset.
AssetTrackingUrlTemplate String ATTRIBUTE URL template for constructing a tracking URL.
AssetType String ATTRIBUTE Output only. Type of the asset. The allowed values are BOOK_ON_GOOGLE, CALL, CALLOUT, CALL_TO_ACTION, DISCOVERY_CAROUSEL_CARD, DYNAMIC_CUSTOM, DYNAMIC_EDUCATION, DYNAMIC_FLIGHTS, DYNAMIC_HOTELS_AND_RENTALS, DYNAMIC_JOBS, DYNAMIC_LOCAL, DYNAMIC_REAL_ESTATE, DYNAMIC_TRAVEL, HOTEL_CALLOUT, HOTEL_PROPERTY, IMAGE, LEAD_FORM, LOCATION, MEDIA_BUNDLE, MOBILE_APP, PAGE_FEED, PRICE, PROMOTION, SITELINK, STRUCTURED_SNIPPET, TEXT, UNKNOWN, UNSPECIFIED, YOUTUBE_VIDEO.
AssetUrlCustomParameters String ATTRIBUTE A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls.
AssetYoutubeVideoAssetYoutubeVideoId String ATTRIBUTE YouTube video id. This is the 11 character string value used in the YouTube video URL.
AssetYoutubeVideoAssetYoutubeVideoTitle String ATTRIBUTE YouTube video title.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
ConversionAdjustment Bool SEGMENT This segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.
ConversionLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion. The allowed values are EIGHT_TO_NINE_DAYS, ELEVEN_TO_TWELVE_DAYS, FIVE_TO_SIX_DAYS, FORTY_FIVE_TO_SIXTY_DAYS, FOURTEEN_TO_TWENTY_ONE_DAYS, FOUR_TO_FIVE_DAYS, LESS_THAN_ONE_DAY, NINE_TO_TEN_DAYS, ONE_TO_TWO_DAYS, SEVEN_TO_EIGHT_DAYS, SIXTY_TO_NINETY_DAYS, SIX_TO_SEVEN_DAYS, TEN_TO_ELEVEN_DAYS, THIRTEEN_TO_FOURTEEN_DAYS, THIRTY_TO_FORTY_FIVE_DAYS, THREE_TO_FOUR_DAYS, TWELVE_TO_THIRTEEN_DAYS, TWENTY_ONE_TO_THIRTY_DAYS, TWO_TO_THREE_DAYS, UNKNOWN, UNSPECIFIED.
ConversionOrAdjustmentLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion. The allowed values are ADJUSTMENT_EIGHT_TO_NINE_DAYS, ADJUSTMENT_ELEVEN_TO_TWELVE_DAYS, ADJUSTMENT_FIVE_TO_SIX_DAYS, ADJUSTMENT_FORTY_FIVE_TO_SIXTY_DAYS, ADJUSTMENT_FOURTEEN_TO_TWENTY_ONE_DAYS, ADJUSTMENT_FOUR_TO_FIVE_DAYS, ADJUSTMENT_LESS_THAN_ONE_DAY, ADJUSTMENT_NINETY_TO_ONE_HUNDRED_AND_FORTY_FIVE_DAYS, ADJUSTMENT_NINE_TO_TEN_DAYS, ADJUSTMENT_ONE_TO_TWO_DAYS, ADJUSTMENT_SEVEN_TO_EIGHT_DAYS, ADJUSTMENT_SIXTY_TO_NINETY_DAYS, ADJUSTMENT_SIX_TO_SEVEN_DAYS, ADJUSTMENT_TEN_TO_ELEVEN_DAYS, ADJUSTMENT_THIRTEEN_TO_FOURTEEN_DAYS, ADJUSTMENT_THIRTY_TO_FORTY_FIVE_DAYS, ADJUSTMENT_THREE_TO_FOUR_DAYS, ADJUSTMENT_TWELVE_TO_THIRTEEN_DAYS, ADJUSTMENT_TWENTY_ONE_TO_THIRTY_DAYS, ADJUSTMENT_TWO_TO_THREE_DAYS, ADJUSTMENT_UNKNOWN, CONVERSION_EIGHT_TO_NINE_DAYS, CONVERSION_ELEVEN_TO_TWELVE_DAYS, CONVERSION_FIVE_TO_SIX_DAYS, CONVERSION_FORTY_FIVE_TO_SIXTY_DAYS, CONVERSION_FOURTEEN_TO_TWENTY_ONE_DAYS, CONVERSION_FOUR_TO_FIVE_DAYS, CONVERSION_LESS_THAN_ONE_DAY, CONVERSION_NINE_TO_TEN_DAYS, CONVERSION_ONE_TO_TWO_DAYS, CONVERSION_SEVEN_TO_EIGHT_DAYS, CONVERSION_SIXTY_TO_NINETY_DAYS, CONVERSION_SIX_TO_SEVEN_DAYS, CONVERSION_TEN_TO_ELEVEN_DAYS, CONVERSION_THIRTEEN_TO_FOURTEEN_DAYS, CONVERSION_THIRTY_TO_FORTY_FIVE_DAYS, CONVERSION_THREE_TO_FOUR_DAYS, CONVERSION_TWELVE_TO_THIRTEEN_DAYS, CONVERSION_TWENTY_ONE_TO_THIRTY_DAYS, CONVERSION_TWO_TO_THREE_DAYS, CONVERSION_UNKNOWN, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AssetFieldTypeView

An asset field type view. This view reports non-overcounted metrics for each asset field type when the asset is used as extension.

Columns
Name Type Behavior Description
AssetFieldTypeViewFieldType String ATTRIBUTE Output only. The asset field type of the asset field type view. The allowed values are AD_IMAGE, BOOK_ON_GOOGLE, BUSINESS_LOGO, BUSINESS_NAME, CALL, CALLOUT, CALL_TO_ACTION_SELECTION, DESCRIPTION, HEADLINE, HOTEL_CALLOUT, HOTEL_PROPERTY, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MANDATORY_AD_TEXT, MARKETING_IMAGE, MEDIA_BUNDLE, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, VIDEO, YOUTUBE_VIDEO.
AssetFieldTypeViewResourceName String ATTRIBUTE Output only. The resource name of the asset field type view. Asset field type view resource names have the form: customers/{customer_id}/assetFieldTypeViews/{field_type}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
PhoneCalls Long METRIC Number of offline phone calls.
PhoneImpressions Long METRIC Number of offline phone impressions.
PhoneThroughRate Double METRIC Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AssetGroup

An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group.

Columns
Name Type Behavior Description
AssetGroupAdStrength String ATTRIBUTE Output only. Overall ad strength of this asset group. The allowed values are AVERAGE, EXCELLENT, GOOD, NO_ADS, PENDING, POOR, UNKNOWN, UNSPECIFIED.
AssetGroupCampaign String ATTRIBUTE Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.
AssetGroupFinalMobileUrls String ATTRIBUTE A list of final mobile URLs after all cross domain redirects. In performance max, by default, the URLs are eligible for expansion unless opted out.
AssetGroupFinalUrls String ATTRIBUTE A list of final URLs after all cross domain redirects. In performance max, by default, the URLs are eligible for expansion unless opted out.
AssetGroupId Long ATTRIBUTE Output only. The ID of the asset group.
AssetGroupName String ATTRIBUTE Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.
AssetGroupPath1 String ATTRIBUTE First part of text that may appear appended to the URL displayed in the ad.
AssetGroupPath2 String ATTRIBUTE Second part of text that may appear appended to the URL displayed in the ad. This field can only be set when path1 is set.
AssetGroupPrimaryStatus String ATTRIBUTE Output only. The primary status of the asset group. Provides insights into why an asset group is not serving or not serving optimally. The allowed values are ELIGIBLE, LIMITED, NOT_ELIGIBLE, PAUSED, PENDING, REMOVED, UNKNOWN, UNSPECIFIED.
AssetGroupPrimaryStatusReasons String ATTRIBUTE Output only. Provides reasons into why an asset group is not serving or not serving optimally. It will be empty when the asset group is serving without issues. The allowed values are ASSET_GROUP_DISAPPROVED, ASSET_GROUP_LIMITED, ASSET_GROUP_PAUSED, ASSET_GROUP_REMOVED, ASSET_GROUP_UNDER_REVIEW, CAMPAIGN_ENDED, CAMPAIGN_PAUSED, CAMPAIGN_PENDING, CAMPAIGN_REMOVED, UNKNOWN, UNSPECIFIED.
AssetGroupResourceName String ATTRIBUTE Immutable. The resource name of the asset group. Asset group resource names have the form: customers/{customer_id}/assetGroups/{asset_group_id}
AssetGroupStatus String ATTRIBUTE The status of the asset group. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsFromInteractionsValuePerInteraction Double METRIC The value of all conversions from interactions divided by the total number of interactions.
AllConversionsValue Double METRIC The value of all conversions.
AllConversionsValuePerCost Double METRIC The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
AverageCartSize Double METRIC Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageOrderValueMicros Long METRIC Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is \(15 = (\)10 + $15 + $20)/3. This metric is only available if you report conversions with cart data.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsValuePerInteraction Double METRIC The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValuePerCost Double METRIC The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostOfGoodsSoldMicros Long METRIC Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
CrossDeviceConversionsValueMicros Long METRIC The sum of the value of cross-device conversions, in micros.
CrossSellCostOfGoodsSoldMicros Long METRIC Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data.
CrossSellGrossProfitMicros Long METRIC Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data.
CrossSellRevenueMicros Long METRIC Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data.
CrossSellUnitsSold Double METRIC Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
GrossProfitMargin Double METRIC Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced \(20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = (\)10 - \(3)/\)10 x 100%. This metric is only available if you report conversions with cart data.
GrossProfitMicros Long METRIC Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
LeadCostOfGoodsSoldMicros Long METRIC Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data.
LeadGrossProfitMicros Long METRIC Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data.
LeadRevenueMicros Long METRIC Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data.
LeadUnitsSold Double METRIC Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
Orders Double METRIC Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data.
RevenueMicros Long METRIC Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is \(25 = (\)10 + $20) - $5. This metric is only available if you report conversions with cart data.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AssetGroupAsset

AssetGroupAsset is the link between an asset and an asset group. Adding an AssetGroupAsset links an asset with an asset group.

Columns
Name Type Behavior Description
AssetGroupAssetAsset String ATTRIBUTE Immutable. The asset which this asset group asset is linking.
AssetGroupAssetAssetGroup String ATTRIBUTE Immutable. The asset group which this asset group asset is linking.
AssetGroupAssetFieldType String ATTRIBUTE The description of the placement of the asset within the asset group. For example: HEADLINE, YOUTUBE_VIDEO etc The allowed values are AD_IMAGE, BOOK_ON_GOOGLE, BUSINESS_LOGO, BUSINESS_NAME, CALL, CALLOUT, CALL_TO_ACTION_SELECTION, DESCRIPTION, HEADLINE, HOTEL_CALLOUT, HOTEL_PROPERTY, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MANDATORY_AD_TEXT, MARKETING_IMAGE, MEDIA_BUNDLE, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, VIDEO, YOUTUBE_VIDEO.
AssetGroupAssetPerformanceLabel String ATTRIBUTE Output only. The performance of this asset group asset. The allowed values are BEST, GOOD, LEARNING, LOW, PENDING, UNKNOWN, UNSPECIFIED.
AssetGroupAssetPolicySummaryApprovalStatus String ATTRIBUTE The overall approval status, which is calculated based on the status of its individual policy topic entries. The allowed values are APPROVED, APPROVED_LIMITED, AREA_OF_INTEREST_ONLY, DISAPPROVED, UNKNOWN, UNSPECIFIED.
AssetGroupAssetPolicySummaryPolicyTopicEntries String ATTRIBUTE The list of policy findings.
AssetGroupAssetPolicySummaryReviewStatus String ATTRIBUTE Where in the review process the resource is. The allowed values are ELIGIBLE_MAY_SERVE, REVIEWED, REVIEW_IN_PROGRESS, UNDER_APPEAL, UNKNOWN, UNSPECIFIED.
AssetGroupAssetPrimaryStatus String ATTRIBUTE Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain 'status' field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state. The allowed values are ELIGIBLE, LIMITED, NOT_ELIGIBLE, PAUSED, PENDING, REMOVED, UNKNOWN, UNSPECIFIED.
AssetGroupAssetPrimaryStatusDetails String ATTRIBUTE Output only. Provides the details of the primary status and its associated reasons.
AssetGroupAssetPrimaryStatusReasons String ATTRIBUTE Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity. The allowed values are ASSET_APPROVED_LABELED, ASSET_DISAPPROVED, ASSET_LINK_PAUSED, ASSET_LINK_REMOVED, ASSET_UNDER_REVIEW, UNKNOWN, UNSPECIFIED.
AssetGroupAssetResourceName String ATTRIBUTE Immutable. The resource name of the asset group asset. Asset group asset resource name have the form: customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}
AssetGroupAssetSource String ATTRIBUTE Output only. Source of the asset group asset. The allowed values are ADVERTISER, AUTOMATICALLY_CREATED, UNKNOWN, UNSPECIFIED.
AssetGroupAssetStatus String ATTRIBUTE The status of the link between an asset and asset group. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AssetGroupListingGroupFilter

AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group.

Columns
Name Type Behavior Description
AssetGroupListingGroupFilterAssetGroup String ATTRIBUTE Immutable. The asset group which this asset group listing group filter is part of.
AssetGroupListingGroupFilterCaseValueProductBrandValue String ATTRIBUTE String value of the product brand.
AssetGroupListingGroupFilterCaseValueProductCategoryCategoryId Long ATTRIBUTE ID of the product category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
AssetGroupListingGroupFilterCaseValueProductCategoryLevel String ATTRIBUTE Indicates the level of the category in the taxonomy. The allowed values are LEVEL1, LEVEL2, LEVEL3, LEVEL4, LEVEL5, UNKNOWN, UNSPECIFIED.
AssetGroupListingGroupFilterCaseValueProductChannelChannel String ATTRIBUTE Value of the locality. The allowed values are LOCAL, ONLINE, UNKNOWN, UNSPECIFIED.
AssetGroupListingGroupFilterCaseValueProductConditionCondition String ATTRIBUTE Value of the condition. The allowed values are NEW, REFURBISHED, UNKNOWN, UNSPECIFIED, USED.
AssetGroupListingGroupFilterCaseValueProductCustomAttributeIndex String ATTRIBUTE Indicates the index of the custom attribute. The allowed values are INDEX0, INDEX1, INDEX2, INDEX3, INDEX4, UNKNOWN, UNSPECIFIED.
AssetGroupListingGroupFilterCaseValueProductCustomAttributeValue String ATTRIBUTE String value of the product custom attribute.
AssetGroupListingGroupFilterCaseValueProductItemIdValue String ATTRIBUTE Value of the id.
AssetGroupListingGroupFilterCaseValueProductTypeLevel String ATTRIBUTE Level of the type. The allowed values are LEVEL1, LEVEL2, LEVEL3, LEVEL4, LEVEL5, UNKNOWN, UNSPECIFIED.
AssetGroupListingGroupFilterCaseValueProductTypeValue String ATTRIBUTE Value of the type.
AssetGroupListingGroupFilterCaseValueWebpageConditions String ATTRIBUTE The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering. All the conditions should be of same type.
AssetGroupListingGroupFilterId Long ATTRIBUTE Output only. The ID of the ListingGroupFilter.
AssetGroupListingGroupFilterListingSource String ATTRIBUTE Immutable. The source of listings filtered by this listing group filter. The allowed values are SHOPPING, UNKNOWN, UNSPECIFIED, WEBPAGE.
AssetGroupListingGroupFilterParentListingGroupFilter String ATTRIBUTE Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.
AssetGroupListingGroupFilterPath String ATTRIBUTE Output only. The path of dimensions defining this listing group filter.
AssetGroupListingGroupFilterResourceName String ATTRIBUTE Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}
AssetGroupListingGroupFilterType String ATTRIBUTE Immutable. Type of a listing group filter node. The allowed values are SUBDIVISION, UNIT_EXCLUDED, UNIT_INCLUDED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AssetGroupSignal

AssetGroupSignal represents a signal in an asset group. The existence of a signal tells the performance max campaign who's most likely to convert. Performance Max uses the signal to look for new people with similar or stronger intent to find conversions across Search, Display, Video, and more.

Columns
Name Type Behavior Description
AssetGroupSignalApprovalStatus String ATTRIBUTE Output only. Approval status is the output value for search theme signal after Google ads policy review. When using Audience signal, this field is not used and will be absent. The allowed values are APPROVED, DISAPPROVED, LIMITED, UNDER_REVIEW, UNKNOWN, UNSPECIFIED.
AssetGroupSignalAssetGroup String ATTRIBUTE Immutable. The asset group which this asset group signal belongs to.
AssetGroupSignalAudienceAudience String ATTRIBUTE The Audience resource name.
AssetGroupSignalDisapprovalReasons String ATTRIBUTE Output only. Computed for SearchTheme signals. When using Audience signal, this field is not used and will be absent.
AssetGroupSignalResourceName String ATTRIBUTE Immutable. The resource name of the asset group signal. Asset group signal resource name have the form: customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}
AssetGroupSignalSearchThemeText String ATTRIBUTE Each Search Theme has a value of a simple string, like keywords. There are limits on overall length, allowed characters, and number of words.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AssetGroupTopCombinationView

A view on the usage of ad group ad asset combination.

Columns
Name Type Behavior Description
AssetGroupTopCombinationViewAssetGroupTopCombinations String ATTRIBUTE Output only. The top combinations of assets that served together.
AssetGroupTopCombinationViewResourceName String ATTRIBUTE Output only. The resource name of the asset group top combination view. AssetGroup Top Combination view resource names have the form: `'customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}'
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AssetSet

An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set.

Columns
Name Type Behavior Description
AssetSetBusinessProfileLocationGroupDynamicBusinessProfileLocationGroupFilterBusinessNameFilterBusinessName String ATTRIBUTE Business name string to use for filtering.
AssetSetBusinessProfileLocationGroupDynamicBusinessProfileLocationGroupFilterBusinessNameFilterFilterType String ATTRIBUTE The type of string matching to use when filtering with business_name. The allowed values are EXACT, UNKNOWN, UNSPECIFIED.
AssetSetBusinessProfileLocationGroupDynamicBusinessProfileLocationGroupFilterLabelFilters String ATTRIBUTE Used to filter Business Profile locations by label. Only locations that have any of the listed labels will be in the asset set. Label filters are OR'ed together.
AssetSetBusinessProfileLocationGroupDynamicBusinessProfileLocationGroupFilterListingIdFilters String ATTRIBUTE Used to filter Business Profile locations by listing ids.
AssetSetHotelPropertyDataHotelCenterId Long ATTRIBUTE Output only. The hotel center ID of the partner.
AssetSetHotelPropertyDataPartnerName String ATTRIBUTE Output only. Name of the hotel partner.
AssetSetId Long ATTRIBUTE Output only. The ID of the asset set.
AssetSetLocationGroupParentAssetSetId Long ATTRIBUTE Immutable. Parent asset set ID for the asset set where the elements of this asset set come from. For example: the sync level location AssetSet ID where the the elements in LocationGroup AssetSet come from. This field is required and only applicable for Location Group typed AssetSet.
AssetSetLocationSetBusinessProfileLocationSetBusinessNameFilter String ATTRIBUTE Used to filter Google Business Profile listings by business name. If businessNameFilter is set, only listings with a matching business name are candidates to be sync'd into Assets.
AssetSetLocationSetBusinessProfileLocationSetLabelFilters String ATTRIBUTE Used to filter Google Business Profile listings by labels. If entries exist in labelFilters, only listings that have any of the labels set are candidates to be synchronized into Assets. If no entries exist in labelFilters, then all listings are candidates for syncing. Label filters are OR'ed together.
AssetSetLocationSetBusinessProfileLocationSetListingIdFilters String ATTRIBUTE Used to filter Google Business Profile listings by listing id. If entries exist in listingIdFilters, only listings specified by the filters are candidates to be synchronized into Assets. If no entries exist in listingIdFilters, then all listings are candidates for syncing. Listing ID filters are OR'ed together.
AssetSetLocationSetChainLocationSetRelationshipType String ATTRIBUTE Required. Immutable. Relationship type the specified chains have with this advertiser. The allowed values are AUTO_DEALERS, GENERAL_RETAILERS, UNKNOWN, UNSPECIFIED.
AssetSetLocationSetLocationOwnershipType String ATTRIBUTE Required. Immutable. Location Ownership Type (owned location or affiliate location). The allowed values are AFFILIATE, BUSINESS_OWNER, UNKNOWN, UNSPECIFIED.
AssetSetMerchantCenterFeedFeedLabel String ATTRIBUTE Optional. Feed Label from Google Merchant Center.
AssetSetMerchantCenterFeedMerchantId Long ATTRIBUTE Required. Merchant ID from Google Merchant Center
AssetSetName String ATTRIBUTE Required. Name of the asset set. Required. It must have a minimum length of 1 and maximum length of 128.
AssetSetResourceName String ATTRIBUTE Immutable. The resource name of the asset set. Asset set resource names have the form: customers/{customer_id}/assetSets/{asset_set_id}
AssetSetStatus String ATTRIBUTE Output only. The status of the asset set. Read-only. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
AssetSetType String ATTRIBUTE Required. Immutable. The type of the asset set. Required. The allowed values are BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, DYNAMIC_CUSTOM, DYNAMIC_EDUCATION, DYNAMIC_FLIGHTS, DYNAMIC_HOTELS_AND_RENTALS, DYNAMIC_JOBS, DYNAMIC_LOCAL, DYNAMIC_REAL_ESTATE, DYNAMIC_TRAVEL, HOTEL_PROPERTY, LOCATION_SYNC, MERCHANT_CENTER_FEED, PAGE_FEED, STATIC_LOCATION_GROUP, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AssetSetAsset

AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set.

Columns
Name Type Behavior Description
AssetSetAssetAsset String ATTRIBUTE Immutable. The asset which this asset set asset is linking to.
AssetSetAssetAssetSet String ATTRIBUTE Immutable. The asset set which this asset set asset is linking to.
AssetSetAssetResourceName String ATTRIBUTE Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}
AssetSetAssetStatus String ATTRIBUTE Output only. The status of the asset set asset. Read-only. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
PhoneCalls Long METRIC Number of offline phone calls.
PhoneImpressions Long METRIC Number of offline phone impressions.
PhoneThroughRate Double METRIC Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown anywhere above the organic search results.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
AssetInteractionTargetAsset String SEGMENT The asset resource name.
AssetInteractionTargetInteractionOnThisAsset Bool SEGMENT Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AssetSetTypeView

An asset set type view. This view reports non-overcounted metrics for each asset set type. Child asset set types are not included in this report. Their stats are aggregated under the parent asset set type.

Columns
Name Type Behavior Description
AssetSetTypeViewAssetSetType String ATTRIBUTE Output only. The asset set type of the asset set type view. The allowed values are BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, DYNAMIC_CUSTOM, DYNAMIC_EDUCATION, DYNAMIC_FLIGHTS, DYNAMIC_HOTELS_AND_RENTALS, DYNAMIC_JOBS, DYNAMIC_LOCAL, DYNAMIC_REAL_ESTATE, DYNAMIC_TRAVEL, HOTEL_PROPERTY, LOCATION_SYNC, MERCHANT_CENTER_FEED, PAGE_FEED, STATIC_LOCATION_GROUP, UNKNOWN, UNSPECIFIED.
AssetSetTypeViewResourceName String ATTRIBUTE Output only. The resource name of the asset set type view. Asset set type view resource names have the form: customers/{customer_id}/assetSetTypeViews/{asset_set_type}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
PhoneCalls Long METRIC Number of offline phone calls.
PhoneImpressions Long METRIC Number of offline phone impressions.
PhoneThroughRate Double METRIC Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

Audience

Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.

Columns
Name Type Behavior Description
AudienceAssetGroup String ATTRIBUTE Immutable. The asset group that this audience is scoped under. Must be set if and only if scope is ASSET_GROUP. Immutable after creation. If an audience with ASSET_GROUP scope is upgraded to CUSTOMER scope, this field will automatically be cleared.
AudienceDescription String ATTRIBUTE Description of this audience.
AudienceDimensions String ATTRIBUTE Positive dimensions specifying the audience composition.
AudienceExclusionDimension String ATTRIBUTE Negative dimension specifying the audience composition.
AudienceId Long ATTRIBUTE Output only. ID of the audience.
AudienceName String ATTRIBUTE Name of the audience. It should be unique across all audiences within the account. It must have a minimum length of 1 and maximum length of 255. Required when scope is not set or is set to CUSTOMER. Cannot be set or updated when scope is ASSET_GROUP.
AudienceResourceName String ATTRIBUTE Immutable. The resource name of the audience. Audience names have the form: customers/{customer_id}/audiences/{audience_id}
AudienceScope String ATTRIBUTE Defines the scope this audience can be used in. By default, the scope is CUSTOMER. Audiences can be created with a scope of ASSET_GROUP for exclusive use by a single asset_group. Scope may change from ASSET_GROUP to CUSTOMER but not from CUSTOMER to ASSET_GROUP. The allowed values are ASSET_GROUP, CUSTOMER, UNKNOWN, UNSPECIFIED.
AudienceStatus String ATTRIBUTE Output only. Status of this audience. Indicates whether the audience is enabled or removed. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

AudienceStatsReport

Audience-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AdGroupBaseAdGroup String ATTRIBUTE Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
AdGroupCriterionCriterionId Long ATTRIBUTE Output only. The ID of the criterion. This field is ignored for mutates.
AdGroupId Long ATTRIBUTE Output only. The ID of the ad group.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE_SEARCH, YOUTUBE_WATCH.
CampaignBaseCampaign String ATTRIBUTE Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only.
CampaignId Long ATTRIBUTE Output only. The ID of the campaign.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.

BatchJob

A list of mutates being processed asynchronously. The mutates are uploaded by the user. The mutates themselves aren't readable and the results of the job can only be read using BatchJobService.ListBatchJobResults.

Columns
Name Type Behavior Description
BatchJobId Long ATTRIBUTE Output only. ID of this batch job.
BatchJobLongRunningOperation String ATTRIBUTE Output only. The resource name of the long-running operation that can be used to poll for completion. Only set when the batch job status is RUNNING or DONE.
BatchJobMetadataCompletionDateTime Datetime ATTRIBUTE Output only. The time when this batch job was completed. Formatted as yyyy-MM-dd HH🇲🇲ss. Example: '2018-03-05 09:16:00'
BatchJobMetadataCreationDateTime Datetime ATTRIBUTE Output only. The time when this batch job was created. Formatted as yyyy-mm-dd hh🇲🇲ss. Example: '2018-03-05 09:15:00'
BatchJobMetadataEstimatedCompletionRatio Double ATTRIBUTE Output only. The fraction (between 0.0 and 1.0) of mutates that have been processed. This is empty if the job hasn't started running yet.
BatchJobMetadataExecutedOperationCount Long ATTRIBUTE Output only. The number of mutate operations executed by the batch job. Present only if the job has started running.
BatchJobMetadataExecutionLimitSeconds Int ATTRIBUTE Immutable. The approximate upper bound for how long a batch job can be executed, in seconds. If the job runs more than the given upper bound, the job will be canceled.
BatchJobMetadataOperationCount Long ATTRIBUTE Output only. The number of mutate operations in the batch job.
BatchJobMetadataStartDateTime Datetime ATTRIBUTE Output only. The time when this batch job started running. Formatted as yyyy-mm-dd hh🇲🇲ss. Example: '2018-03-05 09:15:30'
BatchJobNextAddSequenceToken String ATTRIBUTE Output only. The next sequence token to use when adding operations. Only set when the batch job status is PENDING.
BatchJobResourceName String ATTRIBUTE Immutable. The resource name of the batch job. Batch job resource names have the form: customers/{customer_id}/batchJobs/{batch_job_id}
BatchJobStatus String ATTRIBUTE Output only. Status of this batch job. The allowed values are DONE, PENDING, RUNNING, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

BiddingDataExclusion

Represents a bidding data exclusion. See 'About data exclusions' at https://support.google.com/google-ads/answer/10370710.

Columns
Name Type Behavior Description
BiddingDataExclusionAdvertisingChannelTypes String ATTRIBUTE The data_exclusion will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this exclusion is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported. The allowed values are DISCOVERY, DISPLAY, HOTEL, LOCAL, LOCAL_SERVICES, MULTI_CHANNEL, PERFORMANCE_MAX, SEARCH, SHOPPING, SMART, TRAVEL, UNKNOWN, UNSPECIFIED, VIDEO.
BiddingDataExclusionCampaigns String ATTRIBUTE The data exclusion will apply to the campaigns listed when the scope of this exclusion is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
BiddingDataExclusionDataExclusionId Long ATTRIBUTE Output only. The ID of the data exclusion.
BiddingDataExclusionDescription String ATTRIBUTE The description of the data exclusion. The description can be at most 2048 characters.
BiddingDataExclusionDevices String ATTRIBUTE If not specified, all devices will be included in this exclusion. Otherwise, only the specified targeted devices will be included in this exclusion. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
BiddingDataExclusionEndDateTime String ATTRIBUTE Required. The exclusive end time of the data exclusion in yyyy-MM-dd HH🇲🇲ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
BiddingDataExclusionName String ATTRIBUTE The name of the data exclusion. The name can be at most 255 characters.
BiddingDataExclusionResourceName String ATTRIBUTE Immutable. The resource name of the data exclusion. Data exclusion resource names have the form: customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}
BiddingDataExclusionScope String ATTRIBUTE The scope of the data exclusion. The allowed values are CAMPAIGN, CHANNEL, CUSTOMER, UNKNOWN, UNSPECIFIED.
BiddingDataExclusionStartDateTime String ATTRIBUTE Required. The inclusive start time of the data exclusion in yyyy-MM-dd HH🇲🇲ss format. A data exclusion is backward looking and should be used for events that start in the past and end either in the past or future.
BiddingDataExclusionStatus String ATTRIBUTE Output only. The status of the data exclusion. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

BiddingSeasonalityAdjustment

Represents a bidding seasonality adjustment. See 'About seasonality adjustments' at https://support.google.com/google-ads/answer/10369906.

Columns
Name Type Behavior Description
BiddingSeasonalityAdjustmentAdvertisingChannelTypes String ATTRIBUTE The seasonality adjustment will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this adjustment is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported. The allowed values are DISCOVERY, DISPLAY, HOTEL, LOCAL, LOCAL_SERVICES, MULTI_CHANNEL, PERFORMANCE_MAX, SEARCH, SHOPPING, SMART, TRAVEL, UNKNOWN, UNSPECIFIED, VIDEO.
BiddingSeasonalityAdjustmentCampaigns String ATTRIBUTE The seasonality adjustment will apply to the campaigns listed when the scope of this adjustment is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
BiddingSeasonalityAdjustmentConversionRateModifier Double ATTRIBUTE Conversion rate modifier estimated based on expected conversion rate changes. When this field is unset or set to 1.0 no adjustment will be applied to traffic. The allowed range is 0.1 to 10.0.
BiddingSeasonalityAdjustmentDescription String ATTRIBUTE The description of the seasonality adjustment. The description can be at most 2048 characters.
BiddingSeasonalityAdjustmentDevices String ATTRIBUTE If not specified, all devices will be included in this adjustment. Otherwise, only the specified targeted devices will be included in this adjustment. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
BiddingSeasonalityAdjustmentEndDateTime String ATTRIBUTE Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH🇲🇲ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
BiddingSeasonalityAdjustmentName String ATTRIBUTE The name of the seasonality adjustment. The name can be at most 255 characters.
BiddingSeasonalityAdjustmentResourceName String ATTRIBUTE Immutable. The resource name of the seasonality adjustment. Seasonality adjustment resource names have the form: customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}
BiddingSeasonalityAdjustmentScope String ATTRIBUTE The scope of the seasonality adjustment. The allowed values are CAMPAIGN, CHANNEL, CUSTOMER, UNKNOWN, UNSPECIFIED.
BiddingSeasonalityAdjustmentSeasonalityAdjustmentId Long ATTRIBUTE Output only. The ID of the seasonality adjustment.
BiddingSeasonalityAdjustmentStartDateTime String ATTRIBUTE Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd HH🇲🇲ss format. A seasonality adjustment is forward looking and should be used for events that start and end in the future.
BiddingSeasonalityAdjustmentStatus String ATTRIBUTE Output only. The status of the seasonality adjustment. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

BiddingStrategy

A bidding strategy.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
BiddingStrategyAlignedCampaignBudgetId Long ATTRIBUTE ID of the campaign budget that this portfolio bidding strategy is aligned with. When a portfolio and a campaign budget are aligned, that means that they are attached to the same set of campaigns. After a bidding strategy is aligned with a campaign budget, campaigns that are added to the bidding strategy must also use the aligned campaign budget.
BiddingStrategyCampaignCount Long ATTRIBUTE Output only. The number of campaigns attached to this bidding strategy. This field is read-only.
BiddingStrategyCurrencyCode String ATTRIBUTE Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.
BiddingStrategyEffectiveCurrencyCode String ATTRIBUTE Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only.
BiddingStrategyEnhancedCpc String ATTRIBUTE A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.
BiddingStrategyId Long ATTRIBUTE Output only. The ID of the bidding strategy.
BiddingStrategyMaximizeConversionValueCpcBidCeilingMicros Long ATTRIBUTE Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
BiddingStrategyMaximizeConversionValueCpcBidFloorMicros Long ATTRIBUTE Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
BiddingStrategyMaximizeConversionValueTargetRoas Double ATTRIBUTE Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
BiddingStrategyMaximizeConversionsCpcBidCeilingMicros Long ATTRIBUTE Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
BiddingStrategyMaximizeConversionsCpcBidFloorMicros Long ATTRIBUTE Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
BiddingStrategyMaximizeConversionsTargetCpaMicros Long ATTRIBUTE Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
BiddingStrategyName String ATTRIBUTE The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
BiddingStrategyNonRemovedCampaignCount Long ATTRIBUTE Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only.
BiddingStrategyResourceName String ATTRIBUTE Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: customers/{customer_id}/biddingStrategies/{bidding_strategy_id}
BiddingStrategyStatus String ATTRIBUTE Output only. The status of the bidding strategy. This field is read-only. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
BiddingStrategyTargetCpaCpcBidCeilingMicros Long ATTRIBUTE Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
BiddingStrategyTargetCpaCpcBidFloorMicros Long ATTRIBUTE Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
BiddingStrategyTargetCpaTargetCpaMicros Long ATTRIBUTE Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
BiddingStrategyTargetImpressionShareCpcBidCeilingMicros Long ATTRIBUTE Output only. The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
BiddingStrategyTargetImpressionShareLocation String ATTRIBUTE Output only. The targeted location on the search results page. The allowed values are ABSOLUTE_TOP_OF_PAGE, ANYWHERE_ON_PAGE, TOP_OF_PAGE, UNKNOWN, UNSPECIFIED.
BiddingStrategyTargetImpressionShareLocationFractionMicros Long ATTRIBUTE The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10, 000.
BiddingStrategyTargetRoasCpcBidCeilingMicros Long ATTRIBUTE Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
BiddingStrategyTargetRoasCpcBidFloorMicros Long ATTRIBUTE Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
BiddingStrategyTargetRoasTargetRoas Double ATTRIBUTE Output only. The chosen revenue (based on conversion data) per unit of spend.
BiddingStrategyTargetSpendCpcBidCeilingMicros Long ATTRIBUTE Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
BiddingStrategyTargetSpendTargetSpendMicros Long ATTRIBUTE Output only. The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
BiddingStrategyType String ATTRIBUTE Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only. The allowed values are COMMISSION, ENHANCED_CPC, INVALID, MANUAL_CPA, MANUAL_CPC, MANUAL_CPM, MANUAL_CPV, MAXIMIZE_CONVERSIONS, MAXIMIZE_CONVERSION_VALUE, PAGE_ONE_PROMOTED, PERCENT_CPC, TARGET_CPA, TARGET_CPM, TARGET_IMPRESSION_SHARE, TARGET_OUTRANK_SHARE, TARGET_ROAS, TARGET_SPEND, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageTargetCpaMicros Long METRIC The average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).
AverageTargetRoas Double METRIC The average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Hour Int SEGMENT Hour of day as a number between 0 and 23, inclusive.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

BiddingStrategySimulation

A bidding strategy simulation. Supported combinations of simulation type and simulation modification method are detailed below respectively. 1. TARGET_CPA - UNIFORM 2. TARGET_ROAS - UNIFORM

Columns
Name Type Behavior Description
BiddingStrategySimulationBiddingStrategyId Long ATTRIBUTE Output only. Bidding strategy shared set ID of the simulation.
BiddingStrategySimulationEndDate Date ATTRIBUTE Output only. Last day on which the simulation is based, in YYYY-MM-DD format
BiddingStrategySimulationModificationMethod String ATTRIBUTE Output only. How the simulation modifies the field. The allowed values are DEFAULT, SCALING, UNIFORM, UNKNOWN, UNSPECIFIED.
BiddingStrategySimulationResourceName String ATTRIBUTE Output only. The resource name of the bidding strategy simulation. Bidding strategy simulation resource names have the form: customers/{customer_id}/biddingStrategySimulations/{bidding_strategy_id}~{type}~{modification_method}~{start_date}~{end_date}
BiddingStrategySimulationStartDate Date ATTRIBUTE Output only. First day on which the simulation is based, in YYYY-MM-DD format.
BiddingStrategySimulationTargetCpaPointListPoints String ATTRIBUTE Projected metrics for a series of target CPA amounts.
BiddingStrategySimulationTargetRoasPointListPoints String ATTRIBUTE Projected metrics for a series of target ROAS amounts.
BiddingStrategySimulationType String ATTRIBUTE Output only. The field that the simulation modifies. The allowed values are BID_MODIFIER, BUDGET, CPC_BID, CPV_BID, PERCENT_CPC_BID, TARGET_CPA, TARGET_IMPRESSION_SHARE, TARGET_ROAS, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

BillingSetup

A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser.

Columns
Name Type Behavior Description
BillingSetupEndDateTime Datetime ATTRIBUTE Output only. The end date time in yyyy-MM-dd or yyyy-MM-dd HH🇲🇲ss format.
BillingSetupEndTimeType String ATTRIBUTE Output only. The end time as a type. The only possible value is FOREVER. The allowed values are FOREVER, NOW, UNKNOWN, UNSPECIFIED.
BillingSetupId Long ATTRIBUTE Output only. The ID of the billing setup.
BillingSetupPaymentsAccount String ATTRIBUTE Immutable. The resource name of the payments account associated with this billing setup. Payments resource names have the form: customers/{customer_id}/paymentsAccounts/{payments_account_id} When setting up billing, this is used to signup with an existing payments account (and then payments_account_info should not be set). When getting a billing setup, this and payments_account_info will be populated.
BillingSetupPaymentsAccountInfoPaymentsAccountId String ATTRIBUTE Output only. A 16 digit ID used to identify the payments account associated with the billing setup. This must be passed as a string with dashes, for example, '1234-5678-9012-3456'.
BillingSetupPaymentsAccountInfoPaymentsAccountName String ATTRIBUTE Immutable. The name of the payments account associated with the billing setup. This enables the user to specify a meaningful name for a payments account to aid in reconciling monthly invoices. This name will be printed in the monthly invoices.
BillingSetupPaymentsAccountInfoPaymentsProfileId String ATTRIBUTE Immutable. A 12 digit ID used to identify the payments profile associated with the billing setup. This must be passed in as a string with dashes, for example, '1234-5678-9012'.
BillingSetupPaymentsAccountInfoPaymentsProfileName String ATTRIBUTE Output only. The name of the payments profile associated with the billing setup.
BillingSetupPaymentsAccountInfoSecondaryPaymentsProfileId String ATTRIBUTE Output only. A secondary payments profile ID present in uncommon situations, for example, when a sequential liability agreement has been arranged.
BillingSetupResourceName String ATTRIBUTE Immutable. The resource name of the billing setup. BillingSetup resource names have the form: customers/{customer_id}/billingSetups/{billing_setup_id}
BillingSetupStartDateTime Datetime ATTRIBUTE Immutable. The start date time in yyyy-MM-dd or yyyy-MM-dd HH🇲🇲ss format. Only a future time is allowed.
BillingSetupStatus String ATTRIBUTE Output only. The status of the billing setup. The allowed values are APPROVED, APPROVED_HELD, CANCELLED, PENDING, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CallView

A call view that includes data for call tracking of call-only ads or call extensions.

Columns
Name Type Behavior Description
CallViewCallDurationSeconds Long ATTRIBUTE Output only. The advertiser-provided call duration in seconds.
CallViewCallStatus String ATTRIBUTE Output only. The status of the call. The allowed values are MISSED, RECEIVED, UNKNOWN, UNSPECIFIED.
CallViewCallTrackingDisplayLocation String ATTRIBUTE Output only. The call tracking display location. The allowed values are AD, LANDING_PAGE, UNKNOWN, UNSPECIFIED.
CallViewCallerAreaCode String ATTRIBUTE Output only. Area code of the caller. Null if the call duration is shorter than 15 seconds.
CallViewCallerCountryCode String ATTRIBUTE Output only. Country code of the caller.
CallViewEndCallDateTime Date ATTRIBUTE Output only. The advertiser-provided call end date time.
CallViewResourceName String ATTRIBUTE Output only. The resource name of the call view. Call view resource names have the form: customers/{customer_id}/callViews/{call_detail_id}
CallViewStartCallDateTime Date ATTRIBUTE Output only. The advertiser-provided call start date time.
CallViewType String ATTRIBUTE Output only. The type of the call. The allowed values are HIGH_END_MOBILE_SEARCH, MANUALLY_DIALED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

Campaign

A campaign.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
CampaignAccessibleBiddingStrategy String ATTRIBUTE Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.
CampaignAdServingOptimizationStatus String ATTRIBUTE The ad serving optimization status of the campaign. The allowed values are CONVERSION_OPTIMIZE, OPTIMIZE, ROTATE, ROTATE_INDEFINITELY, UNAVAILABLE, UNKNOWN, UNSPECIFIED.
CampaignAdvertisingChannelSubType String ATTRIBUTE Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed. The allowed values are APP_CAMPAIGN, APP_CAMPAIGN_FOR_ENGAGEMENT, APP_CAMPAIGN_FOR_PRE_REGISTRATION, DISPLAY_EXPRESS, DISPLAY_GMAIL_AD, DISPLAY_MOBILE_APP, DISPLAY_SMART_CAMPAIGN, LOCAL_CAMPAIGN, SEARCH_EXPRESS, SEARCH_MOBILE_APP, SHOPPING_COMPARISON_LISTING_ADS, SHOPPING_SMART_ADS, SMART_CAMPAIGN, TRAVEL_ACTIVITIES, UNKNOWN, UNSPECIFIED, VIDEO_ACTION, VIDEO_NON_SKIPPABLE, VIDEO_OUTSTREAM, VIDEO_REACH_TARGET_FREQUENCY, VIDEO_SEQUENCE.
CampaignAdvertisingChannelType String ATTRIBUTE Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed. The allowed values are DISCOVERY, DISPLAY, HOTEL, LOCAL, LOCAL_SERVICES, MULTI_CHANNEL, PERFORMANCE_MAX, SEARCH, SHOPPING, SMART, TRAVEL, UNKNOWN, UNSPECIFIED, VIDEO.
CampaignAppCampaignSettingAppId String ATTRIBUTE Immutable. A string that uniquely identifies a mobile application.
CampaignAppCampaignSettingAppStore String ATTRIBUTE Immutable. The application store that distributes this specific app. The allowed values are APPLE_APP_STORE, GOOGLE_APP_STORE, UNKNOWN, UNSPECIFIED.
CampaignAppCampaignSettingBiddingStrategyGoalType String ATTRIBUTE Represents the goal which the bidding strategy of this app campaign should optimize towards. The allowed values are OPTIMIZE_INSTALLS_TARGET_INSTALL_COST, OPTIMIZE_INSTALLS_WITHOUT_TARGET_INSTALL_COST, OPTIMIZE_IN_APP_CONVERSIONS_TARGET_CONVERSION_COST, OPTIMIZE_IN_APP_CONVERSIONS_TARGET_INSTALL_COST, OPTIMIZE_PRE_REGISTRATION_CONVERSION_VOLUME, OPTIMIZE_RETURN_ON_ADVERTISING_SPEND, UNKNOWN, UNSPECIFIED.
CampaignAssetAutomationSettings String ATTRIBUTE Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.
CampaignAudienceSettingUseAudienceGrouped Bool ATTRIBUTE Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
CampaignBaseCampaign String ATTRIBUTE Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only.
CampaignBiddingStrategy String ATTRIBUTE Portfolio bidding strategy used by campaign.
CampaignBiddingStrategySystemStatus String ATTRIBUTE Output only. The system status of the campaign's bidding strategy. The allowed values are ENABLED, LEARNING_BUDGET_CHANGE, LEARNING_COMPOSITION_CHANGE, LEARNING_CONVERSION_SETTING_CHANGE, LEARNING_CONVERSION_TYPE_CHANGE, LEARNING_NEW, LEARNING_SETTING_CHANGE, LIMITED_BY_BUDGET, LIMITED_BY_CPC_BID_CEILING, LIMITED_BY_CPC_BID_FLOOR, LIMITED_BY_DATA, LIMITED_BY_INVENTORY, LIMITED_BY_LOW_PRIORITY_SPEND, LIMITED_BY_LOW_QUALITY, MISCONFIGURED_CONVERSION_SETTINGS, MISCONFIGURED_CONVERSION_TYPES, MISCONFIGURED_SHARED_BUDGET, MISCONFIGURED_STRATEGY_TYPE, MISCONFIGURED_ZERO_ELIGIBILITY, MULTIPLE, MULTIPLE_LEARNING, MULTIPLE_LIMITED, MULTIPLE_MISCONFIGURED, PAUSED, UNAVAILABLE, UNKNOWN, UNSPECIFIED.
CampaignBiddingStrategyType String ATTRIBUTE Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only. The allowed values are COMMISSION, ENHANCED_CPC, INVALID, MANUAL_CPA, MANUAL_CPC, MANUAL_CPM, MANUAL_CPV, MAXIMIZE_CONVERSIONS, MAXIMIZE_CONVERSION_VALUE, PAGE_ONE_PROMOTED, PERCENT_CPC, TARGET_CPA, TARGET_CPM, TARGET_IMPRESSION_SHARE, TARGET_OUTRANK_SHARE, TARGET_ROAS, TARGET_SPEND, UNKNOWN, UNSPECIFIED.
CampaignCampaignBudget String ATTRIBUTE The budget of the campaign.
CampaignCampaignGroup String ATTRIBUTE The campaign group this campaign belongs to.
CampaignCommissionCommissionRateMicros Long ATTRIBUTE Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1, 000, 000). For example, 106, 000 represents a commission rate of 0.106 (10.6%).
CampaignDiscoveryCampaignSettingsUpgradedTargeting Bool ATTRIBUTE Immutable. Specifies whether this campaign uses upgraded targeting options. When this field is set to true, you can use location and language targeting at the ad group level as opposed to the standard campaign-level targeting. This field defaults to false, and can only be set when creating a campaign.
CampaignDynamicSearchAdsSettingDomainName String ATTRIBUTE Required. The Internet domain name that this setting represents, for example, 'google.com' or 'www.google.com'.
CampaignDynamicSearchAdsSettingFeeds String ATTRIBUTE The list of page feeds associated with the campaign.
CampaignDynamicSearchAdsSettingLanguageCode String ATTRIBUTE Required. The language code specifying the language of the domain, for example, 'en'.
CampaignDynamicSearchAdsSettingUseSuppliedUrlsOnly Bool ATTRIBUTE Whether the campaign uses advertiser supplied URLs exclusively.
CampaignEndDate Date ATTRIBUTE The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.
CampaignExcludedParentAssetFieldTypes String ATTRIBUTE The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level. The allowed values are AD_IMAGE, BOOK_ON_GOOGLE, BUSINESS_LOGO, BUSINESS_NAME, CALL, CALLOUT, CALL_TO_ACTION_SELECTION, DESCRIPTION, HEADLINE, HOTEL_CALLOUT, HOTEL_PROPERTY, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MANDATORY_AD_TEXT, MARKETING_IMAGE, MEDIA_BUNDLE, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, VIDEO, YOUTUBE_VIDEO.
CampaignExcludedParentAssetSetTypes String ATTRIBUTE The asset set types that should be excluded from this campaign. Asset set links with these types will not be inherited by this campaign from the upper level. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this campaign, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this campaign. Only LOCATION_SYNC is currently supported. The allowed values are BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, DYNAMIC_CUSTOM, DYNAMIC_EDUCATION, DYNAMIC_FLIGHTS, DYNAMIC_HOTELS_AND_RENTALS, DYNAMIC_JOBS, DYNAMIC_LOCAL, DYNAMIC_REAL_ESTATE, DYNAMIC_TRAVEL, HOTEL_PROPERTY, LOCATION_SYNC, MERCHANT_CENTER_FEED, PAGE_FEED, STATIC_LOCATION_GROUP, UNKNOWN, UNSPECIFIED.
CampaignExperimentType String ATTRIBUTE Output only. The type of campaign: normal, draft, or experiment. The allowed values are BASE, DRAFT, EXPERIMENT, UNKNOWN, UNSPECIFIED.
CampaignFinalUrlSuffix String ATTRIBUTE Suffix used to append query parameters to landing pages that are served with parallel tracking.
CampaignFrequencyCaps String ATTRIBUTE A list that limits how often each user will see this campaign's ads.
CampaignGeoTargetTypeSettingNegativeGeoTargetType String ATTRIBUTE The setting used for negative geotargeting in this particular campaign. The allowed values are PRESENCE, PRESENCE_OR_INTEREST, UNKNOWN, UNSPECIFIED.
CampaignGeoTargetTypeSettingPositiveGeoTargetType String ATTRIBUTE The setting used for positive geotargeting in this particular campaign. The allowed values are PRESENCE, PRESENCE_OR_INTEREST, SEARCH_INTEREST, UNKNOWN, UNSPECIFIED.
CampaignHotelPropertyAssetSet String ATTRIBUTE Immutable. The set of hotel properties for Performance Max for travel goals campaigns.
CampaignHotelSettingHotelCenterId Long ATTRIBUTE Immutable. The linked Hotel Center account.
CampaignId Long ATTRIBUTE Output only. The ID of the campaign.
CampaignLabels String ATTRIBUTE Output only. The resource names of labels attached to this campaign.
CampaignListingType String ATTRIBUTE Immutable. Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns. The allowed values are UNKNOWN, UNSPECIFIED, VEHICLES.
CampaignLocalCampaignSettingLocationSourceType String ATTRIBUTE The location source type for this local campaign. The allowed values are AFFILIATE, GOOGLE_MY_BUSINESS, UNKNOWN, UNSPECIFIED.
CampaignLocalServicesCampaignSettingsCategoryBids String ATTRIBUTE Categorical level bids associated with MANUAL_CPA bidding strategy.
CampaignManualCpa String ATTRIBUTE Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
CampaignManualCpcEnhancedCpcEnabled Bool ATTRIBUTE Whether bids are to be enhanced based on conversion optimizer data.
CampaignManualCpm String ATTRIBUTE Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
CampaignManualCpv String ATTRIBUTE A bidding strategy that pays a configurable amount per video view.
CampaignMaximizeConversionValueTargetRoas Double ATTRIBUTE Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
CampaignMaximizeConversionsTargetCpaMicros Long ATTRIBUTE Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
CampaignName String ATTRIBUTE The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
CampaignNetworkSettingsTargetContentNetwork Bool ATTRIBUTE Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
CampaignNetworkSettingsTargetGoogleSearch Bool ATTRIBUTE Whether ads will be served with google.com search results.
CampaignNetworkSettingsTargetGoogleTvNetwork Bool ATTRIBUTE Whether ads will be served on the Google TV network.
CampaignNetworkSettingsTargetPartnerSearchNetwork Bool ATTRIBUTE Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
CampaignNetworkSettingsTargetSearchNetwork Bool ATTRIBUTE Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true).
CampaignNetworkSettingsTargetYoutube Bool ATTRIBUTE Whether ads will be served on YouTube.
CampaignOptimizationGoalSettingOptimizationGoalTypes String ATTRIBUTE The list of optimization goal types. The allowed values are APP_PRE_REGISTRATION, CALL_CLICKS, DRIVING_DIRECTIONS, UNKNOWN, UNSPECIFIED.
CampaignOptimizationScore Double ATTRIBUTE Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See 'About optimization score' at https://support.google.com/google-ads/answer/9061546. This field is read-only.
CampaignPaymentMode String ATTRIBUTE Payment mode for the campaign. The allowed values are CLICKS, CONVERSIONS, CONVERSION_VALUE, GUEST_STAY, UNKNOWN, UNSPECIFIED.
CampaignPercentCpcCpcBidCeilingMicros Long ATTRIBUTE Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.
CampaignPercentCpcEnhancedCpcEnabled Bool ATTRIBUTE Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
CampaignPerformanceMaxUpgradePerformanceMaxCampaign String ATTRIBUTE Output only. Indicates which Performance Max campaign the campaign is upgraded to.
CampaignPerformanceMaxUpgradePreUpgradeCampaign String ATTRIBUTE Output only. Indicates legacy campaign upgraded to Performance Max.
CampaignPerformanceMaxUpgradeStatus String ATTRIBUTE Output only. The upgrade status of a campaign requested to be upgraded to Performance Max. The allowed values are UNKNOWN, UNSPECIFIED, UPGRADE_COMPLETE, UPGRADE_ELIGIBLE, UPGRADE_FAILED, UPGRADE_IN_PROGRESS.
CampaignPrimaryStatus String ATTRIBUTE Output only. The primary status of the campaign. Provides insight into why a campaign is not serving or not serving optimally. Modification to the campaign and its related entities might take a while to be reflected in this status. The allowed values are ELIGIBLE, ENDED, LEARNING, LIMITED, MISCONFIGURED, NOT_ELIGIBLE, PAUSED, PENDING, REMOVED, UNKNOWN, UNSPECIFIED.
CampaignPrimaryStatusReasons String ATTRIBUTE Output only. The primary status reasons of the campaign. Provides insight into why a campaign is not serving or not serving optimally. These reasons are aggregated to determine an overall CampaignPrimaryStatus. The allowed values are AD_GROUPS_PAUSED, AD_GROUP_ADS_PAUSED, APP_NOT_RELEASED, APP_PARTIALLY_RELEASED, ASSET_GROUPS_PAUSED, BIDDING_STRATEGY_CONSTRAINED, BIDDING_STRATEGY_LEARNING, BIDDING_STRATEGY_LIMITED, BIDDING_STRATEGY_MISCONFIGURED, BUDGET_CONSTRAINED, BUDGET_MISCONFIGURED, CALL_EXTENSION_DISAPPROVED, CALL_EXTENSION_UNDER_REVIEW, CAMPAIGN_DRAFT, CAMPAIGN_ENDED, CAMPAIGN_GROUP_ALL_GROUP_BUDGETS_ENDED, CAMPAIGN_GROUP_PAUSED, CAMPAIGN_PAUSED, CAMPAIGN_PENDING, CAMPAIGN_REMOVED, HAS_ADS_DISAPPROVED, HAS_ADS_LIMITED_BY_POLICY, HAS_ASSET_GROUPS_DISAPPROVED, HAS_ASSET_GROUPS_LIMITED_BY_POLICY, KEYWORDS_PAUSED, LEAD_FORM_EXTENSION_DISAPPROVED, LEAD_FORM_EXTENSION_UNDER_REVIEW, MISSING_CALL_EXTENSION, MISSING_LEAD_FORM_EXTENSION, MOST_ADS_UNDER_REVIEW, MOST_ASSET_GROUPS_UNDER_REVIEW, NO_AD_GROUPS, NO_AD_GROUP_ADS, NO_ASSET_GROUPS, NO_KEYWORDS, NO_MOBILE_APPLICATION_AD_GROUP_CRITERIA, SEARCH_VOLUME_LIMITED, UNKNOWN, UNSPECIFIED.
CampaignRealTimeBiddingSettingOptIn Bool ATTRIBUTE Whether the campaign is opted in to real-time bidding.
CampaignResourceName String ATTRIBUTE Immutable. The resource name of the campaign. Campaign resource names have the form: customers/{customer_id}/campaigns/{campaign_id}
CampaignSelectiveOptimizationConversionActions String ATTRIBUTE The selected set of conversion actions for optimizing this campaign.
CampaignServingStatus String ATTRIBUTE Output only. The ad serving status of the campaign. The allowed values are ENDED, NONE, PENDING, SERVING, SUSPENDED, UNKNOWN, UNSPECIFIED.
CampaignShoppingSettingAdvertisingPartnerIds String ATTRIBUTE Immutable. The ads account IDs of advertising partners cooperating within the campaign.
CampaignShoppingSettingCampaignPriority Int ATTRIBUTE Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.
CampaignShoppingSettingEnableLocal Bool ATTRIBUTE Whether to include local products.
CampaignShoppingSettingFeedLabel String ATTRIBUTE Feed label of products to include in the campaign. Only one of feed_label or sales_country can be set. If used instead of sales_country, the feed_label field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.
CampaignShoppingSettingMerchantId Long ATTRIBUTE Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
CampaignShoppingSettingUseVehicleInventory Bool ATTRIBUTE Immutable. Whether to target Vehicle Listing inventory. This field is supported only in Smart Shopping Campaigns. For setting Vehicle Listing inventory in Performance Max campaigns, use listing_type instead.
CampaignStartDate Date ATTRIBUTE The date when campaign started in serving customer's timezone in YYYY-MM-DD format.
CampaignStatus String ATTRIBUTE The status of the campaign. When a new campaign is added, the status defaults to ENABLED. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
CampaignTargetCpaCpcBidCeilingMicros Long ATTRIBUTE Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
CampaignTargetCpaCpcBidFloorMicros Long ATTRIBUTE Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
CampaignTargetCpaTargetCpaMicros Long ATTRIBUTE Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
CampaignTargetCpmTargetFrequencyGoalTargetCount Long ATTRIBUTE Target Frequency count representing how many times you want to reach a single user.
CampaignTargetCpmTargetFrequencyGoalTimeUnit String ATTRIBUTE Time window expressing the period over which you want to reach the specified target_count. The allowed values are UNKNOWN, UNSPECIFIED, WEEKLY.
CampaignTargetImpressionShareCpcBidCeilingMicros Long ATTRIBUTE Output only. The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
CampaignTargetImpressionShareLocation String ATTRIBUTE Output only. The targeted location on the search results page. The allowed values are ABSOLUTE_TOP_OF_PAGE, ANYWHERE_ON_PAGE, TOP_OF_PAGE, UNKNOWN, UNSPECIFIED.
CampaignTargetImpressionShareLocationFractionMicros Long ATTRIBUTE The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10, 000.
CampaignTargetRoasCpcBidCeilingMicros Long ATTRIBUTE Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
CampaignTargetRoasCpcBidFloorMicros Long ATTRIBUTE Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
CampaignTargetRoasTargetRoas Double ATTRIBUTE Output only. The chosen revenue (based on conversion data) per unit of spend.
CampaignTargetSpendCpcBidCeilingMicros Long ATTRIBUTE Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
CampaignTargetSpendTargetSpendMicros Long ATTRIBUTE Output only. The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
CampaignTargetingSettingTargetRestrictions String ATTRIBUTE The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
CampaignTrackingSettingTrackingUrl String ATTRIBUTE Output only. The URL used for dynamic tracking.
CampaignTrackingUrlTemplate String ATTRIBUTE The URL template for constructing a tracking URL.
CampaignTravelCampaignSettingsTravelAccountId Long ATTRIBUTE Immutable. The Travel account ID associated with the Travel campaign.
CampaignUrlCustomParameters String ATTRIBUTE The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.
CampaignUrlExpansionOptOut Bool ATTRIBUTE Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false.
CampaignVanityPharmaVanityPharmaDisplayUrlMode String ATTRIBUTE The display mode for vanity pharma URLs. The allowed values are MANUFACTURER_WEBSITE_URL, UNKNOWN, UNSPECIFIED, WEBSITE_DESCRIPTION.
CampaignVanityPharmaVanityPharmaText String ATTRIBUTE The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs. The allowed values are MEDICAL_DEVICE_WEBSITE_EN, MEDICAL_DEVICE_WEBSITE_ES, PRESCRIPTION_CONTRACEPTION_WEBSITE_EN, PRESCRIPTION_CONTRACEPTION_WEBSITE_ES, PRESCRIPTION_DEVICE_WEBSITE_EN, PRESCRIPTION_DEVICE_WEBSITE_ES, PRESCRIPTION_TREATMENT_WEBSITE_EN, PRESCRIPTION_TREATMENT_WEBSITE_ES, PRESCRIPTION_VACCINE_WEBSITE_EN, PRESCRIPTION_VACCINE_WEBSITE_ES, PREVENTATIVE_TREATMENT_WEBSITE_EN, PREVENTATIVE_TREATMENT_WEBSITE_ES, UNKNOWN, UNSPECIFIED.
CampaignVideoBrandSafetySuitability String ATTRIBUTE Output only. 3-Tier Brand Safety setting for the campaign. The allowed values are EXPANDED_INVENTORY, LIMITED_INVENTORY, STANDARD_INVENTORY, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
ActiveViewCpm Double METRIC Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr Double METRIC Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsByConversionDate Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllConversionsFromClickToCall Double METRIC The number of times people clicked the 'Call' button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
AllConversionsFromDirections Double METRIC The number of times people clicked a 'Get directions' button to navigate to a store after clicking an ad. This metric applies to feed items only.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsFromLocationAssetClickToCall Double METRIC Number of call button clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetDirections Double METRIC Number of driving directions clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetMenu Double METRIC Number of menu link clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetOrder Double METRIC Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetOtherEngagement Double METRIC Number of other types of local action clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetStoreVisits Double METRIC Estimated number of visits to the store after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetWebsite Double METRIC Number of website URL clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromMenu Double METRIC The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.
AllConversionsFromOrder Double METRIC The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
AllConversionsFromOtherEngagement Double METRIC The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.
AllConversionsFromStoreVisit Double METRIC Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
AllConversionsFromStoreWebsite Double METRIC The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
AllConversionsValue Double METRIC The value of all conversions.
AllConversionsValueByConversionDate Double METRIC The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllNewCustomerLifetimeValue Double METRIC All of new customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for both biddable and non-biddable conversions. If your campaign has adopted the customer acquisition goal and selected 'bid higher for new customers', these values will be included in 'all_conversions_value'. See https://support.google.com/google-ads/answer/12080169 for more details.
AuctionInsightSearchAbsoluteTopImpressionPercentage Double METRIC This metric is part of the Auction Insights report, and tells how often the ads of another participant showed as the very first ad above the organic search results. This percentage is computed only over the auctions that you appeared in the page. This metric is not publicly available.
AuctionInsightSearchImpressionShare Double METRIC This metric is part of the Auction Insights report, and tells the percentage of impressions that another participant obtained, over the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not publicly available.
AuctionInsightSearchOutrankingShare Double METRIC This metric is part of the Auction Insights report, and tells the percentage of impressions that your ads outranked (showed above) another participant in the auction, compared to the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not publicly available.
AuctionInsightSearchOverlapRate Double METRIC This metric is part of the Auction Insights report, and tells how often another participant's ad received an impression when your ad also received an impression. This metric is not publicly available.
AuctionInsightSearchPositionAboveRate Double METRIC This metric is part of the Auction Insights report, and tells how often another participant's ad was shown in a higher position than yours, when both of your ads were shown at the same page. This metric is not publicly available.
AuctionInsightSearchTopImpressionPercentage Double METRIC This metric is part of the Auction Insights report, and tells how often the ads of another participant showed above the organic search results. This percentage is computed only over the auctions that you appeared in the page. This metric is not publicly available.
AverageCartSize Double METRIC Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
AverageImpressionFrequencyPerUser Double METRIC The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.
AverageOrderValueMicros Long METRIC Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is \(15 = (\)10 + $15 + $20)/3. This metric is only available if you report conversions with cart data.
AveragePageViews Double METRIC Average number of pages viewed per session.
AverageTargetCpaMicros Long METRIC The average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).
AverageTargetRoas Double METRIC The average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).
AverageTimeOnSite Double METRIC Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
BounceRate Double METRIC Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
Clicks Long METRIC The number of clicks.
ContentBudgetLostImpressionShare Double METRIC The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
ContentImpressionShare Double METRIC The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
ContentRankLostImpressionShare Double METRIC The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsByConversionDate Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValueByConversionDate Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostOfGoodsSoldMicros Long METRIC Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostPerCurrentModelAttributedConversion Double METRIC The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
CrossSellCostOfGoodsSoldMicros Long METRIC Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data.
CrossSellGrossProfitMicros Long METRIC Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data.
CrossSellRevenueMicros Long METRIC Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data.
CrossSellUnitsSold Double METRIC Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
CurrentModelAttributedConversions Double METRIC Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CurrentModelAttributedConversionsFromInteractionsRate Double METRIC Current model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CurrentModelAttributedConversionsFromInteractionsValuePerInteraction Double METRIC The value of current model attributed conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CurrentModelAttributedConversionsValue Double METRIC The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CurrentModelAttributedConversionsValuePerCost Double METRIC The value of current model attributed conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
EligibleImpressionsFromLocationAssetStoreReach Long METRIC Number of impressions in which the store location was shown or the location was used for targeting. This measure is coming from Asset based location.
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
GmailForwards Long METRIC The number of times the ad was forwarded to someone else as a message.
GmailSaves Long METRIC The number of times someone has saved your Gmail ad to their inbox as a message.
GmailSecondaryClicks Long METRIC The number of clicks to the landing page on the expanded state of Gmail ads.
GrossProfitMargin Double METRIC Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced \(20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = (\)10 - \(3)/\)10 x 100%. This metric is only available if you report conversions with cart data.
GrossProfitMicros Long METRIC Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
InvalidClickRate Double METRIC The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
InvalidClicks Long METRIC Number of clicks Google considers illegitimate and doesn't charge you for.
LeadCostOfGoodsSoldMicros Long METRIC Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data.
LeadGrossProfitMicros Long METRIC Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data.
LeadRevenueMicros Long METRIC Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data.
LeadUnitsSold Double METRIC Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
NewCustomerLifetimeValue Double METRIC New customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for biddable conversions. If your campaign has adopted the customer acquisition goal and selected 'bid higher for new customers', these values will be included in 'conversions_value' for optimization. See https://support.google.com/google-ads/answer/12080169 for more details.
OptimizationScoreUplift Double METRIC Total optimization score uplift of all recommendations.
OptimizationScoreUrl String METRIC URL for the optimization score page in the Google Ads web interface. This metric can be selected from customer or campaign, and can be segmented by segments.recommendation_type. For example, SELECT metrics.optimization_score_url, segments.recommendation_type FROM customer will return a URL for each unique (customer, recommendation_type) combination.
Orders Double METRIC Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data.
PercentNewVisitors Double METRIC Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
PhoneCalls Long METRIC Number of offline phone calls.
PhoneImpressions Long METRIC Number of offline phone impressions.
PhoneThroughRate Double METRIC Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
PublisherOrganicClicks Long METRIC Clicks from properties for which the traffic the publisher has not paid for or acquired through incentivized activity
PublisherPurchasedClicks Long METRIC Clicks from properties not owned by the publisher for which the traffic the publisher has paid for or acquired through incentivized activity
PublisherUnknownClicks Long METRIC Clicks from traffic which is not identified as 'Publisher Purchased' or 'Publisher Organic'
RelativeCtr Double METRIC Your clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites.
RevenueMicros Long METRIC Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is \(25 = (\)10 + $20) - $5. This metric is only available if you report conversions with cart data.
SearchAbsoluteTopImpressionShare Double METRIC The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/google-ads/answer/7501826 for details. Any value below 0.1 is reported as 0.0999.
SearchBudgetLostAbsoluteTopImpressionShare Double METRIC The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchBudgetLostImpressionShare Double METRIC The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchBudgetLostTopImpressionShare Double METRIC The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchClickShare Double METRIC The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
SearchExactMatchImpressionShare Double METRIC The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
SearchImpressionShare Double METRIC The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
SearchRankLostAbsoluteTopImpressionShare Double METRIC The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchRankLostImpressionShare Double METRIC The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchRankLostTopImpressionShare Double METRIC The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchTopImpressionShare Double METRIC The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
SkAdNetworkInstalls Long METRIC The number of iOS Store Kit Ad Network conversions.
SkAdNetworkTotalConversions Long METRIC The total number of iOS Store Kit Ad Network conversions.
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown anywhere above the organic search results.
UniqueUsers Long METRIC The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.
UnitsSold Double METRIC Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerAllConversionsByConversionDate Double METRIC The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ValuePerConversionsByConversionDate Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ValuePerCurrentModelAttributedConversion Double METRIC The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoQuartileP100Rate Double METRIC Percentage of impressions where the viewer watched all of your video.
VideoQuartileP25Rate Double METRIC Percentage of impressions where the viewer watched 25% of your video.
VideoQuartileP50Rate Double METRIC Percentage of impressions where the viewer watched 50% of your video.
VideoQuartileP75Rate Double METRIC Percentage of impressions where the viewer watched 75% of your video.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
ViewThroughConversionsFromLocationAssetClickToCall Double METRIC Number of call button clicks on any location surface after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetDirections Double METRIC Number of driving directions clicks on any location surface after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetMenu Double METRIC Number of menu link clicks on any location surface after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetOrder Double METRIC Number of order clicks on any location surface after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetOtherEngagement Double METRIC Number of other types of local action clicks on any location surface after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetStoreVisits Double METRIC Estimated number of visits to the store after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetWebsite Double METRIC Number of website URL clicks on any location surface after an impression. This measure is coming from Asset based location.
AdDestinationType String SEGMENT Ad Destination type. The allowed values are APP_DEEP_LINK, APP_STORE, LEAD_FORM, LOCATION_LISTING, MAP_DIRECTIONS, MESSAGE, NOT_APPLICABLE, PHONE_CALL, UNKNOWN, UNMODELED_FOR_CONVERSIONS, UNSPECIFIED, WEBSITE, YOUTUBE.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
AssetInteractionTargetAsset String SEGMENT The asset resource name.
AssetInteractionTargetInteractionOnThisAsset Bool SEGMENT Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
AuctionInsightDomain String SEGMENT Domain (visible URL) of a participant in the Auction Insights report.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
ConversionAdjustment Bool SEGMENT This segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.
ConversionAttributionEventType String SEGMENT Conversion attribution event type. The allowed values are IMPRESSION, INTERACTION, UNKNOWN, UNSPECIFIED.
ConversionLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion. The allowed values are EIGHT_TO_NINE_DAYS, ELEVEN_TO_TWELVE_DAYS, FIVE_TO_SIX_DAYS, FORTY_FIVE_TO_SIXTY_DAYS, FOURTEEN_TO_TWENTY_ONE_DAYS, FOUR_TO_FIVE_DAYS, LESS_THAN_ONE_DAY, NINE_TO_TEN_DAYS, ONE_TO_TWO_DAYS, SEVEN_TO_EIGHT_DAYS, SIXTY_TO_NINETY_DAYS, SIX_TO_SEVEN_DAYS, TEN_TO_ELEVEN_DAYS, THIRTEEN_TO_FOURTEEN_DAYS, THIRTY_TO_FORTY_FIVE_DAYS, THREE_TO_FOUR_DAYS, TWELVE_TO_THIRTEEN_DAYS, TWENTY_ONE_TO_THIRTY_DAYS, TWO_TO_THREE_DAYS, UNKNOWN, UNSPECIFIED.
ConversionOrAdjustmentLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion. The allowed values are ADJUSTMENT_EIGHT_TO_NINE_DAYS, ADJUSTMENT_ELEVEN_TO_TWELVE_DAYS, ADJUSTMENT_FIVE_TO_SIX_DAYS, ADJUSTMENT_FORTY_FIVE_TO_SIXTY_DAYS, ADJUSTMENT_FOURTEEN_TO_TWENTY_ONE_DAYS, ADJUSTMENT_FOUR_TO_FIVE_DAYS, ADJUSTMENT_LESS_THAN_ONE_DAY, ADJUSTMENT_NINETY_TO_ONE_HUNDRED_AND_FORTY_FIVE_DAYS, ADJUSTMENT_NINE_TO_TEN_DAYS, ADJUSTMENT_ONE_TO_TWO_DAYS, ADJUSTMENT_SEVEN_TO_EIGHT_DAYS, ADJUSTMENT_SIXTY_TO_NINETY_DAYS, ADJUSTMENT_SIX_TO_SEVEN_DAYS, ADJUSTMENT_TEN_TO_ELEVEN_DAYS, ADJUSTMENT_THIRTEEN_TO_FOURTEEN_DAYS, ADJUSTMENT_THIRTY_TO_FORTY_FIVE_DAYS, ADJUSTMENT_THREE_TO_FOUR_DAYS, ADJUSTMENT_TWELVE_TO_THIRTEEN_DAYS, ADJUSTMENT_TWENTY_ONE_TO_THIRTY_DAYS, ADJUSTMENT_TWO_TO_THREE_DAYS, ADJUSTMENT_UNKNOWN, CONVERSION_EIGHT_TO_NINE_DAYS, CONVERSION_ELEVEN_TO_TWELVE_DAYS, CONVERSION_FIVE_TO_SIX_DAYS, CONVERSION_FORTY_FIVE_TO_SIXTY_DAYS, CONVERSION_FOURTEEN_TO_TWENTY_ONE_DAYS, CONVERSION_FOUR_TO_FIVE_DAYS, CONVERSION_LESS_THAN_ONE_DAY, CONVERSION_NINE_TO_TEN_DAYS, CONVERSION_ONE_TO_TWO_DAYS, CONVERSION_SEVEN_TO_EIGHT_DAYS, CONVERSION_SIXTY_TO_NINETY_DAYS, CONVERSION_SIX_TO_SEVEN_DAYS, CONVERSION_TEN_TO_ELEVEN_DAYS, CONVERSION_THIRTEEN_TO_FOURTEEN_DAYS, CONVERSION_THIRTY_TO_FORTY_FIVE_DAYS, CONVERSION_THREE_TO_FOUR_DAYS, CONVERSION_TWELVE_TO_THIRTEEN_DAYS, CONVERSION_TWENTY_ONE_TO_THIRTY_DAYS, CONVERSION_TWO_TO_THREE_DAYS, CONVERSION_UNKNOWN, UNKNOWN, UNSPECIFIED.
ConversionValueRulePrimaryDimension String SEGMENT Primary dimension of applied conversion value rules. NO_RULE_APPLIED shows the total recorded value of conversions that do not have a value rule applied. ORIGINAL shows the original value of conversions to which a value rule has been applied. GEO_LOCATION, DEVICE, AUDIENCE show the net adjustment after value rules were applied. The allowed values are AUDIENCE, DEVICE, GEO_LOCATION, MULTIPLE, NEW_VS_RETURNING_USER, NO_RULE_APPLIED, ORIGINAL, UNKNOWN, UNSPECIFIED.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Hour Int SEGMENT Hour of day as a number between 0 and 23, inclusive.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
NewVersusReturningCustomers String SEGMENT This is for segmenting conversions by whether the user is a new customer or a returning customer. This segmentation is typically used to measure the impact of customer acquisition goal. The allowed values are NEW, NEW_AND_HIGH_LTV, RETURNING, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
RecommendationType String SEGMENT Recommendation type. The allowed values are CALLOUT_ASSET, CALL_ASSET, CAMPAIGN_BUDGET, DISPLAY_EXPANSION_OPT_IN, DYNAMIC_IMAGE_EXTENSION_OPT_IN, ENHANCED_CPC_OPT_IN, FORECASTING_CAMPAIGN_BUDGET, FORECASTING_SET_TARGET_CPA, FORECASTING_SET_TARGET_ROAS, IMPROVE_PERFORMANCE_MAX_AD_STRENGTH, KEYWORD, KEYWORD_MATCH_TYPE, LOWER_TARGET_ROAS, MARGINAL_ROI_CAMPAIGN_BUDGET, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MIGRATE_DYNAMIC_SEARCH_ADS_CAMPAIGN_TO_PERFORMANCE_MAX, MOVE_UNUSED_BUDGET, OPTIMIZE_AD_ROTATION, PERFORMANCE_MAX_OPT_IN, RAISE_TARGET_CPA, RAISE_TARGET_CPA_BID_TOO_LOW, RESPONSIVE_SEARCH_AD, RESPONSIVE_SEARCH_AD_ASSET, RESPONSIVE_SEARCH_AD_IMPROVE_AD_STRENGTH, SEARCH_PARTNERS_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, SHOPPING_ADD_AGE_GROUP, SHOPPING_ADD_COLOR, SHOPPING_ADD_GENDER, SHOPPING_ADD_GTIN, SHOPPING_ADD_MORE_IDENTIFIERS, SHOPPING_ADD_PRODUCTS_TO_CAMPAIGN, SHOPPING_ADD_SIZE, SHOPPING_FIX_DISAPPROVED_PRODUCTS, SHOPPING_FIX_MERCHANT_CENTER_ACCOUNT_SUSPENSION_WARNING, SHOPPING_FIX_SUSPENDED_MERCHANT_CENTER_ACCOUNT, SHOPPING_MIGRATE_REGULAR_SHOPPING_CAMPAIGN_OFFERS_TO_PERFORMANCE_MAX, SHOPPING_TARGET_ALL_OFFERS, SITELINK_ASSET, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN, TEXT_AD, UNKNOWN, UNSPECIFIED, UPGRADE_LOCAL_CAMPAIGN_TO_PERFORMANCE_MAX, UPGRADE_SMART_SHOPPING_CAMPAIGN_TO_PERFORMANCE_MAX, USE_BROAD_MATCH_KEYWORD.
SkAdNetworkAdEventType String SEGMENT iOS Store Kit Ad Network ad event type. The allowed values are INTERACTION, UNAVAILABLE, UNKNOWN, UNSPECIFIED, VIEW.
SkAdNetworkAttributionCredit String SEGMENT iOS Store Kit Ad Network attribution credit The allowed values are CONTRIBUTED, UNAVAILABLE, UNKNOWN, UNSPECIFIED, WON.
SkAdNetworkCoarseConversionValue String SEGMENT iOS Store Kit Ad Network coarse conversion value. The allowed values are HIGH, LOW, MEDIUM, NONE, UNAVAILABLE, UNKNOWN, UNSPECIFIED.
SkAdNetworkConversionValue Long SEGMENT iOS Store Kit Ad Network conversion value. Null value means this segment is not applicable, for example, non-iOS campaign.
SkAdNetworkPostbackSequenceIndex Long SEGMENT iOS Store Kit Ad Network postback sequence index.
SkAdNetworkSourceAppSkAdNetworkSourceAppId String SEGMENT App ID where the ad that drove the iOS Store Kit Ad Network install was shown.
SkAdNetworkSourceDomain String SEGMENT Website where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or was not present in any postbacks sent by Apple.
SkAdNetworkSourceType String SEGMENT The source type where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or neither source domain nor source app were present in any postbacks sent by Apple. The allowed values are MOBILE_APPLICATION, UNAVAILABLE, UNKNOWN, UNSPECIFIED, WEBSITE.
SkAdNetworkUserType String SEGMENT iOS Store Kit Ad Network user type. The allowed values are NEW_INSTALLER, REINSTALLER, UNAVAILABLE, UNKNOWN, UNSPECIFIED.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignAsset

A link between a Campaign and an Asset.

Columns
Name Type Behavior Description
CampaignAssetAsset String ATTRIBUTE Immutable. The asset which is linked to the campaign.
CampaignAssetCampaign String ATTRIBUTE Immutable. The campaign to which the asset is linked.
CampaignAssetFieldType String ATTRIBUTE Immutable. Role that the asset takes under the linked campaign. Required. The allowed values are AD_IMAGE, BOOK_ON_GOOGLE, BUSINESS_LOGO, BUSINESS_NAME, CALL, CALLOUT, CALL_TO_ACTION_SELECTION, DESCRIPTION, HEADLINE, HOTEL_CALLOUT, HOTEL_PROPERTY, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MANDATORY_AD_TEXT, MARKETING_IMAGE, MEDIA_BUNDLE, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, VIDEO, YOUTUBE_VIDEO.
CampaignAssetPrimaryStatus String ATTRIBUTE Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain 'status' field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state. The allowed values are ELIGIBLE, LIMITED, NOT_ELIGIBLE, PAUSED, PENDING, REMOVED, UNKNOWN, UNSPECIFIED.
CampaignAssetPrimaryStatusDetails String ATTRIBUTE Output only. Provides the details of the primary status and its associated reasons.
CampaignAssetPrimaryStatusReasons String ATTRIBUTE Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity. The allowed values are ASSET_APPROVED_LABELED, ASSET_DISAPPROVED, ASSET_LINK_PAUSED, ASSET_LINK_REMOVED, ASSET_UNDER_REVIEW, UNKNOWN, UNSPECIFIED.
CampaignAssetResourceName String ATTRIBUTE Immutable. The resource name of the campaign asset. CampaignAsset resource names have the form: customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}
CampaignAssetSource String ATTRIBUTE Output only. Source of the campaign asset link. The allowed values are ADVERTISER, AUTOMATICALLY_CREATED, UNKNOWN, UNSPECIFIED.
CampaignAssetStatus String ATTRIBUTE Status of the campaign asset. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
PhoneCalls Long METRIC Number of offline phone calls.
PhoneImpressions Long METRIC Number of offline phone impressions.
PhoneThroughRate Double METRIC Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown anywhere above the organic search results.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
AssetInteractionTargetAsset String SEGMENT The asset resource name.
AssetInteractionTargetInteractionOnThisAsset Bool SEGMENT Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignAssetSet

CampaignAssetSet is the linkage between a campaign and an asset set. Adding a CampaignAssetSet links an asset set with a campaign.

Columns
Name Type Behavior Description
CampaignAssetSetAssetSet String ATTRIBUTE Immutable. The asset set which is linked to the campaign.
CampaignAssetSetCampaign String ATTRIBUTE Immutable. The campaign to which this asset set is linked.
CampaignAssetSetResourceName String ATTRIBUTE Immutable. The resource name of the campaign asset set. Asset set asset resource names have the form: customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}
CampaignAssetSetStatus String ATTRIBUTE Output only. The status of the campaign asset set asset. Read-only. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignAudienceView

A campaign audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated by campaign and audience criterion. This view only includes audiences attached at the campaign level.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
CampaignAudienceViewResourceName String ATTRIBUTE Output only. The resource name of the campaign audience view. Campaign audience view resource names have the form: customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
ActiveViewCpm Double METRIC Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr Double METRIC Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsByConversionDate Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsFromInteractionsValuePerInteraction Double METRIC The value of all conversions from interactions divided by the total number of interactions.
AllConversionsValue Double METRIC The value of all conversions.
AllConversionsValueByConversionDate Double METRIC The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllConversionsValuePerCost Double METRIC The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsByConversionDate Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValueByConversionDate Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
GmailForwards Long METRIC The number of times the ad was forwarded to someone else as a message.
GmailSaves Long METRIC The number of times someone has saved your Gmail ad to their inbox as a message.
GmailSecondaryClicks Long METRIC The number of clicks to the landing page on the expanded state of Gmail ads.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown anywhere above the organic search results.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerAllConversionsByConversionDate Double METRIC The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ValuePerConversionsByConversionDate Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
VideoQuartileP100Rate Double METRIC Percentage of impressions where the viewer watched all of your video.
VideoQuartileP25Rate Double METRIC Percentage of impressions where the viewer watched 25% of your video.
VideoQuartileP50Rate Double METRIC Percentage of impressions where the viewer watched 50% of your video.
VideoQuartileP75Rate Double METRIC Percentage of impressions where the viewer watched 75% of your video.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
HotelDateSelectionType String SEGMENT Hotel date selection type. The allowed values are DEFAULT_SELECTION, UNKNOWN, UNSPECIFIED, USER_SELECTED.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignBidModifier

Represents a bid-modifiable only criterion at the campaign level.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
CampaignBidModifierBidModifier Double ATTRIBUTE The modifier for the bid when the criterion matches.
CampaignBidModifierCampaign String ATTRIBUTE Output only. The campaign to which this criterion belongs.
CampaignBidModifierCriterionId Long ATTRIBUTE Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
CampaignBidModifierInteractionTypeType String ATTRIBUTE The interaction type. The allowed values are CALLS, UNKNOWN, UNSPECIFIED.
CampaignBidModifierResourceName String ATTRIBUTE Immutable. The resource name of the campaign bid modifier. Campaign bid modifier resource names have the form: customers/{customer_id}/campaignBidModifiers/{campaign_id}~{criterion_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignBudget

A campaign budget shared amongst various budget recommendation types.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
CampaignBudgetAlignedBiddingStrategyId Long ATTRIBUTE ID of the portfolio bidding strategy that this shared campaign budget is aligned with. When a bidding strategy and a campaign budget are aligned, they are attached to the same set of campaigns. After a campaign budget is aligned with a bidding strategy, campaigns that are added to the campaign budget must also use the aligned bidding strategy.
CampaignBudgetAmountMicros Long ATTRIBUTE The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount.
CampaignBudgetDeliveryMethod String ATTRIBUTE The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation. The allowed values are ACCELERATED, STANDARD, UNKNOWN, UNSPECIFIED.
CampaignBudgetExplicitlyShared Bool ATTRIBUTE Specifies whether the budget is explicitly shared. Defaults to true if unspecified in a create operation. If true, the budget was created with the purpose of sharing across one or more campaigns. If false, the budget was created with the intention of only being used with a single campaign. The budget's name and status will stay in sync with the campaign's name and status. Attempting to share the budget with a second campaign will result in an error. A non-shared budget can become an explicitly shared. The same operation must also assign the budget a name. A shared campaign budget can never become non-shared.
CampaignBudgetHasRecommendedBudget Bool ATTRIBUTE Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only.
CampaignBudgetId Long ATTRIBUTE Output only. The ID of the campaign budget. A campaign budget is created using the CampaignBudgetService create operation and is assigned a budget ID. A budget ID can be shared across different campaigns; the system will then allocate the campaign budget among different campaigns to get optimum results.
CampaignBudgetName String ATTRIBUTE The name of the campaign budget. When creating a campaign budget through CampaignBudgetService, every explicitly shared campaign budget must have a non-null, non-empty name. Campaign budgets that are not explicitly shared derive their name from the attached campaign's name. The length of this string must be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
CampaignBudgetPeriod String ATTRIBUTE Immutable. Period over which to spend the budget. Defaults to DAILY if not specified. The allowed values are CUSTOM_PERIOD, DAILY, UNKNOWN, UNSPECIFIED.
CampaignBudgetRecommendedBudgetAmountMicros Long ATTRIBUTE Output only. The recommended budget amount. If no recommendation is available, this will be set to the budget amount. Amount is specified in micros, where one million is equivalent to one currency unit. This field is read-only.
CampaignBudgetRecommendedBudgetEstimatedChangeWeeklyClicks Long ATTRIBUTE Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only.
CampaignBudgetRecommendedBudgetEstimatedChangeWeeklyCostMicros Long ATTRIBUTE Output only. The estimated change in weekly cost in micros if the recommended budget is applied. One million is equivalent to one currency unit. This field is read-only.
CampaignBudgetRecommendedBudgetEstimatedChangeWeeklyInteractions Long ATTRIBUTE Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only.
CampaignBudgetRecommendedBudgetEstimatedChangeWeeklyViews Long ATTRIBUTE Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only.
CampaignBudgetReferenceCount Long ATTRIBUTE Output only. The number of campaigns actively using the budget. This field is read-only.
CampaignBudgetResourceName String ATTRIBUTE Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: customers/{customer_id}/campaignBudgets/{campaign_budget_id}
CampaignBudgetStatus String ATTRIBUTE Output only. The status of this campaign budget. This field is read-only. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CampaignBudgetTotalAmountMicros Long ATTRIBUTE The lifetime amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit.
CampaignBudgetType String ATTRIBUTE Immutable. The type of the campaign budget. The allowed values are FIXED_CPA, LOCAL_SERVICES, SMART_CAMPAIGN, STANDARD, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
BudgetCampaignAssociationStatusCampaign String SEGMENT The campaign resource name.
BudgetCampaignAssociationStatusStatus String SEGMENT Budget campaign association status. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignConversionGoal

The biddability setting for the specified campaign only for all conversion actions with a matching category and origin.

Columns
Name Type Behavior Description
CampaignConversionGoalBiddable Bool ATTRIBUTE The biddability of the campaign conversion goal.
CampaignConversionGoalCampaign String ATTRIBUTE Immutable. The campaign with which this campaign conversion goal is associated.
CampaignConversionGoalCategory String ATTRIBUTE The conversion category of this campaign conversion goal. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
CampaignConversionGoalOrigin String ATTRIBUTE The conversion origin of this campaign conversion goal. The allowed values are APP, CALL_FROM_ADS, GOOGLE_HOSTED, STORE, UNKNOWN, UNSPECIFIED, WEBSITE, YOUTUBE_HOSTED.
CampaignConversionGoalResourceName String ATTRIBUTE Immutable. The resource name of the campaign conversion goal. Campaign conversion goal resource names have the form: customers/{customer_id}/campaignConversionGoals/{campaign_id}~{category}~{origin}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignCriterion

A campaign criterion.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
CampaignCriterionAdScheduleDayOfWeek String ATTRIBUTE Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
CampaignCriterionAdScheduleEndHour Int ATTRIBUTE Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
CampaignCriterionAdScheduleEndMinute String ATTRIBUTE Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations. The allowed values are FIFTEEN, FORTY_FIVE, THIRTY, UNKNOWN, UNSPECIFIED, ZERO.
CampaignCriterionAdScheduleStartHour Int ATTRIBUTE Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
CampaignCriterionAdScheduleStartMinute String ATTRIBUTE Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations. The allowed values are FIFTEEN, FORTY_FIVE, THIRTY, UNKNOWN, UNSPECIFIED, ZERO.
CampaignCriterionAgeRangeType String ATTRIBUTE Type of the age range. The allowed values are AGE_RANGE_18_24, AGE_RANGE_25_34, AGE_RANGE_35_44, AGE_RANGE_45_54, AGE_RANGE_55_64, AGE_RANGE_65_UP, AGE_RANGE_UNDETERMINED, UNKNOWN, UNSPECIFIED.
CampaignCriterionBidModifier String ATTRIBUTE The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type.
CampaignCriterionBrandListSharedSet String ATTRIBUTE Shared set resource name of the brand list.
CampaignCriterionCampaign String ATTRIBUTE Immutable. The campaign to which the criterion belongs.
CampaignCriterionCarrierCarrierConstant String ATTRIBUTE The Carrier constant resource name.
CampaignCriterionCombinedAudienceCombinedAudience String ATTRIBUTE The CombinedAudience resource name.
CampaignCriterionContentLabelType String ATTRIBUTE Content label type, required for CREATE operations. The allowed values are BELOW_THE_FOLD, EMBEDDED_VIDEO, JUVENILE, LIVE_STREAMING_VIDEO, PARKED_DOMAIN, PROFANITY, SEXUALLY_SUGGESTIVE, SOCIAL_ISSUES, TRAGEDY, UNKNOWN, UNSPECIFIED, VIDEO, VIDEO_NOT_YET_RATED, VIDEO_RATING_DV_G, VIDEO_RATING_DV_MA, VIDEO_RATING_DV_PG, VIDEO_RATING_DV_T.
CampaignCriterionCriterionId Long ATTRIBUTE Output only. The ID of the criterion. This field is ignored during mutate.
CampaignCriterionCustomAffinityCustomAffinity String ATTRIBUTE The CustomInterest resource name.
CampaignCriterionCustomAudienceCustomAudience String ATTRIBUTE The CustomAudience resource name.
CampaignCriterionDeviceType String ATTRIBUTE Type of the device. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
CampaignCriterionDisplayName String ATTRIBUTE Output only. The display name of the criterion. This field is ignored for mutates.
CampaignCriterionGenderType String ATTRIBUTE Type of the gender. The allowed values are FEMALE, MALE, UNDETERMINED, UNKNOWN, UNSPECIFIED.
CampaignCriterionIncomeRangeType String ATTRIBUTE Type of the income range. The allowed values are INCOME_RANGE_0_50, INCOME_RANGE_50_60, INCOME_RANGE_60_70, INCOME_RANGE_70_80, INCOME_RANGE_80_90, INCOME_RANGE_90_UP, INCOME_RANGE_UNDETERMINED, UNKNOWN, UNSPECIFIED.
CampaignCriterionIpBlockIpAddress String ATTRIBUTE The IP address of this IP block.
CampaignCriterionKeywordMatchType String ATTRIBUTE The match type of the keyword. The allowed values are BROAD, EXACT, PHRASE, UNKNOWN, UNSPECIFIED.
CampaignCriterionKeywordText String ATTRIBUTE The text of the keyword (at most 80 characters and 10 words).
CampaignCriterionKeywordThemeFreeFormKeywordTheme String ATTRIBUTE Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
CampaignCriterionKeywordThemeKeywordThemeConstant String ATTRIBUTE The resource name of a Smart Campaign keyword theme constant. keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}
CampaignCriterionLanguageLanguageConstant String ATTRIBUTE The language constant resource name.
CampaignCriterionListingScopeDimensions String ATTRIBUTE Scope of the campaign criterion.
CampaignCriterionLocalServiceIdServiceId String ATTRIBUTE The criterion resource name.
CampaignCriterionLocationGeoTargetConstant String ATTRIBUTE The geo target constant resource name.
CampaignCriterionLocationGroup String ATTRIBUTE Immutable. Location Group
CampaignCriterionLocationGroupEnableCustomerLevelLocationAssetSet Bool ATTRIBUTE Denotes that the latest customer level asset set is used for targeting. Used with radius and radius_units. Cannot be used with feed, geo target constants or feed item sets. When using asset sets, either this field or location_group_asset_sets should be specified. Both cannot be used at the same time. This can only be set in CREATE operations.
CampaignCriterionLocationGroupFeed String ATTRIBUTE Feed specifying locations for targeting. Cannot be set with AssetSet fields. This is required and must be set in CREATE operations.
CampaignCriterionMobileAppCategoryMobileAppCategoryConstant String ATTRIBUTE The mobile app category constant resource name.
CampaignCriterionMobileApplicationAppId String ATTRIBUTE A string that uniquely identifies a mobile application to Google Ads API. The format of this string is '{platform}-{platform_native_id}', where platform is '1' for iOS apps and '2' for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (for example, '476943146' for 'Flood-It! 2' whose App Store link is 'http://itunes.apple.com/us/app/flood-it!-2/id476943146'). For Android, this native identifier is the application's package name (for example, 'com.labpixies.colordrips' for 'Color Drips' given Google Play link 'https://play.google.com/store/apps/details?id=com.labpixies.colordrips'). A well formed app ID for Google Ads API would thus be '1-476943146' for iOS and '2-com.labpixies.colordrips' for Android. This field is required and must be set in CREATE operations.
CampaignCriterionMobileApplicationName String ATTRIBUTE Name of this mobile application.
CampaignCriterionMobileDeviceMobileDeviceConstant String ATTRIBUTE The mobile device constant resource name.
CampaignCriterionNegative Bool ATTRIBUTE Immutable. Whether to target (false) or exclude (true) the criterion.
CampaignCriterionOperatingSystemVersionOperatingSystemVersionConstant String ATTRIBUTE The operating system version constant resource name.
CampaignCriterionParentalStatusType String ATTRIBUTE Type of the parental status. The allowed values are NOT_A_PARENT, PARENT, UNDETERMINED, UNKNOWN, UNSPECIFIED.
CampaignCriterionPlacementUrl String ATTRIBUTE URL of the placement. For example, 'http://www.domain.com'.
CampaignCriterionProximityAddressCityName String ATTRIBUTE Name of the city.
CampaignCriterionProximityAddressCountryCode String ATTRIBUTE Country code.
CampaignCriterionProximityAddressPostalCode String ATTRIBUTE Postal code.
CampaignCriterionProximityAddressProvinceCode String ATTRIBUTE Province or state code.
CampaignCriterionProximityAddressProvinceName String ATTRIBUTE Province or state name.
CampaignCriterionProximityAddressStreetAddress String ATTRIBUTE Street address line 1.
CampaignCriterionProximityGeoPointLatitudeInMicroDegrees Int ATTRIBUTE Micro degrees for the latitude.
CampaignCriterionProximityGeoPointLongitudeInMicroDegrees Int ATTRIBUTE Micro degrees for the longitude.
CampaignCriterionProximityRadius Double ATTRIBUTE The radius of the proximity.
CampaignCriterionProximityRadiusUnits String ATTRIBUTE The unit of measurement of the radius. Default is KILOMETERS. The allowed values are KILOMETERS, MILES, UNKNOWN, UNSPECIFIED.
CampaignCriterionResourceName String ATTRIBUTE Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}
CampaignCriterionStatus String ATTRIBUTE The status of the criterion. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
CampaignCriterionTopicPath String ATTRIBUTE The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, 'Pets & Animals', 'Pets', 'Dogs' represents the 'Pets & Animals/Pets/Dogs' category.
CampaignCriterionTopicTopicConstant String ATTRIBUTE The Topic Constant resource name.
CampaignCriterionType String ATTRIBUTE Output only. The type of the criterion. The allowed values are AD_SCHEDULE, AGE_RANGE, APP_PAYMENT_MODEL, AUDIENCE, BRAND, BRAND_LIST, CARRIER, COMBINED_AUDIENCE, CONTENT_LABEL, CUSTOM_AFFINITY, CUSTOM_AUDIENCE, CUSTOM_INTENT, DEVICE, GENDER, INCOME_RANGE, IP_BLOCK, KEYWORD, KEYWORD_THEME, LANGUAGE, LISTING_GROUP, LISTING_SCOPE, LOCAL_SERVICE_ID, LOCATION, LOCATION_GROUP, MOBILE_APPLICATION, MOBILE_APP_CATEGORY, MOBILE_DEVICE, NEGATIVE_KEYWORD_LIST, OPERATING_SYSTEM_VERSION, PARENTAL_STATUS, PLACEMENT, PROXIMITY, SEARCH_THEME, TOPIC, UNKNOWN, UNSPECIFIED, USER_INTEREST, USER_LIST, WEBPAGE, YOUTUBE_CHANNEL, YOUTUBE_VIDEO.
CampaignCriterionUserInterestUserInterestCategory String ATTRIBUTE The UserInterest resource name.
CampaignCriterionUserListUserList String ATTRIBUTE The User List resource name.
CampaignCriterionWebpageConditions String ATTRIBUTE Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
CampaignCriterionWebpageCoveragePercentage Double ATTRIBUTE Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.
CampaignCriterionWebpageCriterionName String ATTRIBUTE The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
CampaignCriterionWebpageSampleSampleUrls String ATTRIBUTE Webpage sample URLs
CampaignCriterionYoutubeChannelChannelId String ATTRIBUTE The YouTube uploader channel ID or the channel code of a YouTube channel.
CampaignCriterionYoutubeVideoVideoId String ATTRIBUTE YouTube video ID as it appears on the YouTube watch page.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignCustomizer

A customizer value for the associated CustomizerAttribute at the Campaign level.

Columns
Name Type Behavior Description
CampaignCustomizerCampaign String ATTRIBUTE Immutable. The campaign to which the customizer attribute is linked.
CampaignCustomizerCustomizerAttribute String ATTRIBUTE Required. Immutable. The customizer attribute which is linked to the campaign.
CampaignCustomizerResourceName String ATTRIBUTE Immutable. The resource name of the campaign customizer. Campaign customizer resource names have the form: customers/{customer_id}/campaignCustomizers/{campaign_id}~{customizer_attribute_id}
CampaignCustomizerStatus String ATTRIBUTE Output only. The status of the campaign customizer. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CampaignCustomizerValueStringValue String ATTRIBUTE Required. Value to insert in creative text. Customizer values of all types are stored as string to make formatting unambiguous.
CampaignCustomizerValueType String ATTRIBUTE Required. The data type for the customizer value. It must match the attribute type. The string_value content must match the constraints associated with the type. The allowed values are NUMBER, PERCENT, PRICE, TEXT, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignDraft

A campaign draft.

Columns
Name Type Behavior Description
CampaignDraftBaseCampaign String ATTRIBUTE Immutable. The base campaign to which the draft belongs.
CampaignDraftDraftCampaign String ATTRIBUTE Output only. Resource name of the Campaign that results from overlaying the draft changes onto the base campaign. This field is read-only.
CampaignDraftDraftId Long ATTRIBUTE Output only. The ID of the draft. This field is read-only.
CampaignDraftHasExperimentRunning Bool ATTRIBUTE Output only. Whether there is an experiment based on this draft currently serving.
CampaignDraftLongRunningOperation String ATTRIBUTE Output only. The resource name of the long-running operation that can be used to poll for completion of draft promotion. This is only set if the draft promotion is in progress or finished.
CampaignDraftName String ATTRIBUTE The name of the campaign draft. This field is required and should not be empty when creating new campaign drafts. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
CampaignDraftResourceName String ATTRIBUTE Immutable. The resource name of the campaign draft. Campaign draft resource names have the form: customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}
CampaignDraftStatus String ATTRIBUTE Output only. The status of the campaign draft. This field is read-only. When a new campaign draft is added, the status defaults to PROPOSED. The allowed values are PROMOTED, PROMOTE_FAILED, PROMOTING, PROPOSED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignExtensionSetting

A campaign extension setting.

Columns
Name Type Behavior Description
CampaignExtensionSettingCampaign String ATTRIBUTE Immutable. The resource name of the campaign. The linked extension feed items will serve under this campaign. Campaign resource names have the form: customers/{customer_id}/campaigns/{campaign_id}
CampaignExtensionSettingDevice String ATTRIBUTE The device for which the extensions will serve. Optional. The allowed values are DESKTOP, MOBILE, UNKNOWN, UNSPECIFIED.
CampaignExtensionSettingExtensionFeedItems String ATTRIBUTE The resource names of the extension feed items to serve under the campaign. ExtensionFeedItem resource names have the form: customers/{customer_id}/extensionFeedItems/{feed_item_id}
CampaignExtensionSettingExtensionType String ATTRIBUTE Immutable. The extension type of the customer extension setting. The allowed values are AFFILIATE_LOCATION, APP, CALL, CALLOUT, HOTEL_CALLOUT, IMAGE, LOCATION, MESSAGE, NONE, PRICE, PROMOTION, SITELINK, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED.
CampaignExtensionSettingResourceName String ATTRIBUTE Immutable. The resource name of the campaign extension setting. CampaignExtensionSetting resource names have the form: customers/{customer_id}/campaignExtensionSettings/{campaign_id}~{extension_type}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignFeed

A campaign feed.

Columns
Name Type Behavior Description
CampaignFeedCampaign String ATTRIBUTE Immutable. The campaign to which the CampaignFeed belongs.
CampaignFeedFeed String ATTRIBUTE Immutable. The feed to which the CampaignFeed belongs.
CampaignFeedMatchingFunctionFunctionString String ATTRIBUTE String representation of the Function. Examples: 1. IDENTITY(true) or IDENTITY(false). All or no feed items served. 2. EQUALS(CONTEXT.DEVICE, 'Mobile') 3. IN(FEED_ITEM_ID, {1000001, 1000002, 1000003}) 4. CONTAINS_ANY(FeedAttribute[12345678, 0], {'Mars cruise', 'Venus cruise'}) 5. AND(IN(FEED_ITEM_ID, {10001, 10002}), EQUALS(CONTEXT.DEVICE, 'Mobile')) For more details, visit https://developers.google.com/google-ads/api/docs/extensions/feeds/matching-functions Note that because multiple strings may represent the same underlying function (whitespace and single versus double quotation marks, for example), the value returned may not be identical to the string sent in a mutate request.
CampaignFeedMatchingFunctionLeftOperands String ATTRIBUTE The operands on the left hand side of the equation. This is also the operand to be used for single operand expressions such as NOT.
CampaignFeedMatchingFunctionOperator String ATTRIBUTE Operator for a function. The allowed values are AND, CONTAINS_ANY, EQUALS, IDENTITY, IN, UNKNOWN, UNSPECIFIED.
CampaignFeedMatchingFunctionRightOperands String ATTRIBUTE The operands on the right hand side of the equation.
CampaignFeedPlaceholderTypes String ATTRIBUTE Indicates which placeholder types the feed may populate under the connected campaign. Required. The allowed values are AD_CUSTOMIZER, AFFILIATE_LOCATION, APP, CALL, CALLOUT, DYNAMIC_CUSTOM, DYNAMIC_EDUCATION, DYNAMIC_FLIGHT, DYNAMIC_HOTEL, DYNAMIC_JOB, DYNAMIC_LOCAL, DYNAMIC_REAL_ESTATE, DYNAMIC_TRAVEL, IMAGE, LOCATION, MESSAGE, PRICE, PROMOTION, SITELINK, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED.
CampaignFeedResourceName String ATTRIBUTE Immutable. The resource name of the campaign feed. Campaign feed resource names have the form: `customers/{customer_id}/campaignFeeds/{campaign_id}~{feed_id}
CampaignFeedStatus String ATTRIBUTE Output only. Status of the campaign feed. This field is read-only. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignGroup

A campaign group.

Columns
Name Type Behavior Description
CampaignGroupId Long ATTRIBUTE Output only. The ID of the campaign group.
CampaignGroupName String ATTRIBUTE The name of the campaign group. This field is required and should not be empty when creating new campaign groups. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
CampaignGroupResourceName String ATTRIBUTE Immutable. The resource name of the campaign group. Campaign group resource names have the form: customers/{customer_id}/campaignGroups/{campaign_group_id}
CampaignGroupStatus String ATTRIBUTE The status of the campaign group. When a new campaign group is added, the status defaults to ENABLED. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
AdDestinationType String SEGMENT Ad Destination type. The allowed values are APP_DEEP_LINK, APP_STORE, LEAD_FORM, LOCATION_LISTING, MAP_DIRECTIONS, MESSAGE, NOT_APPLICABLE, PHONE_CALL, UNKNOWN, UNMODELED_FOR_CONVERSIONS, UNSPECIFIED, WEBSITE, YOUTUBE.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
Hour Int SEGMENT Hour of day as a number between 0 and 23, inclusive.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignHourlyStatsReport

Campaign-level performance stats by Ad Network and Device. Hourly data is returned with a default date range of the last 7 days not including today.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ActiveViewCpm Double METRIC Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr Double METRIC Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE_SEARCH, YOUTUBE_WATCH.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
CampaignBaseCampaign String ATTRIBUTE Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
Hour Int SEGMENT Hour of day as a number between 0 and 23, inclusive.
CampaignId Long ATTRIBUTE Output only. The ID of the campaign.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.

CampaignLabel

Represents a relationship between a campaign and a label.

Columns
Name Type Behavior Description
CampaignLabelCampaign String ATTRIBUTE Immutable. The campaign to which the label is attached.
CampaignLabelLabel String ATTRIBUTE Immutable. The label assigned to the campaign.
CampaignLabelResourceName String ATTRIBUTE Immutable. Name of the resource. Campaign label resource names have the form: customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignLifecycleGoal

Campaign level customer lifecycle goal settings.

Columns
Name Type Behavior Description
CampaignLifecycleGoalCampaign String ATTRIBUTE Output only. The campaign where the goal is attached.
CampaignLifecycleGoalCustomerAcquisitionGoalSettingsOptimizationMode String ATTRIBUTE Output only. Customer acquisition optimization mode of this campaign. The allowed values are BID_HIGHER_FOR_NEW_CUSTOMER, TARGET_ALL_EQUALLY, TARGET_NEW_CUSTOMER, UNKNOWN, UNSPECIFIED.
CampaignLifecycleGoalCustomerAcquisitionGoalSettingsValueSettingsHighLifetimeValue Double ATTRIBUTE High lifetime value of the lifecycle goal. For example, for customer acquisition goal, high lifetime value is the incremental conversion value for new customers who are of high value. High lifetime value should be greater than value, if set. In current stage, high lifetime value feature is in beta and this field is read-only.
CampaignLifecycleGoalCustomerAcquisitionGoalSettingsValueSettingsValue Double ATTRIBUTE Value of the lifecycle goal. For example, for customer acquisition goal, value is the incremental conversion value for new customers who are not of high value.
CampaignLifecycleGoalResourceName String ATTRIBUTE Immutable. The resource name of the customer lifecycle goal of a campaign. customers/{customer_id}/campaignLifecycleGoal/{campaign_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignSearchTermInsight

A Campaign search term view. Historical data is available starting March 2023.

Columns
Name Type Behavior Description
CampaignSearchTermInsightCampaignId Long ATTRIBUTE Output only. The ID of the campaign.
CampaignSearchTermInsightCategoryLabel String ATTRIBUTE Output only. The label for the search category. An empty string denotes the catch-all category for search terms that didn't fit into another category.
CampaignSearchTermInsightId Long ATTRIBUTE Output only. The ID of the insight.
CampaignSearchTermInsightResourceName String ATTRIBUTE Output only. The resource name of the campaign level search term insight. Campaign level search term insight resource names have the form: customers/{customer_id}/campaignSearchTermInsights/{campaign_id}~{category_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
SearchVolume String METRIC Search volume range for a search term insight category.
AdGroup String SEGMENT Resource name of the ad group.
AssetGroup String SEGMENT Resource name of the asset group.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
SearchSubcategory String SEGMENT A search term subcategory. An empty string denotes the catch-all subcategory for search terms that didn't fit into another subcategory.
SearchTerm String SEGMENT A search term.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignSharedSet

CampaignSharedSets are used for managing the shared sets associated with a campaign.

Columns
Name Type Behavior Description
CampaignSharedSetCampaign String ATTRIBUTE Immutable. The campaign to which the campaign shared set belongs.
CampaignSharedSetResourceName String ATTRIBUTE Immutable. The resource name of the campaign shared set. Campaign shared set resource names have the form: customers/{customer_id}/campaignSharedSets/{campaign_id}~{shared_set_id}
CampaignSharedSetSharedSet String ATTRIBUTE Immutable. The shared set associated with the campaign. This may be a negative keyword shared set of another customer. This customer should be a manager of the other customer, otherwise the campaign shared set will exist but have no serving effect. Only negative keyword shared sets can be associated with Shopping campaigns. Only negative placement shared sets can be associated with Display mobile app campaigns.
CampaignSharedSetStatus String ATTRIBUTE Output only. The status of this campaign shared set. Read only. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignSimulation

A campaign simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively. * SEARCH - CPC_BID - UNIFORM * SEARCH - CPC_BID - SCALING * SEARCH - TARGET_CPA - UNIFORM * SEARCH - TARGET_CPA - SCALING * SEARCH - TARGET_ROAS - UNIFORM * SEARCH - TARGET_IMPRESSION_SHARE - UNIFORM * SEARCH - BUDGET - UNIFORM * SHOPPING - BUDGET - UNIFORM * SHOPPING - TARGET_ROAS - UNIFORM * MULTI_CHANNEL - TARGET_CPA - UNIFORM * DISCOVERY - TARGET_CPA - DEFAULT * DISPLAY - TARGET_CPA - UNIFORM * PERFORMANCE_MAX - TARGET_CPA - UNIFORM * PERFORMANCE_MAX - TARGET_ROAS - UNIFORM * PERFORMANCE_MAX - BUDGET - UNIFORM

Columns
Name Type Behavior Description
CampaignSimulationBudgetPointListPoints String ATTRIBUTE Projected metrics for a series of budget amounts.
CampaignSimulationCampaignId Long ATTRIBUTE Output only. Campaign ID of the simulation.
CampaignSimulationCpcBidPointListPoints String ATTRIBUTE Projected metrics for a series of CPC bid amounts.
CampaignSimulationEndDate Date ATTRIBUTE Output only. Last day on which the simulation is based, in YYYY-MM-DD format
CampaignSimulationModificationMethod String ATTRIBUTE Output only. How the simulation modifies the field. The allowed values are DEFAULT, SCALING, UNIFORM, UNKNOWN, UNSPECIFIED.
CampaignSimulationResourceName String ATTRIBUTE Output only. The resource name of the campaign simulation. Campaign simulation resource names have the form: customers/{customer_id}/campaignSimulations/{campaign_id}~{type}~{modification_method}~{start_date}~{end_date}
CampaignSimulationStartDate Date ATTRIBUTE Output only. First day on which the simulation is based, in YYYY-MM-DD format.
CampaignSimulationTargetCpaPointListPoints String ATTRIBUTE Projected metrics for a series of target CPA amounts.
CampaignSimulationTargetImpressionSharePointListPoints String ATTRIBUTE Projected metrics for a specific target impression share value.
CampaignSimulationTargetRoasPointListPoints String ATTRIBUTE Projected metrics for a series of target ROAS amounts.
CampaignSimulationType String ATTRIBUTE Output only. The field that the simulation modifies. The allowed values are BID_MODIFIER, BUDGET, CPC_BID, CPV_BID, PERCENT_CPC_BID, TARGET_CPA, TARGET_IMPRESSION_SHARE, TARGET_ROAS, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CampaignStatsReport

Campaign-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE_SEARCH, YOUTUBE_WATCH.
CampaignBaseCampaign String ATTRIBUTE Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
CampaignId Long ATTRIBUTE Output only. The ID of the campaign.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.

CarrierConstant

A carrier criterion that can be used in campaign targeting.

Columns
Name Type Behavior Description
CarrierConstantCountryCode String ATTRIBUTE Output only. The country code of the country where the carrier is located, for example, 'AR', 'FR', etc.
CarrierConstantId Long ATTRIBUTE Output only. The ID of the carrier criterion.
CarrierConstantName String ATTRIBUTE Output only. The full name of the carrier in English.
CarrierConstantResourceName String ATTRIBUTE Output only. The resource name of the carrier criterion. Carrier criterion resource names have the form: carrierConstants/{criterion_id}
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

ChangeEvent

Describes the granular change of returned resources of certain resource types. Changes made through the UI or API in the past 30 days are included. Previous and new values of the changed fields are shown. ChangeEvent could have up to 3 minutes delay to reflect a new change.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

The ChangeEvent table has extra limitations. You need to provide a time no older than 30 days, and a limit, for example:

SELECT ChangeEventCampaign, CustomerId FROM ChangeEvent WHERE ChangeEventChangeDateTime DURING LAST_14_DAYS LIMIT 10
Columns
Name Type Behavior Description
ChangeEventAdGroup String ATTRIBUTE Output only. The AdGroup affected by this change.
ChangeEventAsset String ATTRIBUTE Output only. The Asset affected by this change.
ChangeEventCampaign String ATTRIBUTE Output only. The Campaign affected by this change.
ChangeEventChangeDateTime Date ATTRIBUTE Output only. Time at which the change was committed on this resource.
ChangeEventChangeResourceName String ATTRIBUTE Output only. The Simply resource this change occurred on.
ChangeEventChangeResourceType String ATTRIBUTE Output only. The type of the changed resource. This dictates what resource will be set in old_resource and new_resource. The allowed values are AD, AD_GROUP, AD_GROUP_AD, AD_GROUP_ASSET, AD_GROUP_BID_MODIFIER, AD_GROUP_CRITERION, AD_GROUP_FEED, ASSET, ASSET_SET, ASSET_SET_ASSET, CAMPAIGN, CAMPAIGN_ASSET, CAMPAIGN_ASSET_SET, CAMPAIGN_BUDGET, CAMPAIGN_CRITERION, CAMPAIGN_FEED, CUSTOMER_ASSET, FEED, FEED_ITEM, UNKNOWN, UNSPECIFIED.
ChangeEventChangedFields String ATTRIBUTE Output only. A list of fields that are changed in the returned resource.
ChangeEventClientType String ATTRIBUTE Output only. Where the change was made through. The allowed values are GOOGLE_ADS_API, GOOGLE_ADS_AUTOMATED_RULE, GOOGLE_ADS_BULK_UPLOAD, GOOGLE_ADS_EDITOR, GOOGLE_ADS_MOBILE_APP, GOOGLE_ADS_RECOMMENDATIONS, GOOGLE_ADS_RECOMMENDATIONS_SUBSCRIPTION, GOOGLE_ADS_SCRIPTS, GOOGLE_ADS_WEB_CLIENT, INTERNAL_TOOL, OTHER, SEARCH_ADS_360_POST, SEARCH_ADS_360_SYNC, UNKNOWN, UNSPECIFIED.
ChangeEventFeed String ATTRIBUTE Output only. The Feed affected by this change.
ChangeEventFeedItem String ATTRIBUTE Output only. The FeedItem affected by this change.
ChangeEventNewResource String ATTRIBUTE Output only. The new resource after the change. Only changed fields will be populated.
ChangeEventOldResource String ATTRIBUTE Output only. The old resource before the change. Only changed fields will be populated.
ChangeEventResourceChangeOperation String ATTRIBUTE Output only. The operation on the changed resource. The allowed values are CREATE, REMOVE, UNKNOWN, UNSPECIFIED, UPDATE.
ChangeEventResourceName String ATTRIBUTE Output only. The resource name of the change event. Change event resource names have the form: customers/{customer_id}/changeEvents/{timestamp_micros}~{command_index}~{mutate_index}
ChangeEventUserEmail String ATTRIBUTE Output only. The email of the user who made this change.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

ChangeStatus

Describes the status of returned resource. ChangeStatus could have up to 3 minutes delay to reflect a new change.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

The ChangeStatus table has extra limitations. You need to provide a time no older than 30 days, and a limit, for example:

SELECT ChangeStatusCampaign, CustomerId FROM ChangeStatus WHERE ChangeStatusLastChangeDateTime DURING LAST_14_DAYS LIMIT 10
Columns
Name Type Behavior Description
ChangeStatusAdGroup String ATTRIBUTE Output only. The AdGroup affected by this change.
ChangeStatusAdGroupAd String ATTRIBUTE Output only. The AdGroupAd affected by this change.
ChangeStatusAdGroupAsset String ATTRIBUTE Output only. The AdGroupAsset affected by this change.
ChangeStatusAdGroupBidModifier String ATTRIBUTE Output only. The AdGroupBidModifier affected by this change.
ChangeStatusAdGroupCriterion String ATTRIBUTE Output only. The AdGroupCriterion affected by this change.
ChangeStatusAdGroupFeed String ATTRIBUTE Output only. The AdGroupFeed affected by this change.
ChangeStatusAsset String ATTRIBUTE Output only. The Asset affected by this change.
ChangeStatusCampaign String ATTRIBUTE Output only. The Campaign affected by this change.
ChangeStatusCampaignAsset String ATTRIBUTE Output only. The CampaignAsset affected by this change.
ChangeStatusCampaignCriterion String ATTRIBUTE Output only. The CampaignCriterion affected by this change.
ChangeStatusCampaignFeed String ATTRIBUTE Output only. The CampaignFeed affected by this change.
ChangeStatusCampaignSharedSet String ATTRIBUTE Output only. The CampaignSharedSet affected by this change.
ChangeStatusCombinedAudience String ATTRIBUTE Output only. The CombinedAudience affected by this change.
ChangeStatusCustomerAsset String ATTRIBUTE Output only. The CustomerAsset affected by this change.
ChangeStatusFeed String ATTRIBUTE Output only. The Feed affected by this change.
ChangeStatusFeedItem String ATTRIBUTE Output only. The FeedItem affected by this change.
ChangeStatusLastChangeDateTime Date ATTRIBUTE Output only. Time at which the most recent change has occurred on this resource.
ChangeStatusResourceName String ATTRIBUTE Output only. The resource name of the change status. Change status resource names have the form: customers/{customer_id}/changeStatus/{change_status_id}
ChangeStatusResourceStatus String ATTRIBUTE Output only. Represents the status of the changed resource. The allowed values are ADDED, CHANGED, REMOVED, UNKNOWN, UNSPECIFIED.
ChangeStatusResourceType String ATTRIBUTE Output only. Represents the type of the changed resource. This dictates what fields will be set. For example, for AD_GROUP, campaign and ad_group fields will be set. The allowed values are AD_GROUP, AD_GROUP_AD, AD_GROUP_ASSET, AD_GROUP_BID_MODIFIER, AD_GROUP_CRITERION, AD_GROUP_FEED, ASSET, CAMPAIGN, CAMPAIGN_ASSET, CAMPAIGN_CRITERION, CAMPAIGN_FEED, CAMPAIGN_SHARED_SET, COMBINED_AUDIENCE, CUSTOMER_ASSET, FEED, FEED_ITEM, SHARED_SET, UNKNOWN, UNSPECIFIED.
ChangeStatusSharedSet String ATTRIBUTE Output only. The SharedSet affected by this change.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

ClickView

A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-Search campaigns, metrics.clicks represents the number of valid and invalid interactions. Queries including ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Queries to ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.

SELECT * FROM ClickView WHERE Date DURING Yesterday
Columns
Name Type Behavior Description
ClickViewAdGroupAd String ATTRIBUTE Output only. The associated ad.
ClickViewAreaOfInterestCity String ATTRIBUTE The city location criterion associated with the impression.
ClickViewAreaOfInterestCountry String ATTRIBUTE The country location criterion associated with the impression.
ClickViewAreaOfInterestMetro String ATTRIBUTE The metro location criterion associated with the impression.
ClickViewAreaOfInterestMostSpecific String ATTRIBUTE The most specific location criterion associated with the impression.
ClickViewAreaOfInterestRegion String ATTRIBUTE The region location criterion associated with the impression.
ClickViewCampaignLocationTarget String ATTRIBUTE Output only. The associated campaign location target, if one exists.
ClickViewGclid String ATTRIBUTE Output only. The Google Click ID.
ClickViewKeyword String ATTRIBUTE Output only. The associated keyword, if one exists and the click corresponds to the SEARCH channel.
ClickViewKeywordInfoMatchType String ATTRIBUTE The match type of the keyword. The allowed values are BROAD, EXACT, PHRASE, UNKNOWN, UNSPECIFIED.
ClickViewKeywordInfoText String ATTRIBUTE The text of the keyword (at most 80 characters and 10 words).
ClickViewLocationOfPresenceCity String ATTRIBUTE The city location criterion associated with the impression.
ClickViewLocationOfPresenceCountry String ATTRIBUTE The country location criterion associated with the impression.
ClickViewLocationOfPresenceMetro String ATTRIBUTE The metro location criterion associated with the impression.
ClickViewLocationOfPresenceMostSpecific String ATTRIBUTE The most specific location criterion associated with the impression.
ClickViewLocationOfPresenceRegion String ATTRIBUTE The region location criterion associated with the impression.
ClickViewPageNumber Long ATTRIBUTE Output only. Page number in search results where the ad was shown.
ClickViewResourceName String ATTRIBUTE Output only. The resource name of the click view. Click view resource names have the form: customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}
ClickViewUserList String ATTRIBUTE Output only. The associated user list, if one exists.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Clicks Long METRIC The number of clicks.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

ClickViewFilteredReport

A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-Search campaigns, metrics.clicks represents the number of valid and invalid interactions. Queries including ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.

Columns
Name Type Behavior Description
ClickViewAdGroupAd String ATTRIBUTE Output only. The associated ad.
ClickViewAreaOfInterestCity String ATTRIBUTE The city location criterion associated with the impression.
ClickViewAreaOfInterestCountry String ATTRIBUTE The conuntry location criterion associated with the impression.
ClickViewAreaOfInterestMetro String ATTRIBUTE The metro location criterion associated with the impression.
ClickViewAreaOfInterestMostSpecific String ATTRIBUTE The most specific location criterion associated with the impression.
ClickViewAreaOfInterestRegion String ATTRIBUTE The region location criterion associated with the impression.
ClickViewCampaignLocationTarget String ATTRIBUTE Output only. The associated campaign location target, if one exists.
ClickViewGclid String ATTRIBUTE Output only. The Google Click ID.
ClickViewKeyword String ATTRIBUTE Output only. The associated keyword, if one exists and the click corresponds to the SEARCH channel.
ClickViewKeywordInfoMatchType String ATTRIBUTE The match type of the keyword. The allowed values are BROAD, EXACT, PHRASE, UNKNOWN, UNSPECIFIED.
ClickViewKeywordInfoText String ATTRIBUTE The text of the keyword (at most 80 characters and 10 words).
ClickViewLocationOfPresenceCity String ATTRIBUTE The city location criterion associated with the impression.
ClickViewLocationOfPresenceCountry String ATTRIBUTE The country location criterion associated with the impression.
ClickViewLocationOfPresenceMetro String ATTRIBUTE The metro location criterion associated with the impression.
ClickViewLocationOfPresenceMostSpecific String ATTRIBUTE The most specific location criterion associated with the impression.
ClickViewLocationOfPresenceRegion String ATTRIBUTE The region location criterion associated with the impression.
ClickViewPageNumber Long ATTRIBUTE Output only. Page number in search results where the ad was shown.
ClickViewResourceName String ATTRIBUTE Output only. The resource name of the click view. Click view resource names have the form: customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}
ClickViewUserList String ATTRIBUTE Output only. The associated user list, if one exists.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Clicks Long METRIC The number of clicks.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE_SEARCH, YOUTUBE_WATCH.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CombinedAudience

Describe a resource for combined audiences which includes different audiences.

Columns
Name Type Behavior Description
CombinedAudienceDescription String ATTRIBUTE Output only. Description of this combined audience.
CombinedAudienceId Long ATTRIBUTE Output only. ID of the combined audience.
CombinedAudienceName String ATTRIBUTE Output only. Name of the combined audience. It should be unique across all combined audiences.
CombinedAudienceResourceName String ATTRIBUTE Immutable. The resource name of the combined audience. Combined audience names have the form: customers/{customer_id}/combinedAudience/{combined_audience_id}
CombinedAudienceStatus String ATTRIBUTE Output only. Status of this combined audience. Indicates whether the combined audience is enabled or removed. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

ConversionAction

A conversion action.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
ConversionActionAppId String ATTRIBUTE App ID for an app conversion action.
ConversionActionAttributionModelSettingsAttributionModel String ATTRIBUTE The attribution model type of this conversion action. The allowed values are EXTERNAL, GOOGLE_ADS_LAST_CLICK, GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN, GOOGLE_SEARCH_ATTRIBUTION_FIRST_CLICK, GOOGLE_SEARCH_ATTRIBUTION_LINEAR, GOOGLE_SEARCH_ATTRIBUTION_POSITION_BASED, GOOGLE_SEARCH_ATTRIBUTION_TIME_DECAY, UNKNOWN, UNSPECIFIED.
ConversionActionAttributionModelSettingsDataDrivenModelStatus String ATTRIBUTE Output only. The status of the data-driven attribution model for the conversion action. The allowed values are AVAILABLE, EXPIRED, NEVER_GENERATED, STALE, UNKNOWN, UNSPECIFIED.
ConversionActionCategory String ATTRIBUTE The category of conversions reported for this conversion action. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionClickThroughLookbackWindowDays Long ATTRIBUTE The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event.
ConversionActionCountingType String ATTRIBUTE How to count conversion events for the conversion action. The allowed values are MANY_PER_CLICK, ONE_PER_CLICK, UNKNOWN, UNSPECIFIED.
ConversionActionFirebaseSettingsEventName String ATTRIBUTE Output only. The event name of a Firebase conversion.
ConversionActionFirebaseSettingsProjectId String ATTRIBUTE Output only. The Firebase project ID of the conversion.
ConversionActionFirebaseSettingsPropertyId Long ATTRIBUTE Output only. The GA property ID of the conversion.
ConversionActionFirebaseSettingsPropertyName String ATTRIBUTE Output only. The GA property name of the conversion.
ConversionActionGoogleAnalytics4SettingsEventName String ATTRIBUTE Output only. The name of the GA 4 event.
ConversionActionGoogleAnalytics4SettingsPropertyId Long ATTRIBUTE Output only. The ID of the GA 4 property.
ConversionActionGoogleAnalytics4SettingsPropertyName String ATTRIBUTE Output only. The name of the GA 4 property.
ConversionActionId Long ATTRIBUTE Output only. The ID of the conversion action.
ConversionActionIncludeInConversionsMetric Bool ATTRIBUTE Whether this conversion action should be included in the 'conversions' metric.
ConversionActionMobileAppVendor String ATTRIBUTE Output only. Mobile app vendor for an app conversion action. The allowed values are APPLE_APP_STORE, GOOGLE_APP_STORE, UNKNOWN, UNSPECIFIED.
ConversionActionName String ATTRIBUTE The name of the conversion action. This field is required and should not be empty when creating new conversion actions.
ConversionActionOrigin String ATTRIBUTE Output only. The conversion origin of this conversion action. The allowed values are APP, CALL_FROM_ADS, GOOGLE_HOSTED, STORE, UNKNOWN, UNSPECIFIED, WEBSITE, YOUTUBE_HOSTED.
ConversionActionOwnerCustomer String ATTRIBUTE Output only. The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.
ConversionActionPhoneCallDurationSeconds Long ATTRIBUTE The phone call duration in seconds after which a conversion should be reported for this conversion action. The value must be between 0 and 10000, inclusive.
ConversionActionPrimaryForGoal Bool ATTRIBUTE If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional.
ConversionActionResourceName String ATTRIBUTE Immutable. The resource name of the conversion action. Conversion action resource names have the form: customers/{customer_id}/conversionActions/{conversion_action_id}
ConversionActionStatus String ATTRIBUTE The status of this conversion action for conversion event accrual. The allowed values are ENABLED, HIDDEN, REMOVED, UNKNOWN, UNSPECIFIED.
ConversionActionTagSnippets String ATTRIBUTE Output only. The snippets used for tracking conversions.
ConversionActionThirdPartyAppAnalyticsSettingsEventName String ATTRIBUTE Output only. The event name of a third-party app analytics conversion.
ConversionActionThirdPartyAppAnalyticsSettingsProviderName String ATTRIBUTE Output only. Name of the third-party app analytics provider.
ConversionActionType String ATTRIBUTE Immutable. The type of this conversion action. The allowed values are AD_CALL, ANDROID_APP_PRE_REGISTRATION, ANDROID_INSTALLS_ALL_OTHER_APPS, CLICK_TO_CALL, FIREBASE_ANDROID_CUSTOM, FIREBASE_ANDROID_FIRST_OPEN, FIREBASE_ANDROID_IN_APP_PURCHASE, FIREBASE_IOS_CUSTOM, FIREBASE_IOS_FIRST_OPEN, FIREBASE_IOS_IN_APP_PURCHASE, FLOODLIGHT_ACTION, FLOODLIGHT_TRANSACTION, GOOGLE_ANALYTICS_4_CUSTOM, GOOGLE_ANALYTICS_4_PURCHASE, GOOGLE_HOSTED, GOOGLE_PLAY_DOWNLOAD, GOOGLE_PLAY_IN_APP_PURCHASE, LEAD_FORM_SUBMIT, SALESFORCE, SEARCH_ADS_360, SMART_CAMPAIGN_AD_CLICKS_TO_CALL, SMART_CAMPAIGN_MAP_CLICKS_TO_CALL, SMART_CAMPAIGN_MAP_DIRECTIONS, SMART_CAMPAIGN_TRACKED_CALLS, STORE_SALES, STORE_SALES_DIRECT_UPLOAD, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS_ANDROID_CUSTOM, THIRD_PARTY_APP_ANALYTICS_ANDROID_FIRST_OPEN, THIRD_PARTY_APP_ANALYTICS_ANDROID_IN_APP_PURCHASE, THIRD_PARTY_APP_ANALYTICS_IOS_CUSTOM, THIRD_PARTY_APP_ANALYTICS_IOS_FIRST_OPEN, THIRD_PARTY_APP_ANALYTICS_IOS_IN_APP_PURCHASE, UNIVERSAL_ANALYTICS_GOAL, UNIVERSAL_ANALYTICS_TRANSACTION, UNKNOWN, UNSPECIFIED, UPLOAD_CALLS, UPLOAD_CLICKS, WEBPAGE, WEBPAGE_CODELESS, WEBSITE_CALL.
ConversionActionValueSettingsAlwaysUseDefaultValue Bool ATTRIBUTE Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.
ConversionActionValueSettingsDefaultCurrencyCode String ATTRIBUTE The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.
ConversionActionValueSettingsDefaultValue Double ATTRIBUTE The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.
ConversionActionViewThroughLookbackWindowDays Long ATTRIBUTE The maximum number of days which may elapse between an impression and a conversion without an interaction.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsValue Double METRIC The value of all conversions.
ConversionLastConversionDate Date METRIC The date of the most recent conversion for this conversion action. The date is in the customer's time zone.
ConversionLastReceivedRequestDateTime Date METRIC The last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads. This firing event may not have been the result of an attributable conversion (for example, because the tag was fired from a browser that did not previously click an ad from an appropriate advertiser). The date/time is in the customer's time zone.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

ConversionCustomVariable

A conversion custom variable See 'About custom variables for conversions' at https://support.google.com/google-ads/answer/9964350

Columns
Name Type Behavior Description
ConversionCustomVariableId Long ATTRIBUTE Output only. The ID of the conversion custom variable.
ConversionCustomVariableName String ATTRIBUTE Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.
ConversionCustomVariableOwnerCustomer String ATTRIBUTE Output only. The resource name of the customer that owns the conversion custom variable.
ConversionCustomVariableResourceName String ATTRIBUTE Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form: customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}
ConversionCustomVariableStatus String ATTRIBUTE The status of the conversion custom variable for conversion event accrual. The allowed values are ACTIVATION_NEEDED, ENABLED, PAUSED, UNKNOWN, UNSPECIFIED.
ConversionCustomVariableTag String ATTRIBUTE Required. Immutable. The tag of the conversion custom variable. It is used in the event snippet and sent to Google Ads along with conversion pings. For conversion uploads in Google Ads API, the resource name of the conversion custom variable is used. Tag should be unique. The maximum size of tag is 100 bytes. There should not be any extra spaces before and after. Currently only lowercase letters, numbers and underscores are allowed in the tag.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

ConversionGoalCampaignConfig

Conversion goal settings for a Campaign.

Columns
Name Type Behavior Description
ConversionGoalCampaignConfigCampaign String ATTRIBUTE Immutable. The campaign with which this conversion goal campaign config is associated.
ConversionGoalCampaignConfigCustomConversionGoal String ATTRIBUTE The custom conversion goal the campaign is using for optimization.
ConversionGoalCampaignConfigGoalConfigLevel String ATTRIBUTE The level of goal config the campaign is using. The allowed values are CAMPAIGN, CUSTOMER, UNKNOWN, UNSPECIFIED.
ConversionGoalCampaignConfigResourceName String ATTRIBUTE Immutable. The resource name of the conversion goal campaign config. Conversion goal campaign config resource names have the form: customers/{customer_id}/conversionGoalCampaignConfigs/{campaign_id}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

ConversionValueRule

A conversion value rule

Columns
Name Type Behavior Description
ConversionValueRuleActionOperation String ATTRIBUTE Specifies applied operation. The allowed values are ADD, MULTIPLY, SET, UNKNOWN, UNSPECIFIED.
ConversionValueRuleActionValue Double ATTRIBUTE Specifies applied value.
ConversionValueRuleAudienceConditionUserInterests String ATTRIBUTE User Interests.
ConversionValueRuleAudienceConditionUserLists String ATTRIBUTE User Lists. The Similar Audiences sunset starts May 2023. Refer to https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html for other options.
ConversionValueRuleDeviceConditionDeviceTypes String ATTRIBUTE Value for device type condition. The allowed values are DESKTOP, MOBILE, TABLET, UNKNOWN, UNSPECIFIED.
ConversionValueRuleGeoLocationConditionExcludedGeoMatchType String ATTRIBUTE Excluded Geo location match type. The allowed values are ANY, LOCATION_OF_PRESENCE, UNKNOWN, UNSPECIFIED.
ConversionValueRuleGeoLocationConditionExcludedGeoTargetConstants String ATTRIBUTE Geo locations that advertisers want to exclude.
ConversionValueRuleGeoLocationConditionGeoMatchType String ATTRIBUTE Included Geo location match type. The allowed values are ANY, LOCATION_OF_PRESENCE, UNKNOWN, UNSPECIFIED.
ConversionValueRuleGeoLocationConditionGeoTargetConstants String ATTRIBUTE Geo locations that advertisers want to include.
ConversionValueRuleId Long ATTRIBUTE Output only. The ID of the conversion value rule.
ConversionValueRuleOwnerCustomer String ATTRIBUTE Output only. The resource name of the conversion value rule's owner customer. When the value rule is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
ConversionValueRuleResourceName String ATTRIBUTE Immutable. The resource name of the conversion value rule. Conversion value rule resource names have the form: customers/{customer_id}/conversionValueRules/{conversion_value_rule_id}
ConversionValueRuleStatus String ATTRIBUTE The status of the conversion value rule. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

ConversionValueRuleSet

A conversion value rule set

Columns
Name Type Behavior Description
ConversionValueRuleSetAttachmentType String ATTRIBUTE Immutable. Defines the scope where the conversion value rule set is attached. The allowed values are CAMPAIGN, CUSTOMER, UNKNOWN, UNSPECIFIED.
ConversionValueRuleSetCampaign String ATTRIBUTE The resource name of the campaign when the conversion value rule set is attached to a campaign.
ConversionValueRuleSetConversionActionCategories String ATTRIBUTE Immutable. The conversion action categories of the conversion value rule set. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionValueRuleSetConversionValueRules String ATTRIBUTE Resource names of rules within the rule set.
ConversionValueRuleSetDimensions String ATTRIBUTE Defines dimensions for Value Rule conditions. The condition types of value rules within this value rule set must be of these dimensions. The first entry in this list is the primary dimension of the included value rules. When using value rule primary dimension segmentation, conversion values will be segmented into the values adjusted by value rules and the original values, if some value rules apply. The allowed values are AUDIENCE, DEVICE, GEO_LOCATION, NO_CONDITION, UNKNOWN, UNSPECIFIED.
ConversionValueRuleSetId Long ATTRIBUTE Output only. The ID of the conversion value rule set.
ConversionValueRuleSetOwnerCustomer String ATTRIBUTE Output only. The resource name of the conversion value rule set's owner customer. When the value rule set is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
ConversionValueRuleSetResourceName String ATTRIBUTE Immutable. The resource name of the conversion value rule set. Conversion value rule set resource names have the form: customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}
ConversionValueRuleSetStatus String ATTRIBUTE Output only. The status of the conversion value rule set. ** Read-only ** The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CurrencyConstant

A currency constant.

Columns
Name Type Behavior Description
CurrencyConstantBillableUnitMicros Long ATTRIBUTE Output only. The billable unit for this currency. Billed amounts should be multiples of this value.
CurrencyConstantCode String ATTRIBUTE Output only. ISO 4217 three-letter currency code, for example, 'USD'
CurrencyConstantName String ATTRIBUTE Output only. Full English name of the currency.
CurrencyConstantResourceName String ATTRIBUTE Output only. The resource name of the currency constant. Currency constant resource names have the form: currencyConstants/{code}
CurrencyConstantSymbol String ATTRIBUTE Output only. Standard symbol for describing this currency, for example, '$' for US Dollars.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CustomAudience

A custom audience. This is a list of users by interest.

Columns
Name Type Behavior Description
CustomAudienceDescription String ATTRIBUTE Description of this custom audience.
CustomAudienceId Long ATTRIBUTE Output only. ID of the custom audience.
CustomAudienceMembers String ATTRIBUTE List of custom audience members that this custom audience is composed of. Members can be added during CustomAudience creation. If members are presented in UPDATE operation, existing members will be overridden.
CustomAudienceName String ATTRIBUTE Name of the custom audience. It should be unique for all custom audiences created by a customer. This field is required for creating operations.
CustomAudienceResourceName String ATTRIBUTE Immutable. The resource name of the custom audience. Custom audience resource names have the form: customers/{customer_id}/customAudiences/{custom_audience_id}
CustomAudienceStatus String ATTRIBUTE Output only. Status of this custom audience. Indicates whether the custom audience is enabled or removed. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomAudienceType String ATTRIBUTE Type of the custom audience. ('INTEREST' OR 'PURCHASE_INTENT' is not allowed for newly created custom audience but kept for existing audiences) The allowed values are AUTO, INTEREST, PURCHASE_INTENT, SEARCH, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CustomConversionGoal

Custom conversion goal that can make arbitrary conversion actions biddable.

Columns
Name Type Behavior Description
CustomConversionGoalConversionActions String ATTRIBUTE Conversion actions that the custom conversion goal makes biddable.
CustomConversionGoalId Long ATTRIBUTE Immutable. The ID for this custom conversion goal.
CustomConversionGoalName String ATTRIBUTE The name for this custom conversion goal.
CustomConversionGoalResourceName String ATTRIBUTE Immutable. The resource name of the custom conversion goal. Custom conversion goal resource names have the form: customers/{customer_id}/customConversionGoals/{goal_id}
CustomConversionGoalStatus String ATTRIBUTE The status of the custom conversion goal. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

Customer

A customer.

Table Specific Information
Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns
Name Type Behavior Description
CustomerAutoTaggingEnabled Bool ATTRIBUTE Whether auto-tagging is enabled for the customer.
CustomerCallReportingSettingCallConversionAction String ATTRIBUTE Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true.
CustomerCallReportingSettingCallConversionReportingEnabled Bool ATTRIBUTE Whether to enable call conversion reporting.
CustomerCallReportingSettingCallReportingEnabled Bool ATTRIBUTE Enable reporting of phone call events by redirecting them through Google System.
CustomerConversionTrackingSettingAcceptedCustomerDataTerms Bool ATTRIBUTE Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.
CustomerConversionTrackingSettingConversionTrackingId Long ATTRIBUTE Output only. The conversion tracking ID used for this account. This ID doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
CustomerConversionTrackingSettingConversionTrackingStatus String ATTRIBUTE Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request. The allowed values are CONVERSION_TRACKING_MANAGED_BY_ANOTHER_MANAGER, CONVERSION_TRACKING_MANAGED_BY_SELF, CONVERSION_TRACKING_MANAGED_BY_THIS_MANAGER, NOT_CONVERSION_TRACKED, UNKNOWN, UNSPECIFIED.
CustomerConversionTrackingSettingCrossAccountConversionTrackingId Long ATTRIBUTE Output only. The conversion tracking ID of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.
CustomerConversionTrackingSettingEnhancedConversionsForLeadsEnabled Bool ATTRIBUTE Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.
CustomerConversionTrackingSettingGoogleAdsConversionCustomer String ATTRIBUTE Output only. The resource name of the customer where conversions are created and managed. This field is read-only.
CustomerCurrencyCode String ATTRIBUTE Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
CustomerCustomerAgreementSettingAcceptedLeadFormTerms Bool ATTRIBUTE Output only. Whether the customer has accepted lead form term of service.
CustomerDescriptiveName String ATTRIBUTE Optional, non-unique descriptive name of the customer.
CustomerFinalUrlSuffix String ATTRIBUTE The URL template for appending params to the final URL. Only mutable in an update operation.
CustomerHasPartnersBadge Bool ATTRIBUTE Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
CustomerImageAssetAutoMigrationDone Bool ATTRIBUTE Output only. True if feed based image has been migrated to asset based image.
CustomerImageAssetAutoMigrationDoneDateTime Datetime ATTRIBUTE Output only. Timestamp of migration from feed based image to asset base image in yyyy-MM-dd HH🇲🇲ss format.
CustomerLocalServicesSettingsGranularInsuranceStatuses String ATTRIBUTE Output only. A read-only list of geo vertical level insurance statuses.
CustomerLocalServicesSettingsGranularLicenseStatuses String ATTRIBUTE Output only. A read-only list of geo vertical level license statuses.
CustomerLocationAssetAutoMigrationDone Bool ATTRIBUTE Output only. True if feed based location has been migrated to asset based location.
CustomerLocationAssetAutoMigrationDoneDateTime Datetime ATTRIBUTE Output only. Timestamp of migration from feed based location to asset base location in yyyy-MM-dd HH🇲🇲ss format.
CustomerManager Bool ATTRIBUTE Output only. Whether the customer is a manager.
CustomerOptimizationScore Double ATTRIBUTE Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See 'About optimization score' at https://support.google.com/google-ads/answer/9061546. This field is read-only.
CustomerOptimizationScoreWeight Double ATTRIBUTE Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only.
CustomerPayPerConversionEligibilityFailureReasons String ATTRIBUTE Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only. The allowed values are ANALYSIS_NOT_COMPLETE, AVERAGE_DAILY_SPEND_TOO_HIGH, CONVERSION_LAG_TOO_HIGH, HAS_CAMPAIGN_WITH_SHARED_BUDGET, HAS_UPLOAD_CLICKS_CONVERSION, NOT_ENOUGH_CONVERSIONS, OTHER, UNKNOWN, UNSPECIFIED.
CustomerRemarketingSettingGoogleGlobalSiteTag String ATTRIBUTE Output only. The Google tag.
CustomerResourceName String ATTRIBUTE Immutable. The resource name of the customer. Customer resource names have the form: customers/{customer_id}
CustomerStatus String ATTRIBUTE Output only. The status of the customer. The allowed values are CANCELED, CLOSED, ENABLED, SUSPENDED, UNKNOWN, UNSPECIFIED.
CustomerTestAccount Bool ATTRIBUTE Output only. Whether the customer is a test account.
CustomerTimeZone String ATTRIBUTE Immutable. The local timezone ID of the customer.
CustomerTrackingUrlTemplate String ATTRIBUTE The URL template for constructing a tracking URL out of parameters. Only mutable in an update operation.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
ActiveViewCpm Double METRIC Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr Double METRIC Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
ActiveViewImpressions Long METRIC A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability Double METRIC The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros Long METRIC The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions Long METRIC The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability Double METRIC The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsByConversionDate Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsFromLocationAssetClickToCall Double METRIC Number of call button clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetDirections Double METRIC Number of driving directions clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetMenu Double METRIC Number of menu link clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetOrder Double METRIC Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetOtherEngagement Double METRIC Number of other types of local action clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetStoreVisits Double METRIC Estimated number of visits to the store after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsFromLocationAssetWebsite Double METRIC Number of website URL clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
AllConversionsValue Double METRIC The value of all conversions.
AllConversionsValueByConversionDate Double METRIC The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
AllNewCustomerLifetimeValue Double METRIC All of new customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for both biddable and non-biddable conversions. If your campaign has adopted the customer acquisition goal and selected 'bid higher for new customers', these values will be included in 'all_conversions_value'. See https://support.google.com/google-ads/answer/12080169 for more details.
AverageCartSize Double METRIC Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
AverageOrderValueMicros Long METRIC Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is \(15 = (\)10 + $15 + $20)/3. This metric is only available if you report conversions with cart data.
Clicks Long METRIC The number of clicks.
ContentBudgetLostImpressionShare Double METRIC The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
ContentImpressionShare Double METRIC The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
ContentRankLostImpressionShare Double METRIC The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsByConversionDate Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValueByConversionDate Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostOfGoodsSoldMicros Long METRIC Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
CrossSellCostOfGoodsSoldMicros Long METRIC Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data.
CrossSellGrossProfitMicros Long METRIC Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data.
CrossSellRevenueMicros Long METRIC Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data.
CrossSellUnitsSold Double METRIC Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EligibleImpressionsFromLocationAssetStoreReach Long METRIC Number of impressions in which the store location was shown or the location was used for targeting. This measure is coming from Asset based location.
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
GrossProfitMargin Double METRIC Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced \(20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = (\)10 - \(3)/\)10 x 100%. This metric is only available if you report conversions with cart data.
GrossProfitMicros Long METRIC Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
InvalidClickRate Double METRIC The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
InvalidClicks Long METRIC Number of clicks Google considers illegitimate and doesn't charge you for.
LeadCostOfGoodsSoldMicros Long METRIC Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data.
LeadGrossProfitMicros Long METRIC Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data.
LeadRevenueMicros Long METRIC Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data.
LeadUnitsSold Double METRIC Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
NewCustomerLifetimeValue Double METRIC New customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for biddable conversions. If your campaign has adopted the customer acquisition goal and selected 'bid higher for new customers', these values will be included in 'conversions_value' for optimization. See https://support.google.com/google-ads/answer/12080169 for more details.
OptimizationScoreUplift Double METRIC Total optimization score uplift of all recommendations.
OptimizationScoreUrl String METRIC URL for the optimization score page in the Google Ads web interface. This metric can be selected from customer or campaign, and can be segmented by segments.recommendation_type. For example, SELECT metrics.optimization_score_url, segments.recommendation_type FROM customer will return a URL for each unique (customer, recommendation_type) combination.
Orders Double METRIC Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data.
RevenueMicros Long METRIC Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is \(25 = (\)10 + $20) - $5. This metric is only available if you report conversions with cart data.
SearchBudgetLostImpressionShare Double METRIC The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SearchExactMatchImpressionShare Double METRIC The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
SearchImpressionShare Double METRIC The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
SearchRankLostImpressionShare Double METRIC The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
SkAdNetworkInstalls Long METRIC The number of iOS Store Kit Ad Network conversions.
SkAdNetworkTotalConversions Long METRIC The total number of iOS Store Kit Ad Network conversions.
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown anywhere above the organic search results.
UnitsSold Double METRIC Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerAllConversionsByConversionDate Double METRIC The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ValuePerConversionsByConversionDate Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
ViewThroughConversionsFromLocationAssetClickToCall Double METRIC Number of call button clicks on any location surface after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetDirections Double METRIC Number of driving directions clicks on any location surface after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetMenu Double METRIC Number of menu link clicks on any location surface after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetOrder Double METRIC Number of order clicks on any location surface after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetOtherEngagement Double METRIC Number of other types of local action clicks on any location surface after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetStoreVisits Double METRIC Estimated number of visits to the store after an impression. This measure is coming from Asset based location.
ViewThroughConversionsFromLocationAssetWebsite Double METRIC Number of website URL clicks on any location surface after an impression. This measure is coming from Asset based location.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
AuctionInsightDomain String SEGMENT Domain (visible URL) of a participant in the Auction Insights report.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
ConversionAdjustment Bool SEGMENT This segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.
ConversionLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion. The allowed values are EIGHT_TO_NINE_DAYS, ELEVEN_TO_TWELVE_DAYS, FIVE_TO_SIX_DAYS, FORTY_FIVE_TO_SIXTY_DAYS, FOURTEEN_TO_TWENTY_ONE_DAYS, FOUR_TO_FIVE_DAYS, LESS_THAN_ONE_DAY, NINE_TO_TEN_DAYS, ONE_TO_TWO_DAYS, SEVEN_TO_EIGHT_DAYS, SIXTY_TO_NINETY_DAYS, SIX_TO_SEVEN_DAYS, TEN_TO_ELEVEN_DAYS, THIRTEEN_TO_FOURTEEN_DAYS, THIRTY_TO_FORTY_FIVE_DAYS, THREE_TO_FOUR_DAYS, TWELVE_TO_THIRTEEN_DAYS, TWENTY_ONE_TO_THIRTY_DAYS, TWO_TO_THREE_DAYS, UNKNOWN, UNSPECIFIED.
ConversionOrAdjustmentLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion. The allowed values are ADJUSTMENT_EIGHT_TO_NINE_DAYS, ADJUSTMENT_ELEVEN_TO_TWELVE_DAYS, ADJUSTMENT_FIVE_TO_SIX_DAYS, ADJUSTMENT_FORTY_FIVE_TO_SIXTY_DAYS, ADJUSTMENT_FOURTEEN_TO_TWENTY_ONE_DAYS, ADJUSTMENT_FOUR_TO_FIVE_DAYS, ADJUSTMENT_LESS_THAN_ONE_DAY, ADJUSTMENT_NINETY_TO_ONE_HUNDRED_AND_FORTY_FIVE_DAYS, ADJUSTMENT_NINE_TO_TEN_DAYS, ADJUSTMENT_ONE_TO_TWO_DAYS, ADJUSTMENT_SEVEN_TO_EIGHT_DAYS, ADJUSTMENT_SIXTY_TO_NINETY_DAYS, ADJUSTMENT_SIX_TO_SEVEN_DAYS, ADJUSTMENT_TEN_TO_ELEVEN_DAYS, ADJUSTMENT_THIRTEEN_TO_FOURTEEN_DAYS, ADJUSTMENT_THIRTY_TO_FORTY_FIVE_DAYS, ADJUSTMENT_THREE_TO_FOUR_DAYS, ADJUSTMENT_TWELVE_TO_THIRTEEN_DAYS, ADJUSTMENT_TWENTY_ONE_TO_THIRTY_DAYS, ADJUSTMENT_TWO_TO_THREE_DAYS, ADJUSTMENT_UNKNOWN, CONVERSION_EIGHT_TO_NINE_DAYS, CONVERSION_ELEVEN_TO_TWELVE_DAYS, CONVERSION_FIVE_TO_SIX_DAYS, CONVERSION_FORTY_FIVE_TO_SIXTY_DAYS, CONVERSION_FOURTEEN_TO_TWENTY_ONE_DAYS, CONVERSION_FOUR_TO_FIVE_DAYS, CONVERSION_LESS_THAN_ONE_DAY, CONVERSION_NINE_TO_TEN_DAYS, CONVERSION_ONE_TO_TWO_DAYS, CONVERSION_SEVEN_TO_EIGHT_DAYS, CONVERSION_SIXTY_TO_NINETY_DAYS, CONVERSION_SIX_TO_SEVEN_DAYS, CONVERSION_TEN_TO_ELEVEN_DAYS, CONVERSION_THIRTEEN_TO_FOURTEEN_DAYS, CONVERSION_THIRTY_TO_FORTY_FIVE_DAYS, CONVERSION_THREE_TO_FOUR_DAYS, CONVERSION_TWELVE_TO_THIRTEEN_DAYS, CONVERSION_TWENTY_ONE_TO_THIRTY_DAYS, CONVERSION_TWO_TO_THREE_DAYS, CONVERSION_UNKNOWN, UNKNOWN, UNSPECIFIED.
ConversionValueRulePrimaryDimension String SEGMENT Primary dimension of applied conversion value rules. NO_RULE_APPLIED shows the total recorded value of conversions that do not have a value rule applied. ORIGINAL shows the original value of conversions to which a value rule has been applied. GEO_LOCATION, DEVICE, AUDIENCE show the net adjustment after value rules were applied. The allowed values are AUDIENCE, DEVICE, GEO_LOCATION, MULTIPLE, NEW_VS_RETURNING_USER, NO_RULE_APPLIED, ORIGINAL, UNKNOWN, UNSPECIFIED.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Hour Int SEGMENT Hour of day as a number between 0 and 23, inclusive.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
NewVersusReturningCustomers String SEGMENT This is for segmenting conversions by whether the user is a new customer or a returning customer. This segmentation is typically used to measure the impact of customer acquisition goal. The allowed values are NEW, NEW_AND_HIGH_LTV, RETURNING, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
RecommendationType String SEGMENT Recommendation type. The allowed values are CALLOUT_ASSET, CALL_ASSET, CAMPAIGN_BUDGET, DISPLAY_EXPANSION_OPT_IN, DYNAMIC_IMAGE_EXTENSION_OPT_IN, ENHANCED_CPC_OPT_IN, FORECASTING_CAMPAIGN_BUDGET, FORECASTING_SET_TARGET_CPA, FORECASTING_SET_TARGET_ROAS, IMPROVE_PERFORMANCE_MAX_AD_STRENGTH, KEYWORD, KEYWORD_MATCH_TYPE, LOWER_TARGET_ROAS, MARGINAL_ROI_CAMPAIGN_BUDGET, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MIGRATE_DYNAMIC_SEARCH_ADS_CAMPAIGN_TO_PERFORMANCE_MAX, MOVE_UNUSED_BUDGET, OPTIMIZE_AD_ROTATION, PERFORMANCE_MAX_OPT_IN, RAISE_TARGET_CPA, RAISE_TARGET_CPA_BID_TOO_LOW, RESPONSIVE_SEARCH_AD, RESPONSIVE_SEARCH_AD_ASSET, RESPONSIVE_SEARCH_AD_IMPROVE_AD_STRENGTH, SEARCH_PARTNERS_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, SHOPPING_ADD_AGE_GROUP, SHOPPING_ADD_COLOR, SHOPPING_ADD_GENDER, SHOPPING_ADD_GTIN, SHOPPING_ADD_MORE_IDENTIFIERS, SHOPPING_ADD_PRODUCTS_TO_CAMPAIGN, SHOPPING_ADD_SIZE, SHOPPING_FIX_DISAPPROVED_PRODUCTS, SHOPPING_FIX_MERCHANT_CENTER_ACCOUNT_SUSPENSION_WARNING, SHOPPING_FIX_SUSPENDED_MERCHANT_CENTER_ACCOUNT, SHOPPING_MIGRATE_REGULAR_SHOPPING_CAMPAIGN_OFFERS_TO_PERFORMANCE_MAX, SHOPPING_TARGET_ALL_OFFERS, SITELINK_ASSET, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN, TEXT_AD, UNKNOWN, UNSPECIFIED, UPGRADE_LOCAL_CAMPAIGN_TO_PERFORMANCE_MAX, UPGRADE_SMART_SHOPPING_CAMPAIGN_TO_PERFORMANCE_MAX, USE_BROAD_MATCH_KEYWORD.
SkAdNetworkAdEventType String SEGMENT iOS Store Kit Ad Network ad event type. The allowed values are INTERACTION, UNAVAILABLE, UNKNOWN, UNSPECIFIED, VIEW.
SkAdNetworkAttributionCredit String SEGMENT iOS Store Kit Ad Network attribution credit The allowed values are CONTRIBUTED, UNAVAILABLE, UNKNOWN, UNSPECIFIED, WON.
SkAdNetworkCoarseConversionValue String SEGMENT iOS Store Kit Ad Network coarse conversion value. The allowed values are HIGH, LOW, MEDIUM, NONE, UNAVAILABLE, UNKNOWN, UNSPECIFIED.
SkAdNetworkConversionValue Long SEGMENT iOS Store Kit Ad Network conversion value. Null value means this segment is not applicable, for example, non-iOS campaign.
SkAdNetworkPostbackSequenceIndex Long SEGMENT iOS Store Kit Ad Network postback sequence index.
SkAdNetworkSourceAppSkAdNetworkSourceAppId String SEGMENT App ID where the ad that drove the iOS Store Kit Ad Network install was shown.
SkAdNetworkSourceDomain String SEGMENT Website where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or was not present in any postbacks sent by Apple.
SkAdNetworkSourceType String SEGMENT The source type where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or neither source domain nor source app were present in any postbacks sent by Apple. The allowed values are MOBILE_APPLICATION, UNAVAILABLE, UNKNOWN, UNSPECIFIED, WEBSITE.
SkAdNetworkUserType String SEGMENT iOS Store Kit Ad Network user type. The allowed values are NEW_INSTALLER, REINSTALLER, UNAVAILABLE, UNKNOWN, UNSPECIFIED.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CustomerAsset

A link between a customer and an asset.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
CustomerAssetAsset String ATTRIBUTE Required. Immutable. The asset which is linked to the customer.
CustomerAssetFieldType String ATTRIBUTE Required. Immutable. Role that the asset takes for the customer link. The allowed values are AD_IMAGE, BOOK_ON_GOOGLE, BUSINESS_LOGO, BUSINESS_NAME, CALL, CALLOUT, CALL_TO_ACTION_SELECTION, DESCRIPTION, HEADLINE, HOTEL_CALLOUT, HOTEL_PROPERTY, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MANDATORY_AD_TEXT, MARKETING_IMAGE, MEDIA_BUNDLE, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, VIDEO, YOUTUBE_VIDEO.
CustomerAssetPrimaryStatus String ATTRIBUTE Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain 'status' field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state. The allowed values are ELIGIBLE, LIMITED, NOT_ELIGIBLE, PAUSED, PENDING, REMOVED, UNKNOWN, UNSPECIFIED.
CustomerAssetPrimaryStatusDetails String ATTRIBUTE Output only. Provides the details of the primary status and its associated reasons.
CustomerAssetPrimaryStatusReasons String ATTRIBUTE Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity. The allowed values are ASSET_APPROVED_LABELED, ASSET_DISAPPROVED, ASSET_LINK_PAUSED, ASSET_LINK_REMOVED, ASSET_UNDER_REVIEW, UNKNOWN, UNSPECIFIED.
CustomerAssetResourceName String ATTRIBUTE Immutable. The resource name of the customer asset. CustomerAsset resource names have the form: customers/{customer_id}/customerAssets/{asset_id}~{field_type}
CustomerAssetSource String ATTRIBUTE Output only. Source of the customer asset link. The allowed values are ADVERTISER, AUTOMATICALLY_CREATED, UNKNOWN, UNSPECIFIED.
CustomerAssetStatus String ATTRIBUTE Status of the customer asset. The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED.
AbsoluteTopImpressionPercentage Double METRIC The percent of your ad impressions that are shown as the very first ad above the organic search results.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions. The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
PhoneCalls Long METRIC Number of offline phone calls.
PhoneImpressions Long METRIC Number of offline phone impressions.
PhoneThroughRate Double METRIC Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown anywhere above the organic search results.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
AdNetworkType String SEGMENT Ad network type. The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.
AssetInteractionTargetAsset String SEGMENT The asset resource name.
AssetInteractionTargetInteractionOnThisAsset Bool SEGMENT Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
ClickType String SEGMENT Click type. The allowed values are APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category. The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.
ConversionActionName String SEGMENT Conversion action name.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.
Device String SEGMENT Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.
ExternalConversionSource String SEGMENT External conversion source. The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.
Period String SEGMENT Predefined date range. The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.
Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Slot String SEGMENT Position of the ad. The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CustomerAssetSet

CustomerAssetSet is the linkage between a customer and an asset set. Adding a CustomerAssetSet links an asset set with a customer.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
CustomerAssetSetAssetSet String ATTRIBUTE Immutable. The asset set which is linked to the customer.
CustomerAssetSetResourceName String ATTRIBUTE Immutable. The resource name of the customer asset set. Asset set asset resource names have the form: customers/{customer_id}/customerAssetSets/{asset_set_id}
CustomerAssetSetStatus String ATTRIBUTE Output only. The status of the customer asset set asset. Read-only. The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

CustomerClient

A link between the given customer and a client customer. CustomerClients only exist for manager customers. All direct and indirect client customers are included, as well as the manager itself.

Columns
Name Type Behavior Description
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
CustomerClientAppliedLabels String ATTRIBUTE Output only. The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form: customers/{customer_id}/labels/{label_id}
CustomerClientClientCustomer String ATTRIBUTE Output only. The resource name of the client-customer which is linked to the given customer. Read only.
CustomerClientCurrencyCode String ATTRIBUTE Output only. Currency code (for example, 'USD', 'EUR') for the client. Read only.
CustomerClientDescriptiveName String ATTRIBUTE Output only. Descriptive name for the client. Read only.
CustomerClientHidden Bool ATTRIBUTE Output only. Specifies whether this is a hidden account. Read only.
CustomerClientId Long ATTRIBUTE Output only. The ID of the client customer. Read only.
CustomerClientLevel Long ATTRIBUTE Output only. Distance between given customer and client. For self link, the level value will be 0. Read only.
CustomerClientManager Bool ATTRIBUTE Output only. Identifies if the client is a manager. Read only.
CustomerClientResourceName String ATTRIBUTE Output only. The resource name of the customer client. CustomerClient resource names have the form: customers/{customer_id}/customerClients/{client_customer_id}
CustomerClientStatus String ATTRIBUTE Output only. The status of the client customer. Read only. The allowed values are CANCELED, CLOSED, ENABLED, SUSPENDED, UNKNOWN, UNSPECIFIED.
Cu