### ConfigureCampaignLifecycleGoals Request Body Example Source: https://developers.google.com/google-ads/api/reference/rpc/v24/CampaignLifecycleGoalService/ConfigureCampaignLifecycleGoals This snippet shows a basic structure for the request body when configuring campaign lifecycle goals. It's a starting point for adding specific parameters. ```json { "add request body parameters" } ``` -------------------------------- ### BillingSetupOperation.create Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BillingSetupOperation Creates a billing setup. No resource name is expected for the new billing setup. ```APIDOC ## `create` Creates a billing setup. No resource name is expected for the new billing setup. ``` -------------------------------- ### Billing Setup Source: https://developers.google.com/google-ads/api/reference/rpc/v24/GoogleAdsRow Represents the billing setup referenced in the query. ```APIDOC ## `billing_setup` ### Description The billing setup referenced in the query. ### Resource `BillingSetup` ``` -------------------------------- ### BillingSetup Source: https://developers.google.com/google-ads/api/reference/rpc/v24/GoogleAdsRow A billing setup. ```APIDOC ## `billing_setup` ### Description A billing setup. ### Proto definition `BillingSetup` ``` -------------------------------- ### biddable_app_install_conversions Source: https://developers.google.com/google-ads/api/reference/rpc/v24/Metrics The number of app installs that are considered biddable. ```APIDOC ## `biddable_app_install_conversions` ### Description Number of app installs. ### Type double ``` -------------------------------- ### CreateAccountLink Request Body Example Source: https://developers.google.com/google-ads/api/reference/rpc/v24/AccountLinkService/CreateAccountLink An example of the request body structure for the CreateAccountLink method. Use this as a template to add your specific parameters. ```json { Add request body parameters } ``` -------------------------------- ### LegacyAppInstallAdAppStore Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview App store type in a legacy app install ad. ```APIDOC ## LegacyAppInstallAdAppStore ### Description App store type in a legacy app install ad. ### Enum Values (Values not specified in source) ``` -------------------------------- ### ScheduleExperiment Source: https://developers.google.com/google-ads/api/reference/rpc/v24/ExperimentService Schedules an experiment to start at a future date. This allows for planning and automating the rollout of experiments. ```APIDOC ## ScheduleExperiment ### Description Schedules an experiment to start at a future date. ### Method POST ### Endpoint /ExperimentService:ScheduleExperiment ### Request Body - **customer_id** (string) - Required - The ID of the customer whose experiment is being scheduled. - **experiment** (string) - Required - The resource name of the experiment to schedule. - **start_date** (string) - Required - The date on which the experiment should start, in YYYY-MM-DD format. ### Response #### Success Response (200) - **experiment** (object) - The scheduled experiment. #### Response Example ```json { "experiment": { "resourceName": "customers/1234567890/experiments/1122334455", "status": "SCHEDULED", "start_date": "2024-01-01" } } ``` ``` -------------------------------- ### BillingSetupOperation.remove Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BillingSetupOperation Removes a billing setup. A setup cannot be removed unless it is in a pending state or its scheduled start time is in the future. The resource name looks like customers/{customer_id}/billingSetups/{billing_id}. ```APIDOC ## `remove` Resource name of the billing setup to remove. A setup cannot be removed unless it is in a pending state or its scheduled start time is in the future. The resource name looks like `customers/{customer_id}/billingSetups/{billing_id}`. ``` -------------------------------- ### BillingSetup Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser. ```APIDOC ## BillingSetup ### Description A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser. ### Resource BillingSetup ``` -------------------------------- ### biddable_indirect_install_first_in_app_conversion_micros Source: https://developers.google.com/google-ads/api/reference/rpc/v24/Metrics The number of biddable first in-app conversions where the app install was driven by interaction with a web campaign. Value is in micros. ```APIDOC ## `biddable_indirect_install_first_in_app_conversion_micros` ### Description The number of biddable first in app conversions where the app install was driven by interaction with a web campaign. ### Type int64 ``` -------------------------------- ### LegacyAppInstallAdAppStoreEnum Source: https://developers.google.com/google-ads/api/reference/rpc/v24/LegacyAppInstallAdAppStoreEnum.LegacyAppInstallAdAppStore Enum values representing different app stores for legacy app install ads. ```APIDOC ## Enum: LegacyAppInstallAdAppStoreEnum ### Description Represents the type of app store for a legacy app install ad. ### Enum Values * **`APPLE_APP_STORE`**: Apple iTunes. * **`CN_APP_STORE`**: The app is hosted in a Chinese app store. * **`GOOGLE_PLAY`**: Google Play. * **`UNKNOWN`**: Used for return value only. Represents value unknown in this version. * **`UNSPECIFIED`**: Not specified. * **`WINDOWS_PHONE_STORE`**: Windows Phone Store. * **`WINDOWS_STORE`**: Windows Store. ``` -------------------------------- ### payments_profile_id Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BillingSetup.PaymentsAccountInfo A 12 digit ID used to identify the payments profile associated with the billing setup. This must be passed in as a string with dashes, for example, "1234-5678-9012". ```APIDOC ## `payments_profile_id` ### Description Immutable. A 12 digit id used to identify the payments profile associated with the billing setup. This must be passed in as a string with dashes, for example, "1234-5678-9012". ### Type `string` ``` -------------------------------- ### payments_account_id Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BillingSetup.PaymentsAccountInfo A 16 digit ID used to identify the payments account associated with the billing setup. This must be passed as a string with dashes, for example, "1234-5678-9012-3456". ```APIDOC ## `payments_account_id` ### Description Output only. A 16 digit id used to identify the payments account associated with the billing setup. This must be passed as a string with dashes, for example, "1234-5678-9012-3456". ### Type `string` ``` -------------------------------- ### LegacyAppInstallAdInfo Fields Source: https://developers.google.com/google-ads/api/reference/rpc/v24/LegacyAppInstallAdInfo This section details the fields available for the LegacyAppInstallAdInfo proto definition. ```APIDOC ## `app_id` | `string` The ID of the mobile app. ## `app_store` | `LegacyAppInstallAdAppStore` The app store the mobile app is available in. ## `description1` | `string` The first description line of the ad. ## `description2` | `string` The second description line of the ad. ## `headline` | `string` The headline of the ad. ``` -------------------------------- ### MutateBillingSetup Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BillingSetupService Mutates billing setups. The REMOVE operation cancels a pending billing setup, and the CREATE operation creates a new billing setup. ```APIDOC ## MutateBillingSetup ### Description Mutates billing setups. The REMOVE operation cancels a pending billing setup, and the CREATE operation creates a new billing setup. ### Method POST ### Endpoint /v24/billingSetups:mutate ### Request Body - **operations** (array) - Required - A list of operations to perform. - **operation** (object) - Required - The operation to perform. - **create** (object) - Optional - Creates a new billing setup. - **customer_id** (string) - Required - The ID of the customer. - **billing_setup** (object) - Required - The billing setup to create. - **payments_account_id** (string) - Required - The ID of the payments account. - **billing_account_id** (string) - Required - The ID of the billing account. - **display_name** (string) - Optional - The display name of the billing setup. - **primary_billing_gateway** (string) - Optional - The primary billing gateway. - **secondary_billing_gateway** (string) - Optional - The secondary billing gateway. - **payments_account_type** (string) - Optional - The type of payments account. - **currency_code** (string) - Optional - The currency code. - **billing_setup_status** (string) - Optional - The status of the billing setup. - **payments_account_info** (object) - Optional - Information about the payments account. - **payments_account_id** (string) - Required - The ID of the payments account. - **payments_account_name** (string) - Required - The name of the payments account. - **payments_account_type** (string) - Required - The type of payments account. - **payments_profile_id** (string) - Required - The ID of the payments profile. - **payments_profile_name** (string) - Required - The name of the payments profile. - **remove** (string) - Optional - The resource name of the billing setup to remove. ### Response #### Success Response (200) - **results** (array) - A list of results for each operation. - **operation** (object) - The operation that was performed. - **create** (object) - The created billing setup. - **resource_name** (string) - The resource name of the billing setup. - **remove** (string) - The resource name of the removed billing setup. - **partial_failure_error** (object) - Details about a partial failure, if any. - **code** (integer) - Error code. - **message** (string) - Error message. - **details** (array) - Additional error details. ### Request Example ```json { "operations": [ { "create": { "customer_id": "1234567890", "billing_setup": { "payments_account_id": "1234567890", "billing_account_id": "1234567890", "display_name": "My Billing Setup" } } } ] } ``` ### Response Example ```json { "results": [ { "operation": { "create": { "resource_name": "customers/1234567890/billingSetups/1" } } } ] } ``` ``` -------------------------------- ### biddable_app_post_install_conversions Source: https://developers.google.com/google-ads/api/reference/rpc/v24/Metrics The number of in-app actions that are considered biddable. ```APIDOC ## `biddable_app_post_install_conversions` ### Description Number of in-app actions. ### Type double ``` -------------------------------- ### BillingSetupOperation Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview A single operation on a billing setup, which describes the cancellation of an existing billing setup. ```APIDOC ## BillingSetupOperation ### Description A single operation on a billing setup, which describes the cancellation of an existing billing setup. ### Parameters (No specific parameters documented in the source text) ### Request Example (No request example provided in the source text) ### Response (No specific response documented in the source text) ``` -------------------------------- ### ListBenchmarksProducts Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BenchmarksService/ListBenchmarksProducts Returns the list of products that supports benchmarks. ```APIDOC ## ListBenchmarksProducts ### Description Returns the list of products that supports benchmarks. ### Method rpc ### Endpoint ListBenchmarksProducts ### Request Body ```json { "add request body parameters" } ``` ### Response #### Success Response (200) - **ListBenchmarksProductsResponse** (object) - Response object containing the list of benchmarkable products. ### Errors - AuthenticationError - AuthorizationError - FieldError - HeaderError - InternalError - QuotaError - RequestError ### Authorization Requires the following OAuth scope: - `https://www.googleapis.com/auth/adwords` ``` -------------------------------- ### BillingSetupService Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview A service for designating the business entity responsible for accrued costs. A billing setup is associated with a payments account. Billing-related activity for all billing setups associated with a particular payments account will appear on a single invoice generated monthly. Mutates: The REMOVE operation cancels a pending billing setup. The CREATE operation creates a new billing setup. ```APIDOC ## BillingSetupService ### Description Designates the business entity responsible for accrued costs. A billing setup is linked to a payments account, and all associated billing activity appears on a single monthly invoice. Mutates: CREATE creates a new billing setup. REMOVE cancels a pending billing setup. ``` -------------------------------- ### ApplyRecommendationOperation.TargetRoasOptInParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Parameters to use when applying a Target ROAS opt-in recommendation. ```APIDOC ## ApplyRecommendationOperation.TargetRoasOptInParameters ### Description Parameters to use when applying a Target ROAS opt-in recommendation. ### Parameters (No specific parameters documented in the source text) ### Request Example (No request example provided in the source text) ### Response (No specific response documented in the source text) ``` -------------------------------- ### ApplyRecommendationOperation.ResponsiveSearchAdAssetParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Parameters to use when applying a responsive search ad asset recommendation. ```APIDOC ## ApplyRecommendationOperation.ResponsiveSearchAdAssetParameters ### Description Parameters to use when applying a responsive search ad asset recommendation. ### Method Not applicable (Data structure definition) ### Endpoint Not applicable (Data structure definition) ``` -------------------------------- ### MutateAssetGroups Request Body Example Source: https://developers.google.com/google-ads/api/reference/rpc/v24/AssetGroupService/MutateAssetGroups An example of the request body structure for the MutateAssetGroups method. Use this as a template for creating or modifying asset groups. ```json { "customerId": "1234567890", "assetGroups": [ { "assetGroup": { "name": "customers/1234567890/assetGroups/1111111111", "campaign": "customers/1234567890/campaigns/2222222222", "displayName": "My Asset Group", "status": "ENABLED" }, "updateMask": "displayName,status" } ] } ``` -------------------------------- ### BudgetSimulationPointList Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview A container for simulation points for simulations of type BUDGET. ```APIDOC ## BudgetSimulationPointList ### Description A container for simulation points for simulations of type BUDGET. ### Type Object ``` -------------------------------- ### SmartCampaignSettingService Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Service to manage Smart campaign settings. ```APIDOC ## SmartCampaignSettingService ### Description Service to manage Smart campaign settings. ### Method Not specified (RPC service) ### Endpoint Not specified (RPC service) ``` -------------------------------- ### GenderType Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview The type of demographic genders (for example, female). ```APIDOC ## GenderType ### Description The type of demographic genders (for example, female). ### Enum Values (Values not specified in source) ``` -------------------------------- ### FetchIncentiveRequest Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Request for getting the acquisition incentive for a user. ```APIDOC ## FetchIncentiveRequest ### Description Request for getting the acquisition incentive for a user. ### Method Not specified (RPC Request) ### Endpoint Not specified (RPC Request) ``` -------------------------------- ### SmartCampaignSetting Source: https://developers.google.com/google-ads/api/reference/rpc/v24/GoogleAdsRow The smart campaign setting. ```APIDOC ## `smart_campaign_setting` ### Description The smart campaign setting. ### Proto definition `SmartCampaignSetting` ``` -------------------------------- ### SmartCampaignSuggestService Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Service to get suggestions for Smart Campaigns. ```APIDOC ## SmartCampaignSuggestService ### Description Service to get suggestions for Smart Campaigns. ### Method Not specified (RPC service) ### Endpoint Not specified (RPC service) ``` -------------------------------- ### AppUrlOperatingSystemType Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Operating System. ```APIDOC enum AppUrlOperatingSystemType ``` -------------------------------- ### ApplyRecommendationOperation.LeadFormAssetParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Parameters to use when applying a lead form asset recommendation. ```APIDOC ## ApplyRecommendationOperation.LeadFormAssetParameters ### Description Parameters to use when applying a lead form asset recommendation. ### Method Not applicable (Data structure definition) ### Endpoint Not applicable (Data structure definition) ``` -------------------------------- ### ApplyRecommendationOperation.SitelinkAssetParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Parameters to use when applying sitelink asset recommendations. ```APIDOC ## ApplyRecommendationOperation.SitelinkAssetParameters ### Description Parameters to use when applying sitelink asset recommendations. ### Parameters (No specific parameters documented in the source text) ### Request Example (No request example provided in the source text) ### Response (No specific response documented in the source text) ``` -------------------------------- ### ListInvoicesRequest Source: https://developers.google.com/google-ads/api/reference/rpc/v24/ListInvoicesRequest The ListInvoicesRequest message is used to fetch invoices associated with a particular billing setup and issued within a specified month and year. It includes fields for the billing setup, customer ID, invoice month and year, and an optional flag for granular invoice details. ```APIDOC ## ListInvoicesRequest ### Description Request message for fetching the invoices of a given billing setup that were issued during a given month. ### Fields #### `billing_setup` - **Type**: `string` - **Required**: Yes - **Description**: The billing setup resource name of the requested invoices. Format: `customers/{customer_id}/billingSetups/{billing_setup_id}`. #### `customer_id` - **Type**: `string` - **Required**: Yes - **Description**: The ID of the customer to fetch invoices for. #### `include_granular_level_invoice_details` - **Type**: `bool` - **Required**: No - **Description**: 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. #### `issue_month` - **Type**: `MonthOfYear` - **Required**: Yes - **Description**: The issue month to retrieve invoices. #### `issue_year` - **Type**: `string` - **Required**: Yes - **Description**: The issue year to retrieve invoices, in yyyy format. Only invoices issued in 2019 or later can be retrieved. ``` -------------------------------- ### payments_profile_name Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BillingSetup.PaymentsAccountInfo The name of the payments profile associated with the billing setup. ```APIDOC ## `payments_profile_name` ### Description Output only. The name of the payments profile associated with the billing setup. ### Type `string` ``` -------------------------------- ### SuggestBrands Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BrandSuggestionService/SuggestBrands Rpc to return a list of matching brands based on a prefix for this customer. ```APIDOC ## SuggestBrands ### Description Rpc to return a list of matching brands based on a prefix for this customer. ### Method rpc ### Endpoint SuggestBrands ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body ```json { Add request body parameters } ``` ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **field1** (type) - Description #### Response Example ```json { "example": "response body" } ``` ### Authorization Requires the following OAuth scope: * `https://www.googleapis.com/auth/adwords` ``` -------------------------------- ### BillingSetupStatusEnum Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BillingSetupStatusEnum Enum values representing the status of a billing setup. ```APIDOC ## `APPROVED` | The billing setup has been approved. ## `APPROVED_HELD` | The billing setup has been approved but the corresponding first budget has not. This can only occur for billing setups configured for monthly invoicing. ## `CANCELLED` | The billing setup was cancelled by the user prior to approval. ## `PENDING` | The billing setup is pending approval. ## `UNKNOWN` | Used for return value only. Represents value unknown in this version. ## `UNSPECIFIED` | Not specified. ``` -------------------------------- ### ProximityRadiusUnits Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview The unit of radius distance in proximity (for example, MILES) ```APIDOC enum ProximityRadiusUnits ``` -------------------------------- ### PostbackMapping Source: https://developers.google.com/google-ads/api/reference/rpc/v24/CustomerSkAdNetworkConversionValueSchema.SkAdNetworkConversionValueSchema.PostbackMapping Mappings for each postback in multiple conversion windows. ```APIDOC ## `coarse_grained_conversion_value_mappings` | `CoarseGrainedConversionValueMappings` | Output only. Conversion value mappings for all coarse grained conversion values. ## `lock_window_trigger` Union field. Event or conversion value used for locking conversion window. `lock_window_trigger` can be only one of the following: ### `lock_window_coarse_conversion_value` | `SkAdNetworkCoarseConversionValue` | Output only. Coarse grained conversion value that triggers conversion window lock. ### `lock_window_event` | `string` | Output only. Event name that triggers conversion window lock. ### `lock_window_fine_conversion_value` | `int32` | Output only. Fine grained conversion value that triggers conversion window lock. ## `postback_sequence_index` | `int32` | Output only. 0-based index that indicates the order of postback. Valid values are in the inclusive range [0,2]. ``` -------------------------------- ### FrequencyCapEventType Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview The type of event that the cap applies to (for example, impression). ```APIDOC ## FrequencyCapEventType ### Description The type of event that the cap applies to (for example, impression). ### Enum Values (Values not specified in source) ``` -------------------------------- ### ConversionGoalCampaignConfigService Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Service to manage conversion goal campaign config. ```APIDOC ## ConversionGoalCampaignConfigService ### Description Manages campaign configuration for conversion goals. ``` -------------------------------- ### MinuteOfHourEnum Source: https://developers.google.com/google-ads/api/reference/rpc/v24/MinuteOfHourEnum Enumerates quarter-hours. For example, "FIFTEEN". ```APIDOC ## `FIFTEEN` | Fifteen minutes past the hour. ## `FORTY_FIVE` | Forty-five minutes past the hour. ## `THIRTY` | Thirty minutes past the hour. ## `UNKNOWN` | The value is unknown in this version. ## `UNSPECIFIED` | Not specified. ## `ZERO` | Zero minutes past the hour. ``` -------------------------------- ### ApplyRecommendationOperation.UseBroadMatchKeywordParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Parameters to use when applying a use broad match keyword recommendation. ```APIDOC ## ApplyRecommendationOperation.UseBroadMatchKeywordParameters ### Description Parameters to use when applying a use broad match keyword recommendation. ### Parameters (No specific parameters documented in the source text) ### Request Example (No request example provided in the source text) ### Response (No specific response documented in the source text) ``` -------------------------------- ### ReachPlanService.ListPlannableProducts Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Lists the products that are plannable in a given location. This is a request message for the ListPlannableProducts RPC. ```APIDOC ## ListPlannableProductsRequest ### Description Request to list available products in a given location. ### Parameters #### Query Parameters - **location** (string) - Required - The location to list plannable products for (e.g., "en-US"). ``` -------------------------------- ### IncomeRangeType Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview The type of demographic income ranges (for example, between 0% to 50%). ```APIDOC ## IncomeRangeType ### Description The type of demographic income ranges (for example, between 0% to 50%). ### Enum Values (Values not specified in source) ``` -------------------------------- ### SmartCampaignSetting.AdOptimizedBusinessProfileSetting Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Settings for configuring a business profile optimized for ads as this campaign's landing page. ```APIDOC ## SmartCampaignSetting.AdOptimizedBusinessProfileSetting ### Description Settings for configuring a business profile optimized for ads as this campaign's landing page. ### Resource SmartCampaignSetting.AdOptimizedBusinessProfileSetting ``` -------------------------------- ### FrequencyCapTimeUnit Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Unit of time the cap is defined at (for example, day, week). ```APIDOC ## FrequencyCapTimeUnit ### Description Unit of time the cap is defined at (for example, day, week). ### Enum Values (Values not specified in source) ``` -------------------------------- ### ConfigureCustomerLifecycleGoals Source: https://developers.google.com/google-ads/api/reference/rpc/v24/CustomerLifecycleGoalService This method allows for the configuration of customer lifecycle goals. ```APIDOC ## ConfigureCustomerLifecycleGoals ### Description Configures customer lifecycle goals. ### Method POST ### Endpoint /customerLifecycleGoalService/configureCustomerLifecycleGoals ### Request Body This method accepts a request body containing the customer lifecycle goal configurations. ### Response Details about the response for this method are not provided in the source text. ``` -------------------------------- ### ListBenchmarksSources Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BenchmarksService/ListBenchmarksSources Returns the list of benchmarks sources (for example, Industry Verticals). ```APIDOC ## ListBenchmarksSources ### Description Returns the list of benchmarks sources (for example, Industry Verticals). ### Method `rpc ListBenchmarksSources(ListBenchmarksSourcesRequest) returns (ListBenchmarksSourcesResponse)` ### Authorization Requires the following OAuth scope: * `https://www.googleapis.com/auth/adwords` ### Thrown Errors * AuthenticationError * AuthorizationError * FieldError * HeaderError * InternalError * QuotaError * RequestError ``` -------------------------------- ### ListBenchmarksLocations Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BenchmarksService/ListBenchmarksLocations Returns the list of locations that support benchmarks (for example, countries). ```APIDOC ## ListBenchmarksLocations ### Description Returns the list of locations that support benchmarks (for example, countries). ### Method rpc ### Endpoint ListBenchmarksLocations ### Parameters #### Request Body - **ListBenchmarksLocationsRequest** (object) - Required - The request message for the `ListBenchmarksLocations` method. ### Response #### Success Response (200) - **ListBenchmarksLocationsResponse** (object) - The response message for the `ListBenchmarksLocations` method. ### Errors - AuthenticationError - AuthorizationError - FieldError - HeaderError - InternalError - QuotaError - RequestError ``` -------------------------------- ### PromoteExperiment Source: https://developers.google.com/google-ads/api/reference/rpc/v24/ExperimentService Promotes an experiment, applying its changes to the main campaign. This is similar to graduating an experiment but may have different implications or use cases. ```APIDOC ## PromoteExperiment ### Description Promotes an experiment, applying its changes to the main campaign. ### Method POST ### Endpoint /ExperimentService:PromoteExperiment ### Request Body - **customer_id** (string) - Required - The ID of the customer whose experiment is being promoted. - **experiment** (string) - Required - The resource name of the experiment to promote. ### Response #### Success Response (200) - **experiment** (object) - The promoted experiment. #### Response Example ```json { "experiment": { "resourceName": "customers/1234567890/experiments/1122334455", "status": "PROMOTED" } } ``` ``` -------------------------------- ### ApplyRecommendationOperation.AdAssetApplyParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Common parameters used when applying ad asset recommendations. ```APIDOC ## ApplyRecommendationOperation.AdAssetApplyParameters ### Description Common parameters used when applying ad asset recommendations. ### Method Not applicable (Data structure definition) ### Endpoint Not applicable (Data structure definition) ``` -------------------------------- ### BenchmarksService.ListBenchmarksProducts Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Lists available benchmark products. This is a response message for the ListBenchmarksProducts RPC. ```APIDOC ## ListBenchmarksProductsResponse ### Description Response message for `BenchmarksService.ListBenchmarksProducts`. ### Response #### Success Response (200) - **products** (array of BenchmarkProduct) - The list of benchmark products. ``` -------------------------------- ### FreeformImageGenerationInput Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Input for guiding image asset generation with a freeform prompt. ```APIDOC ## FreeformImageGenerationInput ### Description Input for guiding image asset generation with a freeform prompt. ### Method Not specified (Data Structure) ### Endpoint Not specified (Data Structure) ``` -------------------------------- ### PerStoreView Source: https://developers.google.com/google-ads/api/reference/rpc/v24/GoogleAdsRow The per-store view. ```APIDOC ## `per_store_view` ### Description The per-store view. ### Proto definition `PerStoreView` ``` -------------------------------- ### InvoiceService Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview A service to fetch invoices issued for a billing setup during a given month. ```APIDOC ## InvoiceService ### Description A service to fetch invoices issued for a billing setup during a given month. ### Method Not specified (RPC service) ### Endpoint Not specified (RPC service) ``` -------------------------------- ### ApplyRecommendationOperation.TargetCpaOptInParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Parameters to use when applying Target CPA recommendation. ```APIDOC ## ApplyRecommendationOperation.TargetCpaOptInParameters ### Description Parameters to use when applying Target CPA recommendation. ### Parameters (No specific parameters documented in the source text) ### Request Example (No request example provided in the source text) ### Response (No specific response documented in the source text) ``` -------------------------------- ### FacebookMessengerBusinessMessageInfo Source: https://developers.google.com/google-ads/api/reference/rpc/v24/FacebookMessengerBusinessMessageInfo Facebook page name used for starting a chat on Facebook Messenger. ```APIDOC ## `page_name` ### Description Facebook page name used for starting a chat on Facebook Messenger. ### Type string ### Required Yes ``` -------------------------------- ### AgeRangeType Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview The type of demographic age ranges (for example, between 18 and 24 years old). ```APIDOC enum AgeRangeType ``` -------------------------------- ### ReachPlanService.GenerateConversionRates Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Generates conversion rate suggestions for supported plannable products. ```APIDOC ## ReachPlanService.GenerateConversionRates ### Description Generates conversion rate suggestions for supported plannable products. ### Method Not specified (RPC method) ### Endpoint Not specified (RPC method) ### Parameters #### Request Body - **request** (GenerateConversionRatesRequest) - Required - The request message for `ReachPlanService.GenerateConversionRates`. ### Response #### Success Response (200) - **response** (GenerateConversionRatesResponse) - The response message for `ReachPlanService.GenerateConversionRates`, containing conversion rate suggestions for supported plannable products. ``` -------------------------------- ### ApplyRecommendationOperation.SitelinkExtensionParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Parameters to use when applying sitelink recommendation. ```APIDOC ## ApplyRecommendationOperation.SitelinkExtensionParameters ### Description Parameters to use when applying sitelink recommendation. ### Parameters (No specific parameters documented in the source text) ### Request Example (No request example provided in the source text) ### Response (No specific response documented in the source text) ``` -------------------------------- ### FetchIncentiveResponse Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Response from getting the acquisition incentive for a user when they visit a specific marketing page. ```APIDOC ## FetchIncentiveResponse ### Description Response from getting the acquisition incentive for a user when they visit a specific marketing page. ### Method Not specified (RPC Response) ### Endpoint Not specified (RPC Response) ``` -------------------------------- ### FinalUrlImageGenerationInput Source: https://developers.google.com/google-ads/api/reference/rpc/v24/FinalUrlImageGenerationInput Defines the input for image generation, specifying a final URL to guide the process. ```APIDOC ## `final_url` ### Description A final url to guide the image generation process. ### Type string ### Required Yes ``` -------------------------------- ### ApplyRecommendationOperation.RaiseTargetCpaBidTooLowParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Parameters to use when applying a raise target CPA bid too low recommendation. The apply is asynchronous and can take minutes depending on the number of ad groups there is in the related campaign. ```APIDOC ## ApplyRecommendationOperation.RaiseTargetCpaBidTooLowParameters ### Description Parameters to use when applying a raise target CPA bid too low recommendation. The apply is asynchronous and can take minutes depending on the number of ad groups there is in the related campaign. ### Method Not applicable (Data structure definition) ### Endpoint Not applicable (Data structure definition) ``` -------------------------------- ### Recommendation.UseBroadMatchKeywordRecommendation Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Represents a recommendation to use broad match keywords. ```APIDOC ## Recommendation.UseBroadMatchKeywordRecommendation ### Description The use broad match keyword recommendation. ### Resource Recommendation ``` -------------------------------- ### MutateAdGroupBidModifiers Request Body Structure Source: https://developers.google.com/google-ads/api/reference/rpc/v24/AdGroupBidModifierService/MutateAdGroupBidModifiers An example of the structure for the MutateAdGroupBidModifiersRequest. Use this as a template for constructing your request. ```json { // Add request body parameters } ``` -------------------------------- ### ProvideLeadFeedback Source: https://developers.google.com/google-ads/api/reference/rpc/v24/LocalServicesLeadService/ProvideLeadFeedback RPC to provide feedback on Local Services Lead resources. Requires specific OAuth scopes for authorization. ```APIDOC ## ProvideLeadFeedback ### Description RPC to provide feedback on Local Services Lead resources. ### Method `rpc ProvideLeadFeedback(ProvideLeadFeedbackRequest) returns (ProvideLeadFeedbackResponse)` ### Authorization Requires the following OAuth scope: * `https://www.googleapis.com/auth/adwords` ### Request Parameters * `resourceName` * `developer-token` * `login-customer-id` * `linked-customer-id` ### Request Body ```json { "Add request body parameters" } ``` ### Response * **Success Response**: `ProvideLeadFeedbackResponse` ### Example Usage This method can be tested using the APIs Explorer. ``` -------------------------------- ### final_app_urls Source: https://developers.google.com/google-ads/api/reference/rpc/v24/Ad A list of final app URLs that will be used on mobile if the user has the specific app installed. ```APIDOC ## `final_app_urls[]` ### Description A list of final app URLs that will be used on mobile if the user has the specific app installed. ### Type `FinalAppUrl` ``` -------------------------------- ### BudgetSimulationPoint Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Projected metrics for a specific budget amount. ```APIDOC ## BudgetSimulationPoint ### Description Projected metrics for a specific budget amount. ### Type Object ``` -------------------------------- ### GenerateTextRequest Source: https://developers.google.com/google-ads/api/reference/rpc/v24/GenerateTextRequest The GenerateTextRequest message contains fields to guide the generation of text assets for Google Ads. ```APIDOC ## GenerateTextRequest ### Description This message is used by the `AssetGenerationService.GenerateText` method to specify the parameters for generating text assets. ### Fields * **`asset_field_types[]`** (`AssetFieldType`) * Required. Specifies the types of text assets to generate (e.g., HEADLINE, LONG_HEADLINE, DESCRIPTION). * **`context`** (Union) * Optional. Provides additional context to guide the generation process. Can be one of the following: * **`advertising_channel_type`** (`AdvertisingChannelType`) * Optional. The advertising channel for which to generate assets (e.g., SEARCH, PERFORMANCE_MAX, DISPLAY, DEMAND_GEN). Required if `existing_generation_context` is not provided. * **`existing_generation_context`** (`AssetGenerationExistingContext`) * Optional. Specifies the existing context, such as an AssetGroup or AdGroupAd, for asset generation. * **`customer_id`** (`string`) * Required. The ID of the customer for whom to generate assets. * **`final_url`** (`string`) * Optional. The final URL to use as a source for generating assets. Required if `existing_generation_context` is not provided or does not have an associated final URL. * **`freeform_prompt`** (`string`) * Optional. A freeform description of the desired assets. The length must be between 1 and 1500 characters, inclusive. * **`keywords[]`** (`string`) * Optional. A list of relevant keywords to inform asset generation. ``` -------------------------------- ### average_video_watch_time_duration_millis Source: https://developers.google.com/google-ads/api/reference/rpc/v24/Metrics Average video watch time duration in milliseconds for video impressions that have started playing. ```APIDOC ## `average_video_watch_time_duration_millis` ### Description Average video watch time duration in milliseconds for video impressions that started playing. ### Type int64 ``` -------------------------------- ### ApplyRecommendationOperation.CalloutAssetParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Parameters to use when applying callout asset recommendations. ```APIDOC ## ApplyRecommendationOperation.CalloutAssetParameters ### Description Parameters to use when applying callout asset recommendations. ### Method Not applicable (Data structure definition) ### Endpoint Not applicable (Data structure definition) ``` -------------------------------- ### BudgetSimulationPointList Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BudgetSimulationPointList A container for simulation points for simulations of type BUDGET. It holds projected metrics for a series of budget amounts. ```APIDOC ## BudgetSimulationPointList ### Description A container for simulation points for simulations of type BUDGET. It holds projected metrics for a series of budget amounts. ### Fields #### `points[]` - **`BudgetSimulationPoint`** (object) - Projected metrics for a series of budget amounts. ``` -------------------------------- ### MonthOfYearEnum Source: https://developers.google.com/google-ads/api/reference/rpc/v24/MonthOfYearEnum Enumerates months of the year, for example, "January". This enum is used for organizing content. ```APIDOC ## Enum: MonthOfYearEnum ### Description Enumerates months of the year, for example, "January". This enum is used for organizing content. ### Enum Values * **JANUARY**: Represents January. * **FEBRUARY**: Represents February. * **MARCH**: Represents March. * **APRIL**: Represents April. * **MAY**: Represents May. * **JUNE**: Represents June. * **JULY**: Represents July. * **AUGUST**: Represents August. * **SEPTEMBER**: Represents September. * **OCTOBER**: Represents October. * **NOVEMBER**: Represents November. * **DECEMBER**: Represents December. * **UNKNOWN**: The value is unknown in this version. * **UNSPECIFIED**: Not specified. ``` -------------------------------- ### ReachPlanService.ListPlannableProducts Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Lists the products that are plannable in a given location. This is a response message for the ListPlannableProducts RPC. ```APIDOC ## ListPlannableProductsResponse ### Description A response with all available products. ### Response #### Success Response (200) - **plannable_products** (array of PlannableProduct) - The list of plannable products. ``` -------------------------------- ### ExperimentArm Source: https://developers.google.com/google-ads/api/reference/rpc/v24/GoogleAdsRow An experiment arm. ```APIDOC ## `experiment_arm` ### Description An experiment arm. ### Proto definition `ExperimentArm` ``` -------------------------------- ### total_adjustments_micros Source: https://developers.google.com/google-ads/api/reference/rpc/v24/AccountBudget Represents the total adjustments amount in micros. This field is output-only and an example of an adjustment is courtesy credits. ```APIDOC ## `total_adjustments_micros` ### Description Output only. The total adjustments amount. An example of an adjustment is courtesy credits. ### Field Details - **`total_adjustments_micros`** (int64) - Output only. The total adjustments amount. ``` -------------------------------- ### audience_description Source: https://developers.google.com/google-ads/api/reference/rpc/v24/InsightsAudienceDescription An English language text description of an audience to get suggestions for. Maximum length is 2000 characters. ```APIDOC ## `audience_description` ### Description An English language text description of an audience to get suggestions for. Maximum length is 2000 characters. For example, "Women in their 30s who love to travel". ### Type `string` Required. ``` -------------------------------- ### ApplyRecommendationOperation.KeywordParameters Source: https://developers.google.com/google-ads/api/reference/rpc/v24/overview Parameters to use when applying keyword recommendation. ```APIDOC ## ApplyRecommendationOperation.KeywordParameters ### Description Parameters to use when applying keyword recommendation. ### Method Not applicable (Data structure definition) ### Endpoint Not applicable (Data structure definition) ``` -------------------------------- ### ListBenchmarksProducts Source: https://developers.google.com/google-ads/api/reference/rpc/v24/BenchmarksService Lists the available products for which benchmark data can be retrieved. ```APIDOC ## ListBenchmarksProducts ### Description Lists the available products for which benchmark data can be retrieved. ### Method Not specified (RPC method) ### Endpoint Not specified (RPC method) ### Parameters Not specified in source ### Request Example Not specified in source ### Response Not specified in source ``` -------------------------------- ### freeform_prompt Source: https://developers.google.com/google-ads/api/reference/rpc/v24/FreeformImageGenerationInput A freeform text description to guide the image generation process. The maximum length is 1500 characters. ```APIDOC ## `freeform_prompt` ### Description Input for guiding image asset generation with a freeform prompt. ### Fields - **freeform_prompt** (string) - Required. A freeform text description to guide the image generation process. The maximum length is 1500 characters. ```