> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# google-ads
> Google Ads API
**Server path:** `/google-ads` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| [`google-ads_create_customer_client`](#google-ads_create_customer_client) | Create a client account under a manager |
| [`google-ads_generate_keyword_ideas`](#google-ads_generate_keyword_ideas) | Generate keyword ideas |
| [`google-ads_get_field`](#google-ads_get_field) | Get a single Google Ads field's metadata |
| [`google-ads_list_accessible_customers`](#google-ads_list_accessible_customers) | List accessible customer accounts |
| [`google-ads_list_invoices`](#google-ads_list_invoices) | List invoices for a billing setup |
| [`google-ads_mutate_ad_group_ads`](#google-ads_mutate_ad_group_ads) | Create, update, or remove ads in ad groups |
| [`google-ads_mutate_ad_group_criteria`](#google-ads_mutate_ad_group_criteria) | Create, update, or remove ad group criteria (keywords, audiences) |
| [`google-ads_mutate_ad_groups`](#google-ads_mutate_ad_groups) | Create, update, or remove ad groups |
| [`google-ads_mutate_ads`](#google-ads_mutate_ads) | Update ads |
| [`google-ads_mutate_campaign_budgets`](#google-ads_mutate_campaign_budgets) | Create, update, or remove campaign budgets |
| [`google-ads_mutate_campaign_criteria`](#google-ads_mutate_campaign_criteria) | Create, update, or remove campaign criteria |
| [`google-ads_mutate_campaigns`](#google-ads_mutate_campaigns) | Create, update, or remove campaigns |
| [`google-ads_mutate_conversion_actions`](#google-ads_mutate_conversion_actions) | Create, update, or remove conversion actions |
| [`google-ads_mutate_customer`](#google-ads_mutate_customer) | Update a customer account |
| [`google-ads_mutate_customer_client_link`](#google-ads_mutate_customer_client_link) | Link or unlink a client account to a manager |
| [`google-ads_search_google_ads`](#google-ads_search_google_ads) | Run a Google Ads Query Language (GAQL) query |
| [`google-ads_search_google_ads_fields`](#google-ads_search_google_ads_fields) | Search Google Ads field metadata |
| [`google-ads_upload_click_conversions`](#google-ads_upload_click_conversions) | Upload offline click conversions |
***
## google-ads\_create\_customer\_client
Create a client account under a manager
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `accessRole` | string | No | — | The access role granted to the invited user (optional). |
| `customerClient` | object | Yes | — | The new client customer to create. Typically includes `descriptiveName`, `currencyCode`, and `timeZone`. |
| `emailAddress` | string | No | — | Email of a user to invite to the new client account (optional). |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"accessRole": {
"type": "string",
"description": "The access role granted to the invited user (optional)."
},
"customerClient": {
"type": "object",
"description": "The new client customer to create. Typically includes `descriptiveName`, `currencyCode`, and `timeZone`."
},
"emailAddress": {
"type": "string",
"description": "Email of a user to invite to the new client account (optional)."
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed."
}
},
"required": [
"PCID",
"customerId",
"customerClient"
]
}
```
***
## google-ads\_generate\_keyword\_ideas
Generate keyword ideas
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `geoTargetConstants` | string\[] | No | — | Resource names of geo targets, e.g. \["geoTargetConstants/2840"]. |
| `includeAdultKeywords` | boolean | No | — | If true, adult keywords are included in the results. |
| `keywordAndUrlSeed` | object | No | — | A combined keyword and URL seed. Provide `url` and `keywords`. |
| `keywordPlanNetwork` | string | No | — | Targeting network. |
| `keywordSeed` | object | No | — | A seed of one or more keywords. Provide `keywords` as a string array. |
| `language` | string | No | — | The resource name of the language to target, e.g. "languageConstants/1000". |
| `pageSize` | integer | No | — | Number of results to retrieve in a single page. |
| `pageToken` | string | No | — | Token of the page to retrieve from a previous response. |
| `urlSeed` | object | No | — | A seed page URL. Provide `url` as a string. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"geoTargetConstants": {
"type": "array",
"items": {
"type": "string"
},
"description": "Resource names of geo targets, e.g. [\"geoTargetConstants/2840\"]."
},
"includeAdultKeywords": {
"type": "boolean",
"description": "If true, adult keywords are included in the results."
},
"keywordAndUrlSeed": {
"type": "object",
"description": "A combined keyword and URL seed. Provide `url` and `keywords`."
},
"keywordPlanNetwork": {
"type": "string",
"description": "Targeting network.",
"enum": [
"UNSPECIFIED",
"UNKNOWN",
"GOOGLE_SEARCH",
"GOOGLE_SEARCH_AND_PARTNERS"
]
},
"keywordSeed": {
"type": "object",
"description": "A seed of one or more keywords. Provide `keywords` as a string array."
},
"language": {
"type": "string",
"description": "The resource name of the language to target, e.g. \"languageConstants/1000\"."
},
"pageSize": {
"type": "integer",
"description": "Number of results to retrieve in a single page."
},
"pageToken": {
"type": "string",
"description": "Token of the page to retrieve from a previous response."
},
"urlSeed": {
"type": "object",
"description": "A seed page URL. Provide `url` as a string."
}
},
"required": [
"PCID",
"customerId"
]
}
```
***
## google-ads\_get\_field
Get a single Google Ads field's metadata
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `resourceName` | string | Yes | — | The resource name of the field to retrieve, e.g. "googleAdsFields/campaign.id". The slash is part of the resource name and must not be percent-encoded. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"resourceName": {
"type": "string",
"description": "The resource name of the field to retrieve, e.g. \"googleAdsFields/campaign.id\". The slash is part of the resource name and must not be percent-encoded."
}
},
"required": [
"PCID",
"resourceName"
]
}
```
***
## google-ads\_list\_accessible\_customers
List accessible customer accounts
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## google-ads\_list\_invoices
List invoices for a billing setup
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `billingSetup` | string | Yes | — | The resource name of the billing setup, e.g. "customers/123/billingSetups/456". |
| `issueYear` | string | Yes | — | The year (yyyy) of the invoice issue date. |
| `issueMonth` | string | Yes | — | The month of the invoice issue date. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"billingSetup": {
"type": "string",
"description": "The resource name of the billing setup, e.g. \"customers/123/billingSetups/456\"."
},
"issueYear": {
"type": "string",
"description": "The year (yyyy) of the invoice issue date."
},
"issueMonth": {
"type": "string",
"description": "The month of the invoice issue date.",
"enum": [
"JANUARY",
"FEBRUARY",
"MARCH",
"APRIL",
"MAY",
"JUNE",
"JULY",
"AUGUST",
"SEPTEMBER",
"OCTOBER",
"NOVEMBER",
"DECEMBER"
]
}
},
"required": [
"PCID",
"customerId",
"billingSetup",
"issueYear",
"issueMonth"
]
}
```
***
## google-ads\_mutate\_ad\_group\_ads
Create, update, or remove ads in ad groups
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `operations` | object\[] | Yes | — | Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string). |
| `partialFailure` | boolean | No | — | If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid. |
| `responseContentType` | string | No | — | Determines whether the mutable resource or just the resource name is returned. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed; only errors are returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"operations": {
"type": "array",
"items": {
"type": "object"
},
"description": "Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string)."
},
"partialFailure": {
"type": "boolean",
"description": "If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid."
},
"responseContentType": {
"type": "string",
"description": "Determines whether the mutable resource or just the resource name is returned.",
"enum": [
"UNSPECIFIED",
"UNKNOWN",
"RESOURCE_NAME_ONLY",
"MUTABLE_RESOURCE"
]
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed; only errors are returned."
}
},
"required": [
"PCID",
"customerId",
"operations"
]
}
```
***
## google-ads\_mutate\_ad\_group\_criteria
Create, update, or remove ad group criteria (keywords, audiences)
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `operations` | object\[] | Yes | — | Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string). |
| `partialFailure` | boolean | No | — | If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid. |
| `responseContentType` | string | No | — | Determines whether the mutable resource or just the resource name is returned. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed; only errors are returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"operations": {
"type": "array",
"items": {
"type": "object"
},
"description": "Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string)."
},
"partialFailure": {
"type": "boolean",
"description": "If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid."
},
"responseContentType": {
"type": "string",
"description": "Determines whether the mutable resource or just the resource name is returned.",
"enum": [
"UNSPECIFIED",
"UNKNOWN",
"RESOURCE_NAME_ONLY",
"MUTABLE_RESOURCE"
]
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed; only errors are returned."
}
},
"required": [
"PCID",
"customerId",
"operations"
]
}
```
***
## google-ads\_mutate\_ad\_groups
Create, update, or remove ad groups
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `operations` | object\[] | Yes | — | Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string). |
| `partialFailure` | boolean | No | — | If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid. |
| `responseContentType` | string | No | — | Determines whether the mutable resource or just the resource name is returned. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed; only errors are returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"operations": {
"type": "array",
"items": {
"type": "object"
},
"description": "Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string)."
},
"partialFailure": {
"type": "boolean",
"description": "If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid."
},
"responseContentType": {
"type": "string",
"description": "Determines whether the mutable resource or just the resource name is returned.",
"enum": [
"UNSPECIFIED",
"UNKNOWN",
"RESOURCE_NAME_ONLY",
"MUTABLE_RESOURCE"
]
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed; only errors are returned."
}
},
"required": [
"PCID",
"customerId",
"operations"
]
}
```
***
## google-ads\_mutate\_ads
Update ads
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `operations` | object\[] | Yes | — | Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string). |
| `partialFailure` | boolean | No | — | If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid. |
| `responseContentType` | string | No | — | Determines whether the mutable resource or just the resource name is returned. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed; only errors are returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"operations": {
"type": "array",
"items": {
"type": "object"
},
"description": "Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string)."
},
"partialFailure": {
"type": "boolean",
"description": "If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid."
},
"responseContentType": {
"type": "string",
"description": "Determines whether the mutable resource or just the resource name is returned.",
"enum": [
"UNSPECIFIED",
"UNKNOWN",
"RESOURCE_NAME_ONLY",
"MUTABLE_RESOURCE"
]
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed; only errors are returned."
}
},
"required": [
"PCID",
"customerId",
"operations"
]
}
```
***
## google-ads\_mutate\_campaign\_budgets
Create, update, or remove campaign budgets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `operations` | object\[] | Yes | — | Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string). |
| `partialFailure` | boolean | No | — | If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid. |
| `responseContentType` | string | No | — | Determines whether the mutable resource or just the resource name is returned. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed; only errors are returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"operations": {
"type": "array",
"items": {
"type": "object"
},
"description": "Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string)."
},
"partialFailure": {
"type": "boolean",
"description": "If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid."
},
"responseContentType": {
"type": "string",
"description": "Determines whether the mutable resource or just the resource name is returned.",
"enum": [
"UNSPECIFIED",
"UNKNOWN",
"RESOURCE_NAME_ONLY",
"MUTABLE_RESOURCE"
]
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed; only errors are returned."
}
},
"required": [
"PCID",
"customerId",
"operations"
]
}
```
***
## google-ads\_mutate\_campaign\_criteria
Create, update, or remove campaign criteria
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `operations` | object\[] | Yes | — | Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string). |
| `partialFailure` | boolean | No | — | If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid. |
| `responseContentType` | string | No | — | Determines whether the mutable resource or just the resource name is returned. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed; only errors are returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"operations": {
"type": "array",
"items": {
"type": "object"
},
"description": "Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string)."
},
"partialFailure": {
"type": "boolean",
"description": "If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid."
},
"responseContentType": {
"type": "string",
"description": "Determines whether the mutable resource or just the resource name is returned.",
"enum": [
"UNSPECIFIED",
"UNKNOWN",
"RESOURCE_NAME_ONLY",
"MUTABLE_RESOURCE"
]
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed; only errors are returned."
}
},
"required": [
"PCID",
"customerId",
"operations"
]
}
```
***
## google-ads\_mutate\_campaigns
Create, update, or remove campaigns
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `operations` | object\[] | Yes | — | Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string). |
| `partialFailure` | boolean | No | — | If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid. |
| `responseContentType` | string | No | — | Determines whether the mutable resource or just the resource name is returned. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed; only errors are returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"operations": {
"type": "array",
"items": {
"type": "object"
},
"description": "Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string)."
},
"partialFailure": {
"type": "boolean",
"description": "If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid."
},
"responseContentType": {
"type": "string",
"description": "Determines whether the mutable resource or just the resource name is returned.",
"enum": [
"UNSPECIFIED",
"UNKNOWN",
"RESOURCE_NAME_ONLY",
"MUTABLE_RESOURCE"
]
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed; only errors are returned."
}
},
"required": [
"PCID",
"customerId",
"operations"
]
}
```
***
## google-ads\_mutate\_conversion\_actions
Create, update, or remove conversion actions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `operations` | object\[] | Yes | — | Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string). |
| `partialFailure` | boolean | No | — | If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid. |
| `responseContentType` | string | No | — | Determines whether the mutable resource or just the resource name is returned. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed; only errors are returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"operations": {
"type": "array",
"items": {
"type": "object"
},
"description": "Required. The list of operations to perform. Each element has exactly one of `create` (a resource object), `update` (a resource object with `resourceName`, accompanied by `updateMask`), or `remove` (a resource name string)."
},
"partialFailure": {
"type": "boolean",
"description": "If true, successful operations are carried out and invalid operations return errors. If false, all operations are carried out in one transaction if and only if they are all valid."
},
"responseContentType": {
"type": "string",
"description": "Determines whether the mutable resource or just the resource name is returned.",
"enum": [
"UNSPECIFIED",
"UNKNOWN",
"RESOURCE_NAME_ONLY",
"MUTABLE_RESOURCE"
]
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed; only errors are returned."
}
},
"required": [
"PCID",
"customerId",
"operations"
]
}
```
***
## google-ads\_mutate\_customer
Update a customer account
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `operation` | object | Yes | — | The single update operation. Provide `update` (the customer object with changed fields) and `updateMask` (comma-separated field paths to update). |
| `responseContentType` | string | No | — | Whether to return the mutable resource or just the resource name. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"operation": {
"type": "object",
"description": "The single update operation. Provide `update` (the customer object with changed fields) and `updateMask` (comma-separated field paths to update)."
},
"responseContentType": {
"type": "string",
"description": "Whether to return the mutable resource or just the resource name.",
"enum": [
"UNSPECIFIED",
"UNKNOWN",
"RESOURCE_NAME_ONLY",
"MUTABLE_RESOURCE"
]
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed."
}
},
"required": [
"PCID",
"customerId",
"operation"
]
}
```
***
## google-ads\_mutate\_customer\_client\_link
Link or unlink a client account to a manager
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `operation` | object | Yes | — | The single operation to perform. Has exactly one of `create`, `update` (with `updateMask`), or `remove`. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"operation": {
"type": "object",
"description": "The single operation to perform. Has exactly one of `create`, `update` (with `updateMask`), or `remove`."
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed."
}
},
"required": [
"PCID",
"customerId",
"operation"
]
}
```
***
## google-ads\_search\_google\_ads
Run a Google Ads Query Language (GAQL) query
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `pageSize` | integer | No | — | Number of elements to retrieve in a single page. Maximum 10000. When too large, it is capped to the maximum. |
| `pageToken` | string | No | — | Token of the page to retrieve, from a previous response's nextPageToken. Omit to retrieve the first page. |
| `query` | string | Yes | — | Required. The GAQL query string. Selects fields from one resource with optional WHERE / ORDER BY / LIMIT clauses. |
| `returnTotalResultsCount` | boolean | No | — | If true, the total number of results matching the query, ignoring LIMIT, is included in the response. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"pageSize": {
"type": "integer",
"description": "Number of elements to retrieve in a single page. Maximum 10000. When too large, it is capped to the maximum."
},
"pageToken": {
"type": "string",
"description": "Token of the page to retrieve, from a previous response's nextPageToken. Omit to retrieve the first page."
},
"query": {
"type": "string",
"description": "Required. The GAQL query string. Selects fields from one resource with optional WHERE / ORDER BY / LIMIT clauses."
},
"returnTotalResultsCount": {
"type": "boolean",
"description": "If true, the total number of results matching the query, ignoring LIMIT, is included in the response."
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed."
}
},
"required": [
"PCID",
"customerId",
"query"
]
}
```
***
## google-ads\_search\_google\_ads\_fields
Search Google Ads field metadata
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ------------------------------------------------------- |
| `pageSize` | integer | No | — | Number of elements to retrieve in a single page. |
| `pageToken` | string | No | — | Token of the page to retrieve from a previous response. |
| `query` | string | Yes | — | Required. The metadata query string. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "Number of elements to retrieve in a single page."
},
"pageToken": {
"type": "string",
"description": "Token of the page to retrieve from a previous response."
},
"query": {
"type": "string",
"description": "Required. The metadata query string."
}
},
"required": [
"PCID",
"query"
]
}
```
***
## google-ads\_upload\_click\_conversions
Upload offline click conversions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerId` | string | Yes | — | The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. "1234567890"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id. |
| `conversions` | object\[] | Yes | — | The list of click conversions to upload. |
| `debugEnabled` | boolean | No | — | If true, enriched diagnostic information is returned. |
| `partialFailure` | boolean | Yes | — | Required to be true. Successful operations are carried out and invalid ones return errors. |
| `validateOnly` | boolean | No | — | If true, the request is validated but not executed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "The numeric ID of the Google Ads customer (account) being operated on, without dashes (e.g. \"1234567890\"). For manager accounts acting on a client, this is the operated-on account; the manager is supplied via the connection's login-customer-id."
},
"conversions": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list of click conversions to upload."
},
"debugEnabled": {
"type": "boolean",
"description": "If true, enriched diagnostic information is returned."
},
"partialFailure": {
"type": "boolean",
"description": "Required to be true. Successful operations are carried out and invalid ones return errors."
},
"validateOnly": {
"type": "boolean",
"description": "If true, the request is validated but not executed."
}
},
"required": [
"PCID",
"customerId",
"conversions",
"partialFailure"
]
}
```