Local Services API . detailedLeadReports

Instance Methods

close()

Close httplib2 connections.

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

Get detailed lead reports containing leads that have been received by 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()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
search(endDate_day=None, endDate_month=None, endDate_year=None, pageSize=None, pageToken=None, query=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)
Get detailed lead reports containing leads that have been received by 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:
  endDate_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.
  endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  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.
  pageToken: string, The `next_page_token` value returned from a previous request to SearchDetailedLeadReports that indicates where listing should continue. Optional.
  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 Detailed Lead Report for Manager with id | | | 123. | Required.
  startDate_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.
  startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify 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 SearchDetailedLeadReports 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.
  "detailedLeadReports": [ # List of detailed lead reports uniquely identified by external lead id.
    { # A Detailed Lead Report of a lead identified by their lead id and contains consumer, account, monetization, and lead data.
      "accountId": "A String", # Identifies account that received the lead.
      "aggregatorInfo": { # Conatiner for aggregator specific information if lead is for an aggregator GLS account. # Aggregator specific information related to the lead.
        "aggregatorProviderId": "A String", # Provider id (listed in aggregator system) which maps to a account id in GLS system.
      },
      "bookingLead": { # Container for booking lead specific information. # More information associated to only booking leads.
        "bookingAppointmentTimestamp": "A String", # Timestamp of when service is provided by advertiser.
        "consumerEmail": "A String", # Consumer email associated with the booking lead.
        "consumerPhoneNumber": "A String", # Consumer phone number associated with the booking lead.
        "customerName": "A String", # Name of the customer who created the lead.
        "jobType": "A String", # The job type of the specified lead.
      },
      "businessName": "A String", # Business name associated to the account.
      "chargeStatus": "A String", # Whether the lead has been charged.
      "currencyCode": "A String", # Currency code.
      "disputeStatus": "A String", # Dispute status related to the lead.
      "geo": "A String", # Location of the associated account's home city.
      "leadCategory": "A String", # Lead category (e.g. hvac, plumber)
      "leadCreationTimestamp": "A String", # Timestamp of when the lead was created.
      "leadId": "A String", # Unique identifier of a Detailed Lead Report.
      "leadPrice": 3.14, # Price of the lead (available only after it has been charged).
      "leadType": "A String", # Lead type.
      "messageLead": { # Container for message lead specific information. # More information associated to only message leads.
        "consumerPhoneNumber": "A String", # Consumer phone number associated with the message lead.
        "customerName": "A String", # Name of the customer who created the lead.
        "jobType": "A String", # The job type of the specified lead.
        "postalCode": "A String", # The postal code of the customer who created the lead.
      },
      "phoneLead": { # Container for phone lead specific information. # More information associated to only phone leads.
        "chargedCallTimestamp": "A String", # Timestamp of the phone call which resulted in a charged phone lead.
        "chargedConnectedCallDurationSeconds": "A String", # Duration of the charged phone call in seconds.
        "consumerPhoneNumber": "A String", # Consumer phone number associated with the phone lead.
      },
      "timezone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Timezone of the particular provider associated to a lead.
        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
      },
    },
  ],
  "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.
}
search_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.