@slates-integrations/google-ads 0.2.0-rc.7 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist/index.js +3 -3
- package/dist/index.js.map +1 -1
- package/docs/SPEC.md +16 -19
- package/package.json +3 -3
package/docs/SPEC.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Google Ads Specification
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
@@ -6,38 +6,35 @@ Google Ads is Google's online advertising platform that allows advertisers to cr
|
|
|
6
6
|
|
|
7
7
|
## Authentication
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
The integration uses OAuth 2.0 to access the Google Ads accounts authorized by the user. API access levels belong to the Google Cloud project that owns the OAuth client ID and secret.
|
|
10
10
|
|
|
11
11
|
### Prerequisites
|
|
12
12
|
|
|
13
|
-
1. **
|
|
13
|
+
1. **Google Cloud Project**: Enable the Google Ads API and create OAuth 2.0 credentials in the project used by the application.
|
|
14
|
+
2. **API Access**: Review the project's [Google Ads API Overview](https://console.cloud.google.com/apis/api/googleads.googleapis.com/overview). Test access supports test accounts only. Explorer access supports production accounts with feature restrictions; **Basic or Standard access is required for Generate Keyword Ideas**. New Basic and Standard access applications require brand verification. For Standard access, verify that the approved permissible use covers campaign management, reporting, and keyword research.
|
|
15
|
+
3. **Google Ads Account Access**: The authorizing user must have access to the target Google Ads customer account. Set the optional manager customer ID when accessing client accounts through a manager account.
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
For managed OAuth credentials, the application operator manages API access on the OAuth project's behalf. When supplying custom OAuth credentials, use a project with the necessary Google Ads API access.
|
|
16
18
|
|
|
17
|
-
### OAuth 2.0
|
|
19
|
+
### OAuth 2.0 Flow
|
|
18
20
|
|
|
19
|
-
|
|
21
|
+
Users authorize the application with its OAuth client ID and secret. The integration stores the access token, refresh token, and expiration time, and refreshes access tokens automatically.
|
|
20
22
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
- **Service Account Flow**: For workflows that don't require human interaction. This requires a configuration step where the user adds a service account to their Google Ads account, and the app can then use the service account's credentials to manage the user's Google Ads account.
|
|
24
|
-
|
|
25
|
-
### OAuth 2.0 Scope
|
|
26
|
-
|
|
27
|
-
The scope for the Google Ads API is `https://www.googleapis.com/auth/adwords`.
|
|
23
|
+
The Google Ads scope is `https://www.googleapis.com/auth/adwords`. User email and profile scopes identify the connected user.
|
|
28
24
|
|
|
29
25
|
### Required Headers
|
|
30
26
|
|
|
31
|
-
|
|
27
|
+
API requests send `Authorization: Bearer <access_token>`. Requests through a manager account also send `login-customer-id` with that manager's customer ID, without hyphens.
|
|
32
28
|
|
|
33
29
|
### Token Endpoint
|
|
34
30
|
|
|
35
|
-
|
|
31
|
+
Authorization codes and refresh tokens are exchanged at `https://oauth2.googleapis.com/token`.
|
|
32
|
+
|
|
33
|
+
### Developer Token Retirement
|
|
36
34
|
|
|
37
|
-
|
|
35
|
+
Google sunset developer tokens on September 9, 2026. No developer token is requested or sent by this integration. Existing saved values are unused and do not require a credential migration or reconnection.
|
|
38
36
|
|
|
39
|
-
|
|
40
|
-
- Your developer token needs approval to work with production Google Ads accounts but can be used immediately with a test manager account.
|
|
37
|
+
Review access on the actual OAuth Cloud project rather than applying through the retired Google Ads API Center. See Google's [migration guide](https://developers.google.com/google-ads/api/docs/api-policy/developer-token) and [access levels](https://developers.google.com/google-ads/api/docs/api-policy/access-levels).
|
|
41
38
|
|
|
42
39
|
## Features
|
|
43
40
|
|
|
@@ -79,7 +76,7 @@ Using a manager account, you can control client accounts and run operations with
|
|
|
79
76
|
|
|
80
77
|
### Reach and Frequency Forecasting
|
|
81
78
|
|
|
82
|
-
Plan video and display campaigns by generating reach and frequency forecasts.
|
|
79
|
+
Plan video and display campaigns by generating reach and frequency forecasts. Access to ReachPlanService requires separate approval for the Google Cloud project, even if it is approved for other Google Ads API services.
|
|
83
80
|
|
|
84
81
|
## Events
|
|
85
82
|
|
package/package.json
CHANGED
|
@@ -10,15 +10,15 @@
|
|
|
10
10
|
"dependencies": {
|
|
11
11
|
"@lowerdeck/error": "^1.1.0",
|
|
12
12
|
"@types/node": "^20",
|
|
13
|
-
"slates": "1.0.0-rc.
|
|
13
|
+
"slates": "1.0.0-rc.17",
|
|
14
14
|
"zod": "^4.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@slates/test": "1.0.0-rc.
|
|
17
|
+
"@slates/test": "1.0.0-rc.14",
|
|
18
18
|
"typescript": "^5",
|
|
19
19
|
"vitest": "^3.1.2"
|
|
20
20
|
},
|
|
21
|
-
"version": "0.2.
|
|
21
|
+
"version": "0.2.1",
|
|
22
22
|
"files": [
|
|
23
23
|
"dist/**",
|
|
24
24
|
"docs/**",
|