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.

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.

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.

Google Ads Connector Views¶

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¶

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.

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 HHss 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 HHss 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 HHss.
AccountBudgetPendingProposalEndDateTime	Datetime	ATTRIBUTE	Output only. The end time in yyyy-MM-dd HHss 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 HHss format.
AccountBudgetProposedEndDateTime	Datetime	ATTRIBUTE	Output only. The proposed end time in yyyy-MM-dd HHss 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 HHss 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.

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 hhss 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 hhss 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 hhss 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 hhss 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.

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¶

AccountLink¶

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

Columns¶

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.

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¶

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¶

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.

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¶

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.

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¶

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.

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¶

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.

AdGroupAdLabel¶

A relationship between an ad group ad and a label.

Columns¶

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.

AdGroupAsset¶

A link between an ad group and an asset.

Columns¶

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.

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¶

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.

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¶

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.

AdGroupBidModifier¶

Represents an ad group bid modifier.

Columns¶

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.

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¶