Search Ads 360 Reporting API (searchads360:v23)

2026-11-18

1 new method | 62 removed methods

Additions

    Methods
  • ▼ ▲ searchads360.customers.operations.get

      Description : 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.

      Parameters :

        name

          Location : path

          Pattern : ^customers/[^/]+/operations/[^/]+$

          Required : Yes

          Type : string

          Description : The name of the operation resource.

      Path : v23/{+name}

      HTTP Method : GET

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23/customers/{customersId}/operations/{operationsId}

Deletions

    Methods
  • ▼ ▲ searchads360.listBenchmarksSources

      Flat Path : v23:listBenchmarksSources

      HTTP Method : POST

      Path : v23:listBenchmarksSources

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Returns the list of benchmarks sources (for example, Industry Verticals). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

  • ▼ ▲ searchads360.listBenchmarksLocations

      Description : Returns the list of locations that support benchmarks (for example, countries). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      Path : v23:listBenchmarksLocations

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23:listBenchmarksLocations

      HTTP Method : POST

  • ▼ ▲ searchads360.listBenchmarksAvailableDates

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23:listBenchmarksAvailableDates

      Description : Returns a date range that supports benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      HTTP Method : POST

      Path : v23:listBenchmarksAvailableDates

  • ▼ ▲ searchads360.listPlannableLocations

      Flat Path : v23:listPlannableLocations

      HTTP Method : POST

      Path : v23:listPlannableLocations

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Returns the list of plannable locations (for example, countries). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

  • ▼ ▲ searchads360.listBenchmarksProducts

      Path : v23:listBenchmarksProducts

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23:listBenchmarksProducts

      HTTP Method : POST

      Description : Returns the list of products that supports benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

  • ▼ ▲ searchads360.listPlannableUserLists

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : 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]()

      HTTP Method : POST

      Path : v23:listPlannableUserLists

      Flat Path : v23:listPlannableUserLists

  • ▼ ▲ searchads360.listPlannableUserInterests

      Path : v23:listPlannableUserInterests

      Flat Path : v23:listPlannableUserInterests

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : 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]()

  • ▼ ▲ searchads360.listPlannableProducts

      Flat Path : v23:listPlannableProducts

      Path : v23:listPlannableProducts

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Returns the list of per-location plannable YouTube ad formats with allowed targeting. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      HTTP Method : POST

  • ▼ ▲ searchads360.generateConversionRates

      Description : Returns a collection of conversion rate suggestions for supported plannable products. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      Path : v23:generateConversionRates

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23:generateConversionRates

      HTTP Method : POST

  • ▼ ▲ searchads360.audienceInsights.listInsightsEligibleDates

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      HTTP Method : POST

      Description : Lists date ranges for which audience insights data can be requested. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()

      Path : v23/audienceInsights:listInsightsEligibleDates

      Flat Path : v23/audienceInsights:listInsightsEligibleDates

  • ▼ ▲ searchads360.incentives.fetchIncentive

      Path : v23/incentives:fetchIncentive

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameters :

        languageCode

          Type : string

          Location : 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

        email

          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.

          Location : query

          Type : string

        countryCode

          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

          Location : query

          Type : string

        type

          Enum :

        • UNSPECIFIED
        • UNKNOWN
        • ACQUISITION
        • Type : string

          Description : Optional. The type of incentive to get. Defaults to ACQUISITION.

          Enum Descriptions :

        • Not specified.
        • Unknown incentive type. Should not be used as a value explicitly.
        • An acquisition incentive.
        • Location : query

      HTTP Method : GET

      Description : Returns incentives for a given user.

      Flat Path : v23/incentives:fetchIncentive

  • ▼ ▲ searchads360.keywordThemeConstants.suggest

      HTTP Method : POST

      Path : v23/keywordThemeConstants:suggest

      Description : Returns KeywordThemeConstant suggestions by keyword themes. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23/keywordThemeConstants:suggest

  • ▼ ▲ searchads360.customers.generateKeywordIdeas

      HTTP Method : POST

      Parameters :

        customerId

          Required : Yes

          Type : string

          Location : path

          Description : The ID of the customer with the recommendation.

          Pattern : ^[^/]+$

      Description : Returns a list of keyword ideas. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [KeywordPlanIdeaError]() [QuotaError]() [RequestError]()

      Path : v23/customers/{+customerId}:generateKeywordIdeas

      Parameter Order : customerId

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23/customers/{customersId}:generateKeywordIdeas

  • ▼ ▲ searchads360.customers.suggestKeywordThemes

      Flat Path : v23/customers/{customersId}:suggestKeywordThemes

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Path : v23/customers/{+customerId}:suggestKeywordThemes

      Description : Suggests keyword themes to advertise on.

      Parameters :

        customerId

          Required : Yes

          Pattern : ^[^/]+$

          Type : string

          Description : Required. The ID of the customer.

          Location : path

      Parameter Order : customerId

      HTTP Method : POST

  • ▼ ▲ searchads360.customers.suggestSmartCampaignBudgetOptions

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameters :

        customerId

          Location : path

          Type : string

          Required : Yes

          Pattern : ^[^/]+$

          Description : Required. The ID of the customer whose budget options are to be suggested.

      Description : Returns BudgetOption suggestions.

      Parameter Order : customerId

      Flat Path : v23/customers/{customersId}:suggestSmartCampaignBudgetOptions

      Path : v23/customers/{+customerId}:suggestSmartCampaignBudgetOptions

  • ▼ ▲ searchads360.customers.generateAudienceDefinition

      Flat Path : v23/customers/{customersId}:generateAudienceDefinition

      Description : 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]()

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Location : path

          Required : Yes

          Description : Required. The ID of the customer.

          Type : string

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameter Order : customerId

      Path : v23/customers/{+customerId}:generateAudienceDefinition

  • ▼ ▲ searchads360.customers.generateSuggestedTargetingInsights

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Description : Required. The ID of the customer.

          Location : path

          Required : Yes

          Type : string

      HTTP Method : POST

      Description : 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]()

      Path : v23/customers/{+customerId}:generateSuggestedTargetingInsights

      Flat Path : v23/customers/{customersId}:generateSuggestedTargetingInsights

      Parameter Order : customerId

  • ▼ ▲ searchads360.customers.searchAudienceInsightsAttributes

      Parameter Order : customerId

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Path : v23/customers/{+customerId}:searchAudienceInsightsAttributes

      Flat Path : v23/customers/{customersId}:searchAudienceInsightsAttributes

      Description : Searches for audience attributes that can be used to generate insights. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()

      Parameters :

        customerId

          Location : path

          Type : string

          Required : Yes

          Pattern : ^[^/]+$

          Description : Required. The ID of the customer.

      HTTP Method : POST

  • ▼ ▲ searchads360.customers.startIdentityVerification

      Flat Path : v23/customers/{customersId}:startIdentityVerification

      HTTP Method : POST

      Parameters :

        customerId

          Type : string

          Required : Yes

          Description : Required. The Id of the customer for whom we are creating this verification.

          Location : path

          Pattern : ^[^/]+$

      Description : Starts Identity Verification for a given verification program type. Statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameter Order : customerId

      Path : v23/customers/{+customerId}:startIdentityVerification

  • ▼ ▲ searchads360.customers.generateKeywordHistoricalMetrics

      Path : v23/customers/{+customerId}:generateKeywordHistoricalMetrics

      Parameter Order : customerId

      Parameters :

        customerId

          Description : The ID of the customer with the recommendation.

          Pattern : ^[^/]+$

          Type : string

          Location : path

          Required : Yes

      HTTP Method : POST

      Flat Path : v23/customers/{customersId}:generateKeywordHistoricalMetrics

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Returns a list of keyword historical metrics. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

  • ▼ ▲ searchads360.customers.generateReachForecast

      HTTP Method : POST

      Parameter Order : customerId

      Parameters :

        customerId

          Required : Yes

          Pattern : ^[^/]+$

          Type : string

          Location : path

          Description : Required. The ID of the customer.

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Generates a reach forecast for a given targeting / product mix. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [ReachPlanError]() [RequestError]()

      Flat Path : v23/customers/{customersId}:generateReachForecast

      Path : v23/customers/{+customerId}:generateReachForecast

  • ▼ ▲ searchads360.customers.uploadUserData

      HTTP Method : POST

      Flat Path : v23/customers/{customersId}:uploadUserData

      Parameters :

        customerId

          Required : Yes

          Description : Required. The ID of the customer for which to update the user data.

          Location : path

          Pattern : ^[^/]+$

          Type : string

      Parameter Order : customerId

      Path : v23/customers/{+customerId}:uploadUserData

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Uploads the given user data. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]() [UserDataError]()

  • ▼ ▲ searchads360.customers.generateInsightsFinderReport

      Path : v23/customers/{+customerId}:generateInsightsFinderReport

      Parameters :

        customerId

          Required : Yes

          Pattern : ^[^/]+$

          Location : path

          Type : string

          Description : Required. The ID of the customer.

      HTTP Method : POST

      Parameter Order : customerId

      Flat Path : v23/customers/{customersId}:generateInsightsFinderReport

      Description : 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]()

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

  • ▼ ▲ searchads360.customers.suggestSmartCampaignAd

      Parameter Order : customerId

      Flat Path : v23/customers/{customersId}:suggestSmartCampaignAd

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameters :

        customerId

          Location : path

          Required : Yes

          Pattern : ^[^/]+$

          Type : string

          Description : Required. The ID of the customer.

      Description : Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise.

      Path : v23/customers/{+customerId}:suggestSmartCampaignAd

      HTTP Method : POST

  • ▼ ▲ searchads360.customers.getIdentityVerification

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Returns Identity Verification information. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      Flat Path : v23/customers/{customersId}/getIdentityVerification

      Parameters :

        customerId

          Location : path

          Type : string

          Required : Yes

          Description : Required. The ID of the customer for whom we are requesting verification information.

          Pattern : ^[^/]+$

      Parameter Order : customerId

      HTTP Method : GET

      Path : v23/customers/{+customerId}/getIdentityVerification

  • ▼ ▲ searchads360.customers.generateAudienceOverlapInsights

      Flat Path : v23/customers/{customersId}:generateAudienceOverlapInsights

      Path : v23/customers/{+customerId}:generateAudienceOverlapInsights

      Parameter Order : customerId

      Description : 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]()

      Parameters :

        customerId

          Required : Yes

          Location : path

          Description : Required. The ID of the customer.

          Type : string

          Pattern : ^[^/]+$

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      HTTP Method : POST

  • ▼ ▲ searchads360.customers.generateBenchmarksMetrics

      Path : v23/customers/{+customerId}:generateBenchmarksMetrics

      Flat Path : v23/customers/{customersId}:generateBenchmarksMetrics

      Description : Returns YouTube advertisement metrics for the given client against industry benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BenchmarksError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()

      Parameter Order : customerId

      Parameters :

        customerId

          Required : Yes

          Location : path

          Type : string

          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.

          Pattern : ^[^/]+$

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      HTTP Method : POST

  • ▼ ▲ searchads360.customers.generateAudienceCompositionInsights

      Description : 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]()

      Path : v23/customers/{+customerId}:generateAudienceCompositionInsights

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      HTTP Method : POST

      Parameters :

        customerId

          Required : Yes

          Location : path

          Pattern : ^[^/]+$

          Description : Required. The ID of the customer.

          Type : string

      Flat Path : v23/customers/{customersId}:generateAudienceCompositionInsights

      Parameter Order : customerId

  • ▼ ▲ searchads360.customers.generateAdGroupThemes

      HTTP Method : POST

      Parameters :

        customerId

          Description : Required. The ID of the customer.

          Pattern : ^[^/]+$

          Location : path

          Required : Yes

          Type : string

      Description : 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]()

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23/customers/{customersId}:generateAdGroupThemes

      Path : v23/customers/{+customerId}:generateAdGroupThemes

      Parameter Order : customerId

  • ▼ ▲ searchads360.customers.generateKeywordForecastMetrics

      Flat Path : v23/customers/{customersId}:generateKeywordForecastMetrics

      Parameters :

        customerId

          Required : Yes

          Location : path

          Type : string

          Description : The ID of the customer.

          Pattern : ^[^/]+$

      HTTP Method : POST

      Path : v23/customers/{+customerId}:generateKeywordForecastMetrics

      Description : 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]()

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameter Order : customerId

  • ▼ ▲ searchads360.customers.generateTargetingSuggestionMetrics

      Parameter Order : customerId

      Flat Path : v23/customers/{customersId}:generateTargetingSuggestionMetrics

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Description : Required. The ID of the customer.

          Location : path

          Required : Yes

          Type : string

      Description : 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]()

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Path : v23/customers/{+customerId}:generateTargetingSuggestionMetrics

  • ▼ ▲ searchads360.customers.paymentsAccounts.list

      Flat Path : v23/customers/{customersId}/paymentsAccounts

      Description : 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]()

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      HTTP Method : GET

      Parameter Order : customerId

      Parameters :

        customerId

          Required : Yes

          Type : string

          Pattern : ^[^/]+$

          Description : Required. The ID of the customer to apply the PaymentsAccount list operation to.

          Location : path

      Path : v23/customers/{+customerId}/paymentsAccounts

  • ▼ ▲ searchads360.customers.billingSetups.mutate

      Description : Creates a billing setup, or cancels an existing billing setup. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BillingSetupError]() [DateError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23/customers/{customersId}/billingSetups:mutate

      Path : v23/customers/{+customerId}/billingSetups:mutate

      Parameters :

        customerId

          Description : Required. Id of the customer to apply the billing setup mutate operation to.

          Type : string

          Pattern : ^[^/]+$

          Required : Yes

          Location : path

      HTTP Method : POST

      Parameter Order : customerId

  • ▼ ▲ searchads360.customers.keywordPlans.mutate

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Path : v23/customers/{+customerId}/keywordPlans:mutate

      HTTP Method : POST

      Parameters :

        customerId

          Required : Yes

          Description : Required. The ID of the customer whose keyword plans are being modified.

          Location : path

          Type : string

          Pattern : ^[^/]+$

      Description : 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]()

      Parameter Order : customerId

      Flat Path : v23/customers/{customersId}/keywordPlans:mutate

  • ▼ ▲ searchads360.customers.accountBudgetProposals.mutate

      Path : v23/customers/{+customerId}/accountBudgetProposals:mutate

      Description : 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]()

      Flat Path : v23/customers/{customersId}/accountBudgetProposals:mutate

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameter Order : customerId

      HTTP Method : POST

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Required : Yes

          Location : path

          Type : string

          Description : Required. The ID of the customer.

  • ▼ ▲ searchads360.customers.keywordPlanAdGroups.mutate

      Flat Path : v23/customers/{customersId}/keywordPlanAdGroups:mutate

      Path : v23/customers/{+customerId}/keywordPlanAdGroups:mutate

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      HTTP Method : POST

      Parameters :

        customerId

          Location : path

          Description : Required. The ID of the customer whose Keyword Plan ad groups are being modified.

          Pattern : ^[^/]+$

          Required : Yes

          Type : string

      Description : 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]()

      Parameter Order : customerId

  • ▼ ▲ searchads360.customers.customerUserAccessInvitations.mutate

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Location : path

          Type : string

          Description : Required. The ID of the customer whose access invitation is being modified.

          Required : Yes

      Path : v23/customers/{+customerId}/customerUserAccessInvitations:mutate

      HTTP Method : POST

      Parameter Order : customerId

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23/customers/{customersId}/customerUserAccessInvitations:mutate

      Description : Creates or removes an access invitation. List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

  • ▼ ▲ searchads360.customers.offlineUserDataJobs.run

      HTTP Method : POST

      Parameters :

        resourceName

          Description : Required. The resource name of the OfflineUserDataJob to run.

          Pattern : ^customers/[^/]+/offlineUserDataJobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resourceName

      Description : 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]()

      Flat Path : v23/customers/{customersId}/offlineUserDataJobs/{offlineUserDataJobsId}:run

      Path : v23/{+resourceName}:run

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

  • ▼ ▲ searchads360.customers.offlineUserDataJobs.create

      Description : Creates an offline user data job. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [NotAllowlistedError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]()

      Path : v23/customers/{+customerId}/offlineUserDataJobs:create

      Flat Path : v23/customers/{customersId}/offlineUserDataJobs:create

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Required : Yes

          Type : string

          Description : Required. The ID of the customer for which to create an offline user data job.

          Location : path

      Parameter Order : customerId

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      HTTP Method : POST

  • ▼ ▲ searchads360.customers.offlineUserDataJobs.addOperations

      Description : Adds operations to the offline user data job. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]()

      Parameters :

        resourceName

          Pattern : ^customers/[^/]+/offlineUserDataJobs/[^/]+$

          Location : path

          Required : Yes

          Description : Required. The resource name of the OfflineUserDataJob.

          Type : string

      Flat Path : v23/customers/{customersId}/offlineUserDataJobs/{offlineUserDataJobsId}:addOperations

      HTTP Method : POST

      Path : v23/{+resourceName}:addOperations

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameter Order : resourceName

  • ▼ ▲ searchads360.customers.customerUserAccesses.mutate

      HTTP Method : POST

      Parameters :

        customerId

          Required : Yes

          Pattern : ^[^/]+$

          Description : Required. The ID of the customer being modified.

          Type : string

          Location : path

      Path : v23/customers/{+customerId}/customerUserAccesses:mutate

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : 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]()

      Parameter Order : customerId

      Flat Path : v23/customers/{customersId}/customerUserAccesses:mutate

  • ▼ ▲ searchads360.customers.smartCampaignSettings.getSmartCampaignStatus

      Description : Returns the status of the requested Smart campaign.

      Parameter Order : resourceName

      Path : v23/{+resourceName}:getSmartCampaignStatus

      Parameters :

        resourceName

          Location : path

          Pattern : ^customers/[^/]+/smartCampaignSettings/[^/]+$

          Required : Yes

          Type : string

          Description : Required. The resource name of the Smart campaign setting belonging to the Smart campaign to fetch the status of.

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      HTTP Method : GET

      Flat Path : v23/customers/{customersId}/smartCampaignSettings/{smartCampaignSettingsId}:getSmartCampaignStatus

  • ▼ ▲ searchads360.customers.smartCampaignSettings.mutate

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Location : path

          Description : Required. The ID of the customer whose Smart campaign settings are being modified.

          Type : string

          Required : Yes

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Path : v23/customers/{+customerId}/smartCampaignSettings:mutate

      HTTP Method : POST

      Description : Updates Smart campaign settings for campaigns.

      Flat Path : v23/customers/{customersId}/smartCampaignSettings:mutate

      Parameter Order : customerId

  • ▼ ▲ searchads360.customers.productLinkInvitations.update

      Path : v23/customers/{+customerId}/productLinkInvitations:update

      Flat Path : v23/customers/{customersId}/productLinkInvitations:update

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Update a product link invitation.

      Parameter Order : customerId

      HTTP Method : POST

      Parameters :

        customerId

          Required : Yes

          Location : path

          Description : Required. The ID of the customer being modified.

          Type : string

          Pattern : ^[^/]+$

  • ▼ ▲ searchads360.customers.productLinkInvitations.remove

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Description : Required. The ID of the product link invitation being removed.

          Location : path

          Required : Yes

          Type : string

      Parameter Order : customerId

      Flat Path : v23/customers/{customersId}/productLinkInvitations:remove

      Path : v23/customers/{+customerId}/productLinkInvitations:remove

      Description : Remove a product link invitation.

  • ▼ ▲ searchads360.customers.productLinkInvitations.create

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Creates a product link invitation.

      Flat Path : v23/customers/{customersId}/productLinkInvitations:create

      HTTP Method : POST

      Parameters :

        customerId

          Type : string

          Pattern : ^[^/]+$

          Required : Yes

          Description : Required. The ID of the customer being modified.

          Location : path

      Path : v23/customers/{+customerId}/productLinkInvitations:create

      Parameter Order : customerId

  • ▼ ▲ searchads360.customers.keywordPlanCampaignKeywords.mutate

      Flat Path : v23/customers/{customersId}/keywordPlanCampaignKeywords:mutate

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Description : Required. The ID of the customer whose campaign keywords are being modified.

          Location : path

          Required : Yes

          Type : string

      Path : v23/customers/{+customerId}/keywordPlanCampaignKeywords:mutate

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : 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]()

      Parameter Order : customerId

  • ▼ ▲ searchads360.customers.recommendations.generate

      Description : Generates Recommendations based off the requested recommendation_types. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RecommendationError]() [RequestError]()

      Flat Path : v23/customers/{customersId}/recommendations:generate

      Parameters :

        customerId

          Location : path

          Pattern : ^[^/]+$

          Type : string

          Required : Yes

          Description : Required. The ID of the customer generating recommendations.

      Path : v23/customers/{+customerId}/recommendations:generate

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      HTTP Method : POST

      Parameter Order : customerId

  • ▼ ▲ searchads360.customers.recommendations.dismiss

      Path : v23/customers/{+customerId}/recommendations:dismiss

      HTTP Method : POST

      Flat Path : v23/customers/{customersId}/recommendations:dismiss

      Parameters :

        customerId

          Required : Yes

          Type : string

          Location : path

          Description : Required. The ID of the customer with the recommendation.

          Pattern : ^[^/]+$

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameter Order : customerId

      Description : Dismisses given recommendations. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RecommendationError]() [RequestError]()

  • ▼ ▲ searchads360.customers.recommendations.apply

      Path : v23/customers/{+customerId}/recommendations:apply

      Flat Path : v23/customers/{customersId}/recommendations:apply

      Description : Applies given recommendations with corresponding apply parameters. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RecommendationError]() [RequestError]() [UrlFieldError]()

      HTTP Method : POST

      Parameters :

        customerId

          Type : string

          Required : Yes

          Location : path

          Pattern : ^[^/]+$

          Description : Required. The ID of the customer with the recommendation.

      Parameter Order : customerId

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

  • ▼ ▲ searchads360.customers.productLinks.remove

      Path : v23/customers/{+customerId}/productLinks:remove

      Description : Removes a product link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

      Flat Path : v23/customers/{customersId}/productLinks:remove

      Parameter Order : customerId

      HTTP Method : POST

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Description : Required. The ID of the customer being modified.

          Type : string

          Location : path

          Required : Yes

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

  • ▼ ▲ searchads360.customers.productLinks.create

      Parameter Order : customerId

      Description : Creates a product link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

      Path : v23/customers/{+customerId}/productLinks:create

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Location : path

          Type : string

          Description : Required. The ID of the customer for which the product link is created.

          Required : Yes

      HTTP Method : POST

      Flat Path : v23/customers/{customersId}/productLinks:create

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

  • ▼ ▲ searchads360.customers.thirdPartyAppAnalyticsLinks.regenerateShareableLinkId

      Parameters :

        resourceName

          Type : string

          Pattern : ^customers/[^/]+/thirdPartyAppAnalyticsLinks/[^/]+$

          Required : Yes

          Description : Resource name of the third party app analytics link.

          Location : path

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23/customers/{customersId}/thirdPartyAppAnalyticsLinks/{thirdPartyAppAnalyticsLinksId}:regenerateShareableLinkId

      Parameter Order : resourceName

      Path : v23/{+resourceName}:regenerateShareableLinkId

      Description : 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]()

  • ▼ ▲ searchads360.customers.accountLinks.create

      Description : Creates an account link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() [ThirdPartyAppAnalyticsLinkError]()

      Parameter Order : customerId

      HTTP Method : POST

      Path : v23/customers/{+customerId}/accountLinks:create

      Parameters :

        customerId

          Required : Yes

          Location : path

          Pattern : ^[^/]+$

          Type : string

          Description : Required. The ID of the customer for which the account link is created.

      Flat Path : v23/customers/{customersId}/accountLinks:create

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

  • ▼ ▲ searchads360.customers.accountLinks.mutate

      Parameter Order : customerId

      Path : v23/customers/{+customerId}/accountLinks:mutate

      Flat Path : v23/customers/{customersId}/accountLinks:mutate

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Type : string

          Required : Yes

          Location : path

          Description : Required. The ID of the customer being modified.

      Description : 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]()

      HTTP Method : POST

  • ▼ ▲ searchads360.customers.invoices.list

      Flat Path : v23/customers/{customersId}/invoices

      Description : Returns all invoices associated with a billing setup, for a given month. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [InvoiceError]() [QuotaError]() [RequestError]()

      Path : v23/customers/{+customerId}/invoices

      Parameter Order : customerId

      HTTP Method : GET

      Parameters :

        includeGranularLevelInvoiceDetails

          Location : query

          Type : boolean

          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.

        billingSetup

          Type : string

          Description : Required. The billing setup resource name of the requested invoices. `customers/{customer_id}/billingSetups/{billing_setup_id}`

          Location : query

        issueYear

          Type : string

          Description : Required. The issue year to retrieve invoices, in yyyy format. Only invoices issued in 2019 or later can be retrieved.

          Location : query

        issueMonth

          Enum :

        • UNSPECIFIED
        • UNKNOWN
        • JANUARY
        • FEBRUARY
        • MARCH
        • APRIL
        • MAY
        • JUNE
        • JULY
        • AUGUST
        • SEPTEMBER
        • OCTOBER
        • NOVEMBER
        • DECEMBER
        • Type : string

          Description : Required. The issue month to retrieve invoices.

          Enum Descriptions :

        • Not specified.
        • The value is unknown in this version.
        • January.
        • February.
        • March.
        • April.
        • May.
        • June.
        • July.
        • August.
        • September.
        • October.
        • November.
        • December.
        • Location : query

        customerId

          Location : path

          Pattern : ^[^/]+$

          Required : Yes

          Description : Required. The ID of the customer to fetch invoices for.

          Type : string

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

  • ▼ ▲ searchads360.customers.keywordPlanAdGroupKeywords.mutate

      Parameters :

        customerId

          Description : Required. The ID of the customer whose Keyword Plan ad group keywords are being modified.

          Pattern : ^[^/]+$

          Required : Yes

          Type : string

          Location : path

      Flat Path : v23/customers/{customersId}/keywordPlanAdGroupKeywords:mutate

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameter Order : customerId

      Description : 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]()

      Path : v23/customers/{+customerId}/keywordPlanAdGroupKeywords:mutate

  • ▼ ▲ searchads360.customers.dataLinks.remove

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Flat Path : v23/customers/{customersId}/dataLinks:remove

      Path : v23/customers/{+customerId}/dataLinks:remove

      Parameter Order : customerId

      Description : Remove a data link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

      Parameters :

        customerId

          Description : Required. The ID of the customer for which the data link is updated.

          Required : Yes

          Type : string

          Location : path

          Pattern : ^[^/]+$

      HTTP Method : POST

  • ▼ ▲ searchads360.customers.dataLinks.update

      Parameters :

        customerId

          Required : Yes

          Description : Required. The ID of the customer for which the data link is created.

          Type : string

          Location : path

          Pattern : ^[^/]+$

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Update a data link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

      Flat Path : v23/customers/{customersId}/dataLinks:update

      Parameter Order : customerId

      Path : v23/customers/{+customerId}/dataLinks:update

  • ▼ ▲ searchads360.customers.dataLinks.create

      Parameters :

        customerId

          Description : Required. The ID of the customer for which the data link is created.

          Type : string

          Required : Yes

          Location : path

          Pattern : ^[^/]+$

      HTTP Method : POST

      Parameter Order : customerId

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Path : v23/customers/{+customerId}/dataLinks:create

      Description : 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. Only customers on the allow-list can create data links. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

      Flat Path : v23/customers/{customersId}/dataLinks:create

  • ▼ ▲ searchads360.customers.incentives.applyIncentive

      Parameter Order :

    • customerId
    • selectedIncentiveId
    • Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Description : Applies the incentive for the ads customer.

      Path : v23/customers/{+customerId}/incentives/{+selectedIncentiveId}:applyIncentive

      Flat Path : v23/customers/{customersId}/incentives/{incentivesId}:applyIncentive

      HTTP Method : POST

      Parameters :

        customerId

          Pattern : ^[^/]+$

          Type : string

          Location : path

          Description : The customer ID of the account that the incentive is being applied to.

          Required : Yes

        selectedIncentiveId

          Location : path

          Format : int64

          Required : Yes

          Description : The incentive ID of this incentive. This is used to identify which incentive is selected by the user in the CYO flow.

          Pattern : ^[^/]+$

          Type : string

  • ▼ ▲ searchads360.customers.keywordPlanCampaigns.mutate

      Description : 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]()

      Path : v23/customers/{+customerId}/keywordPlanCampaigns:mutate

      HTTP Method : POST

      Parameters :

        customerId

          Required : Yes

          Description : Required. The ID of the customer whose Keyword Plan campaigns are being modified.

          Type : string

          Location : path

          Pattern : ^[^/]+$

      Flat Path : v23/customers/{customersId}/keywordPlanCampaigns:mutate

      Scopes : https://www.googleapis.com/auth/doubleclicksearch

      Parameter Order : customerId