Business Profile Performance API . locations . searchkeywords . impressions . monthly

close()

Close httplib2 connections.

list(parent, monthlyRange_endMonth_day=None, monthlyRange_endMonth_month=None, monthlyRange_endMonth_year=None, monthlyRange_startMonth_day=None, monthlyRange_startMonth_month=None, monthlyRange_startMonth_year=None, pageSize=None, pageToken=None, x__xgafv=None)

Returns the search keywords used to find a business in search or maps. Each search keyword is accompanied by impressions which are aggregated on a monthly basis. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345/searchkeywords/impressions/monthly?monthly_range.start_month.year=2022&monthly_range.start_month.month=1&monthly_range.end_month.year=2022&monthly_range.end_month.month=3`

Args:
  parent: string, Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id. (required)
  monthlyRange_endMonth_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
  monthlyRange_endMonth_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  monthlyRange_endMonth_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  monthlyRange_startMonth_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
  monthlyRange_startMonth_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  monthlyRange_startMonth_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  pageSize: integer, Optional. The number of results requested. The default page size is 100. Page size can be set to a maximum of 100.
  pageToken: string, Optional. A token indicating the next paginated result to be returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents the response for ListSearchKeywordImpressionsMonthly.
  "nextPageToken": "A String", # A token indicating the last paginated result returned. This can be used by succeeding requests to get the next "page" of keywords. It will only be present when there are more results to be returned.
  "searchKeywordsCounts": [ # Search terms which have been used to find a business.
    { # Represents a single search keyword and its value.
      "insightsValue": { # Represents an insights value. # One of either: 1) The sum of the number of unique users that used the keyword in a month, aggregated for each month requested. 2) A threshold that indicates that the actual value is below this threshold.
        "threshold": "A String", # Represents the threshold below which the actual value falls.
        "value": "A String", # Represents the actual value.
      },
      "searchKeyword": "A String", # The lower-cased string that the user entered.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.