{ "opencollection": "1.0.0", "info": { "name": "Google Ads API", "version": "v25" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "customers", "type": "folder" }, "items": [ { "info": { "name": "Returns the requested Shareable Preview.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateShareablePreviews", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The customer creating the shareable previews request." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the requested Shareable Preview." }, { "info": { "name": "Returns resource names of customers directly accessible by the user authenticating the call", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/customers:listAccessibleCustomers", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns resource names of customers directly accessible by the user authenticating the call. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns a list of keyword historical metrics", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateKeywordHistoricalMetrics", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "The ID of the customer with the recommendation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of keyword historical metrics. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Suggests keyword themes to advertise on.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:suggestKeywordThemes", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Suggests keyword themes to advertise on." }, { "info": { "name": "Returns a collection of audience attributes using generative AI based on the provided audience description", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateAudienceDefinition", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a collection of audience attributes using generative AI based on the provided audience description. List of thrown errors: [AudienceInsightsError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns insights for trending content on YouTube", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateTrendingInsights", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns insights for trending content on YouTube. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()" }, { "info": { "name": "Returns a collection of audience attributes along with estimates of the overlap between their potential YouTube reach and that of a given input attribute", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateAudienceOverlapInsights", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a collection of audience attributes along with estimates of the overlap between their potential YouTube reach and that of a given input attribute. List of thrown errors: [AudienceInsightsError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()" }, { "info": { "name": "Returns BudgetOption suggestions.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:suggestSmartCampaignBudgetOptions", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose budget options are to be suggested." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns BudgetOption suggestions." }, { "info": { "name": "Returns a collection of targeting insights (e.g", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateSuggestedTargetingInsights", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a collection of targeting insights (e.g. targetable audiences) that are relevant to the requested audience. List of thrown errors: [AudienceInsightsError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()" }, { "info": { "name": "Returns metrics (such as impressions, clicks, total cost) of a keyword forecast for the given campaign", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateKeywordForecastMetrics", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns metrics (such as impressions, clicks, total cost) of a keyword forecast for the given campaign. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns insights for a collection of YouTube Creators and Channels", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateCreatorInsights", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns insights for a collection of YouTube Creators and Channels. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()" }, { "info": { "name": "Processes the given click conversions", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:uploadClickConversions", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer performing the upload." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Processes the given click conversions. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ConversionUploadError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns Travel Asset suggestions", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:suggestTravelAssets", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns Travel Asset suggestions. Asset suggestions are returned on a best-effort basis. There are no guarantees that all possible asset types will be returned for any given hotel property." }, { "info": { "name": "Uploads the given user data", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:uploadUserData", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer for which to update the user data." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uploads the given user data. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]() [UserDataError]()" }, { "info": { "name": "Processes the given conversion adjustments", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:uploadConversionAdjustments", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer performing the upload." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Processes the given conversion adjustments. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Removes automatically created assets from a campaign", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:removeCampaignAutomaticallyCreatedAsset", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose assets are being removed." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes automatically created assets from a campaign. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ContextError]() [FieldError]() [InternalError]() [MutateError]() [PartialFailureError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns a collection of attributes that are represented in an audience of interest, with metrics that compare each attribute's share of the audience with its share of a baseline audience", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateAudienceCompositionInsights", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a collection of attributes that are represented in an audience of interest, with metrics that compare each attribute's share of the audience with its share of a baseline audience. List of thrown errors: [AudienceInsightsError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()" }, { "info": { "name": "Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:suggestSmartCampaignAd", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise." }, { "info": { "name": "Starts Identity Verification for a given verification program type", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:startIdentityVerification", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The Id of the customer for whom we are creating this verification." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Starts Identity Verification for a given verification program type. Statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Generates a reach forecast for a given targeting / product mix", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateReachForecast", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Generates a reach forecast for a given targeting / product mix. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [ReachPlanError]() [RequestError]()" }, { "info": { "name": "Returns Identity Verification information", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/customers/:customersId/getIdentityVerification", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer for whom we are requesting verification information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns Identity Verification information. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Rpc to return a list of matching brands based on a prefix for this customer.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:suggestBrands", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer onto which to apply the brand suggestion operation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Rpc to return a list of matching brands based on a prefix for this customer." }, { "info": { "name": "Updates a customer", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a customer. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldMaskError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [UrlFieldError]()" }, { "info": { "name": "Returns a list of keyword ideas", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateKeywordIdeas", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "The ID of the customer with the recommendation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of keyword ideas. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [KeywordPlanIdeaError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Creates a saved report that can be viewed in the Insights Finder tool", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateInsightsFinderReport", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a saved report that can be viewed in the Insights Finder tool. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()" }, { "info": { "name": "Processes the given call conversions", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:uploadCallConversions", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer performing the upload." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Processes the given call conversions. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns a list of suggested AdGroups and suggested modifications (text, match type) for the given keywords", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateAdGroupThemes", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of suggested AdGroups and suggested modifications (text, match type) for the given keywords. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Creates a new client under manager", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:createCustomerClient", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the Manager under whom client customer is being created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new client under manager. The new client customer is returned. List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CurrencyCodeError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [QuotaError]() [RequestError]() [StringLengthError]() [TimeZoneError]()" }, { "info": { "name": "Returns YouTube advertisement metrics for the given client against industry benchmarks", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateBenchmarksMetrics", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer. Supply a client customer ID to generate metrics for the customer. A manager account customer ID will not return customer metrics since it does not have any associated direct ad campaigns." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns YouTube advertisement metrics for the given client against industry benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BenchmarksError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()" }, { "info": { "name": "Searches for audience attributes that can be used to generate insights", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:searchAudienceInsightsAttributes", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for audience attributes that can be used to generate insights. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()" }, { "info": { "name": "Returns potential reach metrics for targetable audiences", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId:generateTargetingSuggestionMetrics", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns potential reach metrics for targetable audiences. This method helps answer questions like \"How many Men aged 18+ interested in Camping can be reached on YouTube?\" List of thrown errors: [AudienceInsightsError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()" } ] }, { "info": { "name": "customers.campaignBidModifiers", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes campaign bid modifiers", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignBidModifiers:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose campaign bid modifiers are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes campaign bid modifiers. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ContextError]() [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthE" } ] }, { "info": { "name": "customers.conversionCustomVariables", "type": "folder" }, "items": [ { "info": { "name": "Creates or updates conversion custom variables", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/conversionCustomVariables:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose conversion custom variables are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates conversion custom variables. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ConversionCustomVariableError]() [DatabaseError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.customerConversionGoals", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes customer conversion goals", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerConversionGoals:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose customer conversion goals are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes customer conversion goals. Operation statuses are returned." } ] }, { "info": { "name": "customers.recommendationSubscriptions", "type": "folder" }, "items": [ { "info": { "name": "Mutates given subscription with corresponding apply parameters", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/recommendationSubscriptions:mutateRecommendationSubscription", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the subscribing customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Mutates given subscription with corresponding apply parameters. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RecommendationError]() [RecommendationSubscriptionError]() [RequestError]() [UrlFieldError]()" } ] }, { "info": { "name": "customers.localServicesLeads", "type": "folder" }, "items": [ { "info": { "name": "RPC to provide feedback on Local Services Lead resources.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/localServicesLeads/:localServicesLeadsId:provideLeadFeedback", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The resource name of the local services lead that for which the feedback is being provided." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "RPC to provide feedback on Local Services Lead resources." } ] }, { "info": { "name": "customers.adGroupCustomizers", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes ad group customizers", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroupCustomizers:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose ad group customizers are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes ad group customizers. Operation statuses are returned." } ] }, { "info": { "name": "customers.userLists", "type": "folder" }, "items": [ { "info": { "name": "Creates or updates user lists", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/userLists:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose user lists are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates user lists. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]() [NotEmptyError]() [OperationAccessDeniedError]() [QuotaError]() [RangeError]() [RequestError]() [StringFormatError]() [StringLengthError]() [UserListError]()" } ] }, { "info": { "name": "customers.campaignGroups", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes campaign groups", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignGroups:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaign groups are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes campaign groups. Operation statuses are returned." } ] }, { "info": { "name": "customers.campaignLabels", "type": "folder" }, "items": [ { "info": { "name": "Creates and removes campaign-label relationships", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignLabels:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose campaign-label relationships are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates and removes campaign-label relationships. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.remarketingActions", "type": "folder" }, "items": [ { "info": { "name": "Creates or updates remarketing actions", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/remarketingActions:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose remarketing actions are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates remarketing actions. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ConversionActionError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.ads", "type": "folder" }, "items": [ { "info": { "name": "Updates ads", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/ads:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose ads are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates ads. Operation statuses are returned. Updating ads is not supported for TextAd, ExpandedDynamicSearchAd, GmailAd and ImageAd. List of thrown errors: [AdCustomizerError]() [AdError]() [AdSharingError]() [AdxError]() [AssetError]() [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [DatabaseError]() [DateError]() [DistinctError]() [FeedAttributeReferenceError]() [FieldError]() [FieldMaskError]() [FunctionError]() [FunctionParsingError]() [HeaderError]" } ] }, { "info": { "name": "customers.recommendations", "type": "folder" }, "items": [ { "info": { "name": "Applies given recommendations with corresponding apply parameters", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/recommendations:apply", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer with the recommendation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Applies given recommendations with corresponding apply parameters. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RecommendationError]() [RequestError]() [UrlFieldError]()" }, { "info": { "name": "Generates Recommendations based off the requested recommendation_types", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/recommendations:generate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer generating recommendations." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Generates Recommendations based off the requested recommendation_types. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RecommendationError]() [RequestError]()" }, { "info": { "name": "Dismisses given recommendations", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/recommendations:dismiss", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer with the recommendation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Dismisses given recommendations. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RecommendationError]() [RequestError]()" } ] }, { "info": { "name": "customers.dataLinks", "type": "folder" }, "items": [ { "info": { "name": "Update a data link", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/dataLinks:update", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer for which the data link is created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a data link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Creates a data link", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/dataLinks:create", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer for which the data link is created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a data link. The requesting Google Ads account name and account ID will be shared with the third party (such as YouTube creators for video links) to whom you are creating the link with. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Remove a data link", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/dataLinks:remove", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer for which the data link is updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove a data link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.assetGroupSignals", "type": "folder" }, "items": [ { "info": { "name": "Creates or removes asset group signals", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/assetGroupSignals:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose asset group signals are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or removes asset group signals. Operation statuses are returned." } ] }, { "info": { "name": "customers.keywordPlanCampaigns", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes Keyword Plan campaigns", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/keywordPlanCampaigns:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose Keyword Plan campaigns are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes Keyword Plan campaigns. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [KeywordPlanCampaignError]() [KeywordPlanError]() [ListOperationError]() [MutateError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]()" } ] }, { "info": { "name": "customers.multiPartyAuthReview", "type": "folder" }, "items": [ { "info": { "name": "Resolves the status of a Multi-Party Authorization review", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/multiPartyAuthReview:resolve", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Resolves the status of a Multi-Party Authorization review. List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CustomerUserAccessError]() [FieldError]() [HeaderError]() [InternalError]() [MultiPartyAuthReviewError]() [MutateError]() [QuotaError]() [RangeError]() [RequestError]()" } ] }, { "info": { "name": "customers.campaignCriteria", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes criteria", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignCriteria:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose criteria are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes criteria. Operation statuses are returned. List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]() [CampaignCriterionError]() [CollectionSizeError]() [ContextError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [FunctionError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError](" } ] }, { "info": { "name": "customers.customerAssets", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes customer assets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerAssets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose customer assets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes customer assets. Operation statuses are returned. List of thrown errors: [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.campaigns", "type": "folder" }, "items": [ { "info": { "name": "Enables Brand Guidelines for Performance Max campaigns", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaigns:enablePMaxBrandGuidelines", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaigns are being enabled." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables Brand Guidelines for Performance Max campaigns. List of thrown errors: [AuthenticationError]() [AssetError]() [AssetLinkError]() [AuthorizationError]() [BrandGuidelinesMigrationError]() [CampaignError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()" }, { "info": { "name": "Creates, updates, or removes campaigns", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaigns:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaigns are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes campaigns. Operation statuses are returned. List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [CampaignBudgetError]() [CampaignError]() [ContextError]() [DatabaseError]() [DateError]() [DateRangeError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]() [N" } ] }, { "info": { "name": "customers.adGroupAssetSets", "type": "folder" }, "items": [ { "info": { "name": "Creates, or removes ad group asset sets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroupAssetSets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose ad group asset sets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, or removes ad group asset sets. Operation statuses are returned." } ] }, { "info": { "name": "customers.conversionGoalCampaignConfigs", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes conversion goal campaign config", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/conversionGoalCampaignConfigs:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose custom conversion goals are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes conversion goal campaign config. Operation statuses are returned." } ] }, { "info": { "name": "customers.campaignBudgets", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes campaign budgets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignBudgets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaign budgets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes campaign budgets. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignBudgetError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [OperationAccessDeniedError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()" } ] }, { "info": { "name": "customers.experimentArms", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes experiment arms", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/experimentArms:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose experiments are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes experiment arms. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ExperimentArmError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.campaignAssetSets", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes campaign asset sets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignAssetSets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaign asset sets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes campaign asset sets. Operation statuses are returned." } ] }, { "info": { "name": "customers.adGroupAds", "type": "folder" }, "items": [ { "info": { "name": "Remove automatically created assets from an ad", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroupAds/:adGroupAdsId:removeAutomaticallyCreatedAssets", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "adGroupAd", "value": "", "type": "path", "description": "Required. The resource name of the AdGroupAd from which to remove automatically created assets." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove automatically created assets from an ad. List of thrown errors: [AdError]() [AuthenticationError]() [AuthorizationError]() [AutomaticallyCreatedAssetRemovalError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Creates, updates, or removes ads", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroupAds:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose ads are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes ads. Operation statuses are returned. List of thrown errors: [AdCustomizerError]() [AdError]() [AdGroupAdError]() [AdSharingError]() [AdxError]() [AssetError]() [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [ContextError]() [DatabaseError]() [DateError]() [DistinctError]() [FeedAttributeReferenceError]() [FieldError]() [FieldMaskError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [ImageError]() [" } ] }, { "info": { "name": "customers.adGroups", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes ad groups", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroups:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose ad groups are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes ad groups. Operation statuses are returned. List of thrown errors: [AdGroupError]() [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MultiplierError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [Ope" } ] }, { "info": { "name": "customers.biddingStrategies", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes bidding strategies", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/biddingStrategies:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose bidding strategies are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes bidding strategies. Operation statuses are returned. List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [ContextError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [Rang" } ] }, { "info": { "name": "customers.audiences", "type": "folder" }, "items": [ { "info": { "name": "Creates audiences", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/audiences:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose audiences are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates audiences. Operation statuses are returned. List of thrown errors: [AudienceError]()" } ] }, { "info": { "name": "customers.sharedSets", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes shared sets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/sharedSets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose shared sets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes shared sets. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SharedSetError]() [SizeLimitError]() [StringFo" } ] }, { "info": { "name": "customers.productLinks", "type": "folder" }, "items": [ { "info": { "name": "Creates a product link", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/productLinks:create", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer for which the product link is created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a product link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Removes a product link", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/productLinks:remove", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes a product link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.keywordPlanAdGroupKeywords", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes Keyword Plan ad group keywords", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/keywordPlanAdGroupKeywords:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose Keyword Plan ad group keywords are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes Keyword Plan ad group keywords. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupKeywordError]() [KeywordPlanError]() [MutateError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()" } ] }, { "info": { "name": "customers.adGroupAssets", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes ad group assets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroupAssets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose ad group assets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes ad group assets. Operation statuses are returned. List of thrown errors: [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [NotAllowlistedError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.operations", "type": "folder" }, "items": [ { "info": { "name": "Gets the latest state of a long-running operation", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/customers/:customersId/operations/:operationsId", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation resource." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, { "info": { "name": "Deletes a long-running operation", "type": "http" }, "http": { "method": "DELETE", "url": "https://googleads.googleapis.com/v25/customers/:customersId/operations/:operationsId", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation resource to be deleted." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, { "info": { "name": "Lists operations that match the specified filter in the request", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/customers/:customersId/operations", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "filter", "value": "", "type": "query", "description": "The standard list filter." }, { "name": "pageSize", "value": "", "type": "query", "description": "The standard list page size." }, { "name": "returnPartialSuccess", "value": "", "type": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation's parent resource." }, { "name": "pageToken", "value": "", "type": "query", "description": "The standard list page token." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, { "info": { "name": "Starts asynchronous cancellation on a long-running operation", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/operations/:operationsId:cancel", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation resource to be cancelled." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operati" }, { "info": { "name": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/operations/:operationsId:wait", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation resource to wait on." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (" } ] }, { "info": { "name": "customers.keywordPlanCampaignKeywords", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes Keyword Plan campaign keywords", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/keywordPlanCampaignKeywords:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaign keywords are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes Keyword Plan campaign keywords. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupKeywordError]() [KeywordPlanCampaignKeywordError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()" } ] }, { "info": { "name": "customers.accountBudgetProposals", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes account budget proposals", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/accountBudgetProposals:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes account budget proposals. Operation statuses are returned. List of thrown errors: [AccountBudgetProposalError]() [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() [StringLengthError]()" } ] }, { "info": { "name": "customers.assetSets", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes asset sets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/assetSets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose asset sets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes asset sets. Operation statuses are returned." } ] }, { "info": { "name": "customers.userListCustomerTypes", "type": "folder" }, "items": [ { "info": { "name": "Attach or remove user list customer types", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/userListCustomerTypes:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose user list customer types are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Attach or remove user list customer types. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [UserListCustomerTypeError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.customConversionGoals", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes custom conversion goals", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customConversionGoals:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose custom conversion goals are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes custom conversion goals. Operation statuses are returned." } ] }, { "info": { "name": "customers.customerUserAccessInvitations", "type": "folder" }, "items": [ { "info": { "name": "Creates or removes an access invitation", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerUserAccessInvitations:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose access invitation is being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or removes an access invitation. List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.localServices", "type": "folder" }, "items": [ { "info": { "name": "RPC to append Local Services Lead Conversation resources to Local Services Lead resources.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/localServices:appendLeadConversation", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The Id of the customer which owns the leads onto which the conversations will be appended." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "RPC to append Local Services Lead Conversation resources to Local Services Lead resources." } ] }, { "info": { "name": "customers.customInterests", "type": "folder" }, "items": [ { "info": { "name": "Creates or updates custom interests", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customInterests:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose custom interests are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates custom interests. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CriterionError]() [CustomInterestError]() [HeaderError]() [InternalError]() [MutateError]() [PolicyViolationError]() [QuotaError]() [RequestError]() [StringLengthError]()" } ] }, { "info": { "name": "customers.assetGroupAssets", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes asset group assets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/assetGroupAssets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose asset group assets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes asset group assets. Operation statuses are returned." } ] }, { "info": { "name": "customers.customerManagerLinks", "type": "folder" }, "items": [ { "info": { "name": "Moves a client customer to a new manager customer", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerManagerLinks:moveManagerLink", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the client customer that is being moved." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Moves a client customer to a new manager customer. This simplifies the complex request that requires two operations to move a client customer to a new manager, for example: 1. Update operation with Status INACTIVE (previous manager) and, 2. Update operation with Status ACTIVE (new manager). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Updates customer manager links", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerManagerLinks:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose customer manager links are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates customer manager links. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.sharedCriteria", "type": "folder" }, "items": [ { "info": { "name": "Creates or removes shared criteria", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/sharedCriteria:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose shared criteria are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or removes shared criteria. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()" } ] }, { "info": { "name": "customers.customerSkAdNetworkConversionValueSchemas", "type": "folder" }, "items": [ { "info": { "name": "Creates or updates the CustomerSkAdNetworkConversionValueSchema", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerSkAdNetworkConversionValueSchemas:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "The ID of the customer whose shared sets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates the CustomerSkAdNetworkConversionValueSchema. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [InternalError]() [MutateError]()" } ] }, { "info": { "name": "customers.thirdPartyAppAnalyticsLinks", "type": "folder" }, "items": [ { "info": { "name": "Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be provided to the third party when setting up app analytics", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/thirdPartyAppAnalyticsLinks/:thirdPartyAppAnalyticsLinksId:regenerateShareableLinkId", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Resource name of the third party app analytics link." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be provided to the third party when setting up app analytics. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.campaignDrafts", "type": "folder" }, "items": [ { "info": { "name": "Promotes the changes in a draft back to the base campaign", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignDrafts/:campaignDraftsId:promote", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "campaignDraft", "value": "", "type": "path", "description": "Required. The resource name of the campaign draft to promote." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Promotes the changes in a draft back to the base campaign. This method returns a Long Running Operation (LRO) indicating if the Promote is done. Use google.longrunning.Operations.GetOperation to poll the LRO until it is done. Only a done status is returned in the response. See the status in the Campaign Draft resource to determine if the promotion was successful. If the LRO failed, use CampaignDraftService.ListCampaignDraftAsyncErrors to view the list of error reasons. List of thrown errors: [Au" }, { "info": { "name": "Returns all errors that occurred during CampaignDraft promote", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignDrafts/:campaignDraftsId:listAsyncErrors", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The name of the campaign draft from which to retrieve the async errors." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of elements to retrieve in a single page. When a page request is too large, the server may decide to further limit the number of returned resources." }, { "name": "pageToken", "value": "", "type": "query", "description": "Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from `next_page_token` in the previous response in order to request the next page of results." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all errors that occurred during CampaignDraft promote. Throws an error if called before campaign draft is promoted. Supports standard list paging. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Creates, updates, or removes campaign drafts", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignDrafts:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaign drafts are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes campaign drafts. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignDraftError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.CustomerCustomizers", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes customer customizers", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/CustomerCustomizers:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose customer customizers are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes customer customizers. Operation statuses are returned." } ] }, { "info": { "name": "customers.billingSetups", "type": "folder" }, "items": [ { "info": { "name": "Creates a billing setup, or cancels an existing billing setup", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/billingSetups:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. Id of the customer to apply the billing setup mutate operation to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a billing setup, or cancels an existing billing setup. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BillingSetupError]() [DateError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.AdGroupCriterionCustomizers", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes ad group criterion customizers", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/AdGroupCriterionCustomizers:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose ad group criterion customizers are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes ad group criterion customizers. Operation statuses are returned." } ] }, { "info": { "name": "customers.campaignAssets", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes campaign assets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignAssets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaign assets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes campaign assets. Operation statuses are returned. List of thrown errors: [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [NotAllowlistedError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.conversionActions", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes conversion actions", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/conversionActions:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose conversion actions are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes conversion actions. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ConversionActionError]() [CurrencyCodeError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()" } ] }, { "info": { "name": "customers.productLinkInvitations", "type": "folder" }, "items": [ { "info": { "name": "Remove a product link invitation.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/productLinkInvitations:remove", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the product link invitation being removed." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove a product link invitation." }, { "info": { "name": "Update a product link invitation.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/productLinkInvitations:update", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a product link invitation." }, { "info": { "name": "Creates a product link invitation.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/productLinkInvitations:create", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a product link invitation." } ] }, { "info": { "name": "customers.adGroupCriterionLabels", "type": "folder" }, "items": [ { "info": { "name": "Creates and removes ad group criterion labels", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroupCriterionLabels:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose ad group criterion labels are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates and removes ad group criterion labels. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.offlineUserDataJobs", "type": "folder" }, "items": [ { "info": { "name": "Creates an offline user data job", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/offlineUserDataJobs:create", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer for which to create an offline user data job." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an offline user data job. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [NotAllowlistedError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Adds operations to the offline user data job", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/offlineUserDataJobs/:offlineUserDataJobsId:addOperations", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The resource name of the OfflineUserDataJob." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds operations to the offline user data job. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Runs the offline user data job", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/offlineUserDataJobs/:offlineUserDataJobsId:run", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The resource name of the OfflineUserDataJob to run." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Runs the offline user data job. When finished, the long running operation will contain the processing result or failure information, if any. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [HeaderError]() [InternalError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.customerClientLinks", "type": "folder" }, "items": [ { "info": { "name": "Creates or updates a customer client link", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerClientLinks:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose customer link are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates a customer client link. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.assetGroupListingGroupFilters", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes asset group listing group filters", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/assetGroupListingGroupFilters:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose asset group listing group filters are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes asset group listing group filters. Operation statuses are returned." } ] }, { "info": { "name": "customers.customAudiences", "type": "folder" }, "items": [ { "info": { "name": "Creates or updates custom audiences", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customAudiences:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose custom audiences are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates custom audiences. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CustomAudienceError]() [CustomInterestError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [OperationAccessDeniedError]() [PolicyViolationError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.adGroupBidModifiers", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes ad group bid modifiers", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroupBidModifiers:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose ad group bid modifiers are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes ad group bid modifiers. Operation statuses are returned. List of thrown errors: [AdGroupBidModifierError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() " } ] }, { "info": { "name": "customers.campaignCustomizers", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes campaign customizers", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignCustomizers:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaign customizers are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes campaign customizers. Operation statuses are returned." } ] }, { "info": { "name": "customers.adGroupAdLabels", "type": "folder" }, "items": [ { "info": { "name": "Creates and removes ad group ad labels", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroupAdLabels:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose ad group ad labels are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates and removes ad group ad labels. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [HeaderError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.customerNegativeCriteria", "type": "folder" }, "items": [ { "info": { "name": "Creates or removes criteria", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerNegativeCriteria:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose criteria are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or removes criteria. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CriterionError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.keywordPlans", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes keyword plans", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/keywordPlans:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose keyword plans are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes keyword plans. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()" } ] }, { "info": { "name": "customers.CampaignGoalConfigs", "type": "folder" }, "items": [ { "info": { "name": "Create or update campaign goal configs", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/CampaignGoalConfigs:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaign goal configs are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create or update campaign goal configs. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [CampaignGoalConfigError]()" } ] }, { "info": { "name": "customers.paymentsAccounts", "type": "folder" }, "items": [ { "info": { "name": "Returns all payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/customers/:customersId/paymentsAccounts", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer to apply the PaymentsAccount list operation to." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PaymentsAccountError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.campaignSharedSets", "type": "folder" }, "items": [ { "info": { "name": "Creates or removes campaign shared sets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignSharedSets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaign shared sets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or removes campaign shared sets. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignSharedSetError]() [ContextError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError" } ] }, { "info": { "name": "customers.labels", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes labels", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/labels:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose labels are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes labels. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError" } ] }, { "info": { "name": "customers.accountLinks", "type": "folder" }, "items": [ { "info": { "name": "Creates an account link", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/accountLinks:create", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer for which the account link is created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an account link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() [ThirdPartyAppAnalyticsLinkError]()" }, { "info": { "name": "Creates or removes an account link", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/accountLinks:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or removes an account link. From V5, create is not supported through AccountLinkService.MutateAccountLink. Use AccountLinkService.CreateAccountLink instead. List of thrown errors: [AccountLinkError]() [AuthenticationError]() [AuthorizationError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.experiments", "type": "folder" }, "items": [ { "info": { "name": "Schedule an experiment", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/experiments/:experimentsId:scheduleExperiment", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The scheduled experiment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Schedule an experiment. The in design campaign will be converted into a real campaign (called the experiment campaign) that will begin serving ads if successfully created. The experiment is scheduled immediately with status INITIALIZING. This method returns a long running operation that tracks the forking of the in design campaign. If the forking fails, a list of errors can be retrieved using the ListExperimentAsyncErrors method. The operation's metadata will be a string containing the resource " }, { "info": { "name": "Graduates an experiment to a full campaign", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/experiments/:experimentsId:graduateExperiment", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "experiment", "value": "", "type": "path", "description": "Required. The experiment to be graduated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Graduates an experiment to a full campaign. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ExperimentError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Promotes the trial campaign thus applying changes in the trial campaign to the base campaign", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/experiments/:experimentsId:promoteExperiment", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The resource name of the experiment to promote." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Promotes the trial campaign thus applying changes in the trial campaign to the base campaign. This method returns a long running operation that tracks the promotion of the experiment campaign. If it fails, a list of errors can be retrieved using the ListExperimentAsyncErrors method. The operation's metadata will be a string containing the resource name of the created experiment. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ExperimentError]() [HeaderError]() [InternalErr" }, { "info": { "name": "Creates, updates, or removes experiments", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/experiments:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose experiments are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes experiments. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ExperimentError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Immediately ends an experiment, changing the experiment's scheduled end date and without waiting for end of day", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/experiments/:experimentsId:endExperiment", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "experiment", "value": "", "type": "path", "description": "Required. The resource name of the campaign experiment to end." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Immediately ends an experiment, changing the experiment's scheduled end date and without waiting for end of day. End date is updated to be the time of the request. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ExperimentError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns all errors that occurred during the last Experiment update (either scheduling or promotion)", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/customers/:customersId/experiments/:experimentsId:listExperimentAsyncErrors", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "pageToken", "value": "", "type": "query", "description": "Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from `next_page_token` in the previous response in order to request the next page of results." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The name of the experiment from which to retrieve the async errors." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of elements to retrieve in a single page. When a page request is too large, the server may decide to further limit the number of returned resources. The maximum page size is 1000." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all errors that occurred during the last Experiment update (either scheduling or promotion). Supports standard list paging. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.batchJobs", "type": "folder" }, "items": [ { "info": { "name": "Runs the batch job", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/batchJobs/:batchJobsId:run", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The resource name of the BatchJob to run." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Runs the batch job. The Operation.metadata field type is BatchJobMetadata. When finished, the long running operation will not contain errors or a response. Instead, use ListBatchJobResults to get the results of the job. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Add operations to the batch job", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/batchJobs/:batchJobsId:addOperations", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The resource name of the batch job." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add operations to the batch job. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()" }, { "info": { "name": "Mutates a batch job", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/batchJobs:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer for which to create a batch job." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Mutates a batch job. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()" }, { "info": { "name": "Returns the results of the batch job", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/customers/:customersId/batchJobs/:batchJobsId:listResults", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The resource name of the batch job whose results are being listed." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of elements to retrieve in a single page. The default and the page_size limit is 1000. A value of 0 or an unset page size will be defaulted to 1000. A page size less than 0 or greater than 1000 will result in an INVALID_PAGE_SIZE error." }, { "name": "pageToken", "value": "", "type": "query", "description": "Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from `next_page_token` in the previous response in order to request the next page of results." }, { "name": "responseContentType", "value": "", "type": "query", "description": "The response content type setting. Determines whether the mutable resource or just the resource name should be returned." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the results of the batch job. The job must be done. Supports standard list paging. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.adGroupCriteria", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes criteria", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroupCriteria:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose criteria are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes criteria. Operation statuses are returned. List of thrown errors: [AdGroupCriterionError]() [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [CollectionSizeError]() [ContextError]() [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MultiplierError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [Nul" } ] }, { "info": { "name": "customers.googleAds", "type": "folder" }, "items": [ { "info": { "name": "Executes mutate and actions operations", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/googleAds:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose resources are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Executes mutate and actions operations. Mutate operations create, update, or remove resources. Actions perform custom operations. This method supports atomic transactions with multiple types of resources and actions. For example, you can atomically create a campaign and a campaign budget, or perform up to thousands of mutates atomically. This method is essentially a wrapper around a series of mutate methods. The only features it offers over calling those methods directly are: - Atomic transactio" }, { "info": { "name": "Returns all rows that match the search query", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/googleAds:search", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer being queried." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ChangeEventError]() [ChangeStatusError]() [ClickViewError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns all rows that match the search stream query", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/googleAds:searchStream", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer being queried." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all rows that match the search stream query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ChangeEventError]() [ChangeStatusError]() [ClickViewError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.keywordPlanAdGroups", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes Keyword Plan ad groups", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/keywordPlanAdGroups:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose Keyword Plan ad groups are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes Keyword Plan ad groups. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()" } ] }, { "info": { "name": "customers.Goals", "type": "folder" }, "items": [ { "info": { "name": "Create or update goals", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/Goals:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose goals are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create or update goals. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [GoalError]()" } ] }, { "info": { "name": "customers.assetSetAssets", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes asset set assets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/assetSetAssets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose asset set assets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes asset set assets. Operation statuses are returned." } ] }, { "info": { "name": "customers.conversionValueRules", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes conversion value rules", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/conversionValueRules:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose conversion value rules are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes conversion value rules. Operation statuses are returned." } ] }, { "info": { "name": "customers.smartCampaignSettings", "type": "folder" }, "items": [ { "info": { "name": "Returns the status of the requested Smart campaign.", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/customers/:customersId/smartCampaignSettings/:smartCampaignSettingsId:getSmartCampaignStatus", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The resource name of the Smart campaign setting belonging to the Smart campaign to fetch the status of." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the status of the requested Smart campaign." }, { "info": { "name": "Updates Smart campaign settings for campaigns.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/smartCampaignSettings:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose Smart campaign settings are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates Smart campaign settings for campaigns." } ] }, { "info": { "name": "customers.incentives", "type": "folder" }, "items": [ { "info": { "name": "Applies the incentive for the ads customer.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/incentives/:incentivesId:applyIncentive", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The customer ID of the account that the incentive is being applied to." }, { "name": "selectedIncentiveId", "value": "", "type": "path", "description": "Required. The incentive ID of this incentive. This is used to identify which incentive is selected by the user in the CYO flow." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Applies the incentive for the ads customer." } ] }, { "info": { "name": "customers.customerUserAccesses", "type": "folder" }, "items": [ { "info": { "name": "Updates, removes permission of a user on a given customer", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerUserAccesses:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates, removes permission of a user on a given customer. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CustomerUserAccessError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.customerLabels", "type": "folder" }, "items": [ { "info": { "name": "Creates and removes customer-label relationships", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerLabels:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose customer-label relationships are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates and removes customer-label relationships. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [HeaderError]() [InternalError]() [LabelError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.assetGroups", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes asset groups", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/assetGroups:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose asset groups are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes asset groups. Operation statuses are returned." } ] }, { "info": { "name": "customers.campaignConversionGoals", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes campaign conversion goals", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/campaignConversionGoals:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose campaign conversion goals are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes campaign conversion goals. Operation statuses are returned." } ] }, { "info": { "name": "customers.customerAssetSets", "type": "folder" }, "items": [ { "info": { "name": "Creates, or removes customer asset sets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customerAssetSets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose customer asset sets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, or removes customer asset sets. Operation statuses are returned." } ] }, { "info": { "name": "customers.invoices", "type": "folder" }, "items": [ { "info": { "name": "Returns all invoices associated with a billing setup, for a given month", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/customers/:customersId/invoices", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "billingSetup", "value": "", "type": "query", "description": "Required. The billing setup resource name of the requested invoices. `customers/{customer_id}/billingSetups/{billing_setup_id}`" }, { "name": "issueMonth", "value": "", "type": "query", "description": "Required. The issue month to retrieve invoices." }, { "name": "issueYear", "value": "", "type": "query", "description": "Required. The issue year to retrieve invoices, in yyyy format. Only invoices issued in 2019 or later can be retrieved." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer to fetch invoices for." }, { "name": "includeGranularLevelInvoiceDetails", "value": "", "type": "query", "description": "Optional. When true, the response will include more granular level invoice details such as campaign level cost breakdown, itemized regulatory costs and adjustments. The default value is false." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all invoices associated with a billing setup, for a given month. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [InvoiceError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.assetGenerations", "type": "folder" }, "items": [ { "info": { "name": "Uses generative AI to generate text that can be used as assets in a campaign", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/assetGenerations:generateText", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer to generate assets for. Required." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uses generative AI to generate text that can be used as assets in a campaign. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [AssetGenerationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Uses generative AI to generate images that can be used as assets in a campaign", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/assetGenerations:generateImages", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer for whom the images are being generated. Required." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uses generative AI to generate images that can be used as assets in a campaign. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [AssetGenerationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.biddingDataExclusions", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes data exclusions", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/biddingDataExclusions:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose data exclusions are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes data exclusions. Operation statuses are returned." } ] }, { "info": { "name": "customers.conversionValueRuleSets", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes conversion value rule sets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/conversionValueRuleSets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose conversion value rule sets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes conversion value rule sets. Operation statuses are returned." } ] }, { "info": { "name": "customers.customizerAttributes", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates or removes customizer attributes", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/customizerAttributes:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose customizer attributes are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates or removes customizer attributes. Operation statuses are returned." } ] }, { "info": { "name": "customers.adGroupLabels", "type": "folder" }, "items": [ { "info": { "name": "Creates and removes ad group labels", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adGroupLabels:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose ad group labels are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates and removes ad group labels. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.reservations", "type": "folder" }, "items": [ { "info": { "name": "Proposes quotes for booking campaigns", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/reservations:quoteCampaigns", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer making the request." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Proposes quotes for booking campaigns. This request can have a latency of 30 seconds." }, { "info": { "name": "Books the requested campaigns", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/reservations:bookCampaigns", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer making the request." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Books the requested campaigns. This request can have a latency of 30 seconds." } ] }, { "info": { "name": "customers.youTubeVideoUploads", "type": "folder" }, "items": [ { "info": { "name": "Updates YouTube video's metadata, but only for videos uploaded using this API.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/youTubeVideoUploads:update", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The customer ID requesting the YouTube video upload update. Required." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates YouTube video's metadata, but only for videos uploaded using this API." }, { "info": { "name": "Removes YouTube videos uploaded using this API.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/youTubeVideoUploads:remove", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The customer ID requesting the YouTube video upload deletion. Required." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes YouTube videos uploaded using this API." } ] }, { "info": { "name": "customers.biddingSeasonalityAdjustments", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes seasonality adjustments", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/biddingSeasonalityAdjustments:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. ID of the customer whose seasonality adjustments are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes seasonality adjustments. Operation statuses are returned." } ] }, { "info": { "name": "customers.adParameters", "type": "folder" }, "items": [ { "info": { "name": "Creates, updates, or removes ad parameters", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/adParameters:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose ad parameters are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates, updates, or removes ad parameters. Operation statuses are returned. List of thrown errors: [AdParameterError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "customers.assets", "type": "folder" }, "items": [ { "info": { "name": "Creates assets", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/assets:mutate", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The ID of the customer whose assets are being modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates assets. Operation statuses are returned. List of thrown errors: [AssetError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [CurrencyCodeError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MediaUploadError]() [MutateError]() [NotAllowlistedError]() [NotEmptyError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [Str" } ] }, { "info": { "name": "audienceInsights", "type": "folder" }, "items": [ { "info": { "name": "Lists date ranges for which audience insights data can be requested", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/audienceInsights:listInsightsEligibleDates", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists date ranges for which audience insights data can be requested. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()" } ] }, { "info": { "name": "geoTargetConstants", "type": "folder" }, "items": [ { "info": { "name": "Returns GeoTargetConstant suggestions by location name or by resource name", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/geoTargetConstants:suggest", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns GeoTargetConstant suggestions by location name or by resource name. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [GeoTargetConstantSuggestionError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "keywordThemeConstants", "type": "folder" }, "items": [ { "info": { "name": "Returns KeywordThemeConstant suggestions by keyword themes", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/keywordThemeConstants:suggest", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns KeywordThemeConstant suggestions by keyword themes. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "v25", "type": "folder" }, "items": [ { "info": { "name": "Returns the list of locations that support benchmarks (for example, countries)", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25:listBenchmarksLocations", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the list of locations that support benchmarks (for example, countries). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns the list of per-location plannable YouTube ad formats with allowed targeting", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25:listPlannableProducts", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the list of per-location plannable YouTube ad formats with allowed targeting. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns a collection of conversion rate suggestions for supported plannable products", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25:generateConversionRates", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a collection of conversion rate suggestions for supported plannable products. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns a date range that supports benchmarks", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25:listBenchmarksAvailableDates", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a date range that supports benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns the list of plannable user lists with their plannable status", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25:listPlannableUserLists", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the list of plannable user lists with their plannable status. User lists may not be plannable for a number of reasons, including: - They are less than 10 days old. - They have a membership lifespan that is less than 30 days - They have less than 10,000 or more than 700,000 users. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [ReachPlanError]() [RequestError]()" }, { "info": { "name": "Returns the list of plannable user interests", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25:listPlannableUserInterests", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the list of plannable user interests. A plannable user interest is one that can be targeted in a reach forecast using ReachPlanService.GenerateReachForecast. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [ListOperationError]() [QuotaError]() [RequestError]() [StringLengthError]()" }, { "info": { "name": "Returns the list of products that supports benchmarks", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25:listBenchmarksProducts", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the list of products that supports benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns the list of plannable locations (for example, countries)", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25:listPlannableLocations", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the list of plannable locations (for example, countries). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns the list of benchmarks sources (for example, Industry Verticals)", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25:listBenchmarksSources", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the list of benchmarks sources (for example, Industry Verticals). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "googleAdsFields", "type": "folder" }, "items": [ { "info": { "name": "Returns just the requested field", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/googleAdsFields/:googleAdsFieldsId", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "resourceName", "value": "", "type": "path", "description": "Required. The resource name of the field to get." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns just the requested field. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()" }, { "info": { "name": "Returns all fields that match the search query", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/googleAdsFields:search", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all fields that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()" } ] }, { "info": { "name": "media", "type": "folder" }, "items": [ { "info": { "name": "Uploads a video to Google-managed or advertiser owned (brand) YouTube channel.", "type": "http" }, "http": { "method": "POST", "url": "https://googleads.googleapis.com/v25/customers/:customersId/youTubeVideoUploads:create", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "customerId", "value": "", "type": "path", "description": "Required. The customer ID requesting the upload. Required." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uploads a video to Google-managed or advertiser owned (brand) YouTube channel." } ] }, { "info": { "name": "incentives", "type": "folder" }, "items": [ { "info": { "name": "Returns incentives for a given user.", "type": "http" }, "http": { "method": "GET", "url": "https://googleads.googleapis.com/v25/incentives:fetchIncentive", "params": [ { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "quotaUser", "value": "", "type": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "key", "value": "", "type": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "languageCode", "value": "", "type": "query", "description": "Optional. User's language code. If not provided, the server will default to \"en\". Possible language codes: https://developers.google.com/google-ads/api/data/codes-formats#languages" }, { "name": "countryCode", "value": "", "type": "query", "description": "Optional. User's country code. If not provided, the server will default to \"US\". Possible country codes: https://developers.google.com/google-ads/api/data/codes-formats#country_codes" }, { "name": "email", "value": "", "type": "query", "description": "Optional. Email of the user that the requested incentive is meant for. Will be used for channel partners who do NOT use OAuth to authenticate on behalf of user." }, { "name": "incentiveType", "value": "", "type": "query", "description": "Optional. The type of incentive to get. Defaults to ACQUISITION." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns incentives for a given user." } ] } ], "bundled": true }