GoogleApi.LocalServices.V1.Api.DetailedLeadReports (google_api_local_services v0.2.1) View Source

API calls for all endpoints tagged DetailedLeadReports.

Link to this section Summary

Functions

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.

Link to this section Functions

Link to this function

localservices_detailed_lead_reports_search(connection, optional_params \\ [], opts \\ [])

View Source

Specs

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.

Parameters

  • connection (type: GoogleApi.LocalServices.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"endDate.day" (type: 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" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"endDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
    • :pageSize (type: 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 (type: String.t) - The next_page_token value returned from a previous request to SearchDetailedLeadReports that indicates where listing should continue. Optional.
    • :query (type: String.t) - 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" (type: 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" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"startDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.LocalServices.V1.Model.GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse{}} on success
  • {:error, info} on failure