Local Services API . accountReports

Instance Methods

close()

Close httplib2 connections.

search(startDate_month=None, pageToken=None, pageSize=None, endDate_day=None, startDate_day=None, endDate_month=None, endDate_year=None, query=None, startDate_year=None, x__xgafv=None)

Get account reports containing aggregate account data of all linked GLS accounts. Caller needs to provide their manager customer id and the associated auth credential that allows them read permissions on their linked accounts.

search_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
search(startDate_month=None, pageToken=None, pageSize=None, endDate_day=None, startDate_day=None, endDate_month=None, endDate_year=None, query=None, startDate_year=None, x__xgafv=None)
Get account reports containing aggregate account data of all linked GLS accounts. Caller needs to provide their manager customer id and the associated auth credential that allows them read permissions on their linked accounts.

Args:
  startDate_month: integer, Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
  pageToken: string, The `next_page_token` value returned from a previous request to SearchAccountReports that indicates where listing should continue. Optional.
  pageSize: integer, The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000. Optional.
  endDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
  startDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
  endDate_month: integer, Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
  endDate_year: integer, Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
  query: string, A query string for searching for account reports. Caller must provide a customer id of their MCC account with an associated Gaia Mint that allows read permission on their linked accounts. Search expressions are case insensitive. Example query: | Query | Description | |-------------------------|-----------------------------------------------| | manager_customer_id:123 | Get Account Report for Manager with id 123. | Required.
  startDate_year: integer, Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A page of the response received from the SearchAccountReports method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
    "nextPageToken": "A String", # Pagination token to retrieve the next page of results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set.
    "accountReports": [ # List of account reports which maps 1:1 to a particular linked GLS account.
      { # An Account Report of a GLS account identified by their account id containing aggregate data gathered from a particular date range.
        "currentPeriodConnectedPhoneCalls": "A String", # Number of connected phone calls (duration over 30s) in current specified period.
        "previousPeriodPhoneCalls": "A String", # Number of phone calls in previous specified period, including both connected and unconnected calls.
        "currentPeriodChargedLeads": "A String", # Number of charged leads the account received in current specified period.
        "currencyCode": "A String", # Currency code of the account.
        "phoneLeadResponsiveness": 3.14, # Phone lead responsiveness of the account for the past 90 days from current date. This is computed by taking the total number of connected calls from charged phone leads and dividing by the total number of calls received.
        "accountId": "A String", # Unique identifier of the GLS account.
        "totalReview": 42, # Total number of reviews the account has up to current date.
        "previousPeriodTotalCost": 3.14, # Total cost of the account in previous specified period in the account's specified currency.
        "currentPeriodTotalCost": 3.14, # Total cost of the account in current specified period in the account's specified currency.
        "previousPeriodChargedLeads": "A String", # Number of charged leads the account received in previous specified period.
        "previousPeriodConnectedPhoneCalls": "A String", # Number of connected phone calls (duration over 30s) in previous specified period.
        "currentPeriodPhoneCalls": "A String", # Number of phone calls in current specified period, including both connected and unconnected calls.
        "businessName": "A String", # Business name of the account.
        "averageFiveStarRating": 3.14, # Average review rating score from 1-5 stars.
        "averageWeeklyBudget": 3.14, # Average weekly budget in the currency code of the account.
      },
    ],
  }
search_next(previous_request, previous_response)
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.