| { |
| "icons": { |
| "x32": "http://www.google.com/images/icons/product/search-32.gif", |
| "x16": "http://www.google.com/images/icons/product/search-16.gif" |
| }, |
| "revision": "20201016", |
| "name": "localservices", |
| "rootUrl": "https://localservices.googleapis.com/", |
| "documentationLink": "https://ads.google.com/local-services-ads/", |
| "schemas": { |
| "GoogleAdsHomeservicesLocalservicesV1MessageLead": { |
| "id": "GoogleAdsHomeservicesLocalservicesV1MessageLead", |
| "properties": { |
| "customerName": { |
| "type": "string", |
| "description": "Name of the customer who created the lead." |
| }, |
| "postalCode": { |
| "description": "The postal code of the customer who created the lead.", |
| "type": "string" |
| }, |
| "jobType": { |
| "type": "string", |
| "description": "The job type of the specified lead." |
| }, |
| "consumerPhoneNumber": { |
| "type": "string", |
| "description": "Consumer phone number associated with the message lead." |
| } |
| }, |
| "type": "object", |
| "description": "Container for message lead specific information." |
| }, |
| "GoogleTypeTimeZone": { |
| "id": "GoogleTypeTimeZone", |
| "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", |
| "type": "object", |
| "properties": { |
| "id": { |
| "type": "string", |
| "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\"." |
| }, |
| "version": { |
| "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", |
| "type": "string" |
| } |
| } |
| }, |
| "GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse": { |
| "id": "GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse", |
| "properties": { |
| "nextPageToken": { |
| "type": "string", |
| "description": "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": { |
| "items": { |
| "$ref": "GoogleAdsHomeservicesLocalservicesV1AccountReport" |
| }, |
| "type": "array", |
| "description": "List of account reports which maps 1:1 to a particular linked GLS account." |
| } |
| }, |
| "type": "object", |
| "description": "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." |
| }, |
| "GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse": { |
| "id": "GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse", |
| "description": "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.", |
| "type": "object", |
| "properties": { |
| "nextPageToken": { |
| "description": "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.", |
| "type": "string" |
| }, |
| "detailedLeadReports": { |
| "items": { |
| "$ref": "GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport" |
| }, |
| "description": "List of detailed lead reports uniquely identified by external lead id.", |
| "type": "array" |
| } |
| } |
| }, |
| "GoogleAdsHomeservicesLocalservicesV1AccountReport": { |
| "properties": { |
| "previousPeriodTotalCost": { |
| "type": "number", |
| "format": "double", |
| "description": "Total cost of the account in previous specified period in the account's specified currency." |
| }, |
| "currencyCode": { |
| "type": "string", |
| "description": "Currency code of the account." |
| }, |
| "businessName": { |
| "type": "string", |
| "description": "Business name of the account." |
| }, |
| "previousPeriodPhoneCalls": { |
| "format": "int64", |
| "description": "Number of phone calls in previous specified period, including both connected and unconnected calls.", |
| "type": "string" |
| }, |
| "accountId": { |
| "description": "Unique identifier of the GLS account.", |
| "type": "string", |
| "format": "int64" |
| }, |
| "aggregatorInfo": { |
| "description": "Aggregator specific information related to the account.", |
| "$ref": "GoogleAdsHomeservicesLocalservicesV1AggregatorInfo" |
| }, |
| "currentPeriodConnectedPhoneCalls": { |
| "description": "Number of connected phone calls (duration over 30s) in current specified period.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "phoneLeadResponsiveness": { |
| "format": "double", |
| "type": "number", |
| "description": "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." |
| }, |
| "previousPeriodConnectedPhoneCalls": { |
| "description": "Number of connected phone calls (duration over 30s) in previous specified period.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "averageWeeklyBudget": { |
| "type": "number", |
| "description": "Average weekly budget in the currency code of the account.", |
| "format": "double" |
| }, |
| "currentPeriodTotalCost": { |
| "description": "Total cost of the account in current specified period in the account's specified currency.", |
| "format": "double", |
| "type": "number" |
| }, |
| "averageFiveStarRating": { |
| "format": "double", |
| "type": "number", |
| "description": "Average review rating score from 1-5 stars." |
| }, |
| "totalReview": { |
| "format": "int32", |
| "description": "Total number of reviews the account has up to current date.", |
| "type": "integer" |
| }, |
| "currentPeriodPhoneCalls": { |
| "format": "int64", |
| "type": "string", |
| "description": "Number of phone calls in current specified period, including both connected and unconnected calls." |
| }, |
| "currentPeriodChargedLeads": { |
| "type": "string", |
| "format": "int64", |
| "description": "Number of charged leads the account received in current specified period." |
| }, |
| "previousPeriodChargedLeads": { |
| "description": "Number of charged leads the account received in previous specified period.", |
| "type": "string", |
| "format": "int64" |
| } |
| }, |
| "id": "GoogleAdsHomeservicesLocalservicesV1AccountReport", |
| "type": "object", |
| "description": "An Account Report of a GLS account identified by their account id containing aggregate data gathered from a particular date range." |
| }, |
| "GoogleAdsHomeservicesLocalservicesV1AggregatorInfo": { |
| "type": "object", |
| "properties": { |
| "aggregatorProviderId": { |
| "description": "Provider id (listed in aggregator system) which maps to a account id in GLS system.", |
| "type": "string" |
| } |
| }, |
| "id": "GoogleAdsHomeservicesLocalservicesV1AggregatorInfo", |
| "description": "Conatiner for aggregator specific information if lead is for an aggregator GLS account." |
| }, |
| "GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport": { |
| "description": "A Detailed Lead Report of a lead identified by their lead id and contains consumer, account, monetization, and lead data.", |
| "id": "GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport", |
| "type": "object", |
| "properties": { |
| "disputeStatus": { |
| "type": "string", |
| "description": "Dispute status related to the lead." |
| }, |
| "currencyCode": { |
| "description": "Currency code.", |
| "type": "string" |
| }, |
| "leadType": { |
| "enum": [ |
| "LEAD_TYPE_UNSPECIFIED", |
| "MESSAGE", |
| "PHONE_CALL" |
| ], |
| "description": "Lead type.", |
| "enumDescriptions": [ |
| "Not specified.", |
| "Message lead.", |
| "Phone call lead." |
| ], |
| "type": "string" |
| }, |
| "leadCreationTimestamp": { |
| "type": "string", |
| "format": "google-datetime", |
| "description": "Timestamp of when the lead was created." |
| }, |
| "messageLead": { |
| "$ref": "GoogleAdsHomeservicesLocalservicesV1MessageLead", |
| "description": "More information associated to only message leads." |
| }, |
| "businessName": { |
| "description": "Business name associated to the account.", |
| "type": "string" |
| }, |
| "leadId": { |
| "format": "int64", |
| "type": "string", |
| "description": "Unique identifier of a Detailed Lead Report." |
| }, |
| "phoneLead": { |
| "$ref": "GoogleAdsHomeservicesLocalservicesV1PhoneLead", |
| "description": "More information associated to only phone leads." |
| }, |
| "chargeStatus": { |
| "type": "string", |
| "enumDescriptions": [ |
| "Not specified.", |
| "Charged.", |
| "Not charged." |
| ], |
| "enum": [ |
| "CHARGE_STATUS_UNSPECIFIED", |
| "CHARGED", |
| "NOT_CHARGED" |
| ], |
| "description": "Whether the lead has been charged." |
| }, |
| "timezone": { |
| "description": "Timezone of the particular provider associated to a lead.", |
| "$ref": "GoogleTypeTimeZone" |
| }, |
| "aggregatorInfo": { |
| "description": "Aggregator specific information related to the lead.", |
| "$ref": "GoogleAdsHomeservicesLocalservicesV1AggregatorInfo" |
| }, |
| "leadPrice": { |
| "format": "double", |
| "description": "Price of the lead (available only after it has been charged).", |
| "type": "number" |
| }, |
| "geo": { |
| "description": "Location of the associated account's home city.", |
| "type": "string" |
| }, |
| "accountId": { |
| "format": "int64", |
| "description": "Identifies account that received the lead.", |
| "type": "string" |
| }, |
| "leadCategory": { |
| "type": "string", |
| "description": "Lead category (e.g. hvac, plumber)" |
| } |
| } |
| }, |
| "GoogleAdsHomeservicesLocalservicesV1PhoneLead": { |
| "type": "object", |
| "properties": { |
| "consumerPhoneNumber": { |
| "description": "Consumer phone number associated with the phone lead.", |
| "type": "string" |
| }, |
| "chargedConnectedCallDurationSeconds": { |
| "format": "google-duration", |
| "type": "string", |
| "description": "Duration of the charged phone call in seconds." |
| }, |
| "chargedCallTimestamp": { |
| "format": "google-datetime", |
| "type": "string", |
| "description": "Timestamp of the phone call which resulted in a charged phone lead." |
| } |
| }, |
| "description": "Container for phone lead specific information.", |
| "id": "GoogleAdsHomeservicesLocalservicesV1PhoneLead" |
| } |
| }, |
| "description": "", |
| "mtlsRootUrl": "https://localservices.mtls.googleapis.com/", |
| "fullyEncodeReservedExpansion": true, |
| "baseUrl": "https://localservices.googleapis.com/", |
| "discoveryVersion": "v1", |
| "canonicalName": "Localservices", |
| "ownerName": "Google", |
| "kind": "discovery#restDescription", |
| "title": "Local Services API", |
| "id": "localservices:v1", |
| "parameters": { |
| "alt": { |
| "type": "string", |
| "default": "json", |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "location": "query", |
| "description": "Data format for response." |
| }, |
| "callback": { |
| "description": "JSONP", |
| "type": "string", |
| "location": "query" |
| }, |
| "oauth_token": { |
| "type": "string", |
| "description": "OAuth 2.0 token for the current user.", |
| "location": "query" |
| }, |
| "upload_protocol": { |
| "type": "string", |
| "location": "query", |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." |
| }, |
| "fields": { |
| "type": "string", |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query" |
| }, |
| "access_token": { |
| "description": "OAuth access token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "prettyPrint": { |
| "description": "Returns response with indentations and line breaks.", |
| "default": "true", |
| "type": "boolean", |
| "location": "query" |
| }, |
| "$.xgafv": { |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "description": "V1 error format.", |
| "type": "string", |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "location": "query" |
| }, |
| "key": { |
| "description": "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "quotaUser": { |
| "type": "string", |
| "location": "query", |
| "description": "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": { |
| "location": "query", |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "type": "string" |
| } |
| }, |
| "version_module": true, |
| "version": "v1", |
| "protocol": "rest", |
| "servicePath": "", |
| "batchPath": "batch", |
| "basePath": "", |
| "resources": { |
| "detailedLeadReports": { |
| "methods": { |
| "search": { |
| "flatPath": "v1/detailedLeadReports:search", |
| "description": "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.", |
| "parameterOrder": [], |
| "parameters": { |
| "startDate.month": { |
| "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", |
| "location": "query", |
| "type": "integer", |
| "format": "int32" |
| }, |
| "pageSize": { |
| "type": "integer", |
| "description": "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.", |
| "location": "query", |
| "format": "int32" |
| }, |
| "endDate.day": { |
| "location": "query", |
| "description": "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.", |
| "type": "integer", |
| "format": "int32" |
| }, |
| "startDate.day": { |
| "type": "integer", |
| "location": "query", |
| "format": "int32", |
| "description": "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.year": { |
| "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", |
| "format": "int32", |
| "type": "integer", |
| "location": "query" |
| }, |
| "pageToken": { |
| "location": "query", |
| "description": "The `next_page_token` value returned from a previous request to SearchDetailedLeadReports that indicates where listing should continue. Optional.", |
| "type": "string" |
| }, |
| "startDate.year": { |
| "type": "integer", |
| "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", |
| "format": "int32", |
| "location": "query" |
| }, |
| "endDate.month": { |
| "location": "query", |
| "format": "int32", |
| "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", |
| "type": "integer" |
| }, |
| "query": { |
| "type": "string", |
| "location": "query", |
| "description": "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." |
| } |
| }, |
| "httpMethod": "GET", |
| "id": "localservices.detailedLeadReports.search", |
| "path": "v1/detailedLeadReports:search", |
| "response": { |
| "$ref": "GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse" |
| } |
| } |
| } |
| }, |
| "accountReports": { |
| "methods": { |
| "search": { |
| "parameterOrder": [], |
| "parameters": { |
| "startDate.month": { |
| "type": "integer", |
| "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", |
| "format": "int32", |
| "location": "query" |
| }, |
| "pageToken": { |
| "description": "The `next_page_token` value returned from a previous request to SearchAccountReports that indicates where listing should continue. Optional.", |
| "type": "string", |
| "location": "query" |
| }, |
| "query": { |
| "location": "query", |
| "description": "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.", |
| "type": "string" |
| }, |
| "pageSize": { |
| "type": "integer", |
| "description": "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.", |
| "location": "query", |
| "format": "int32" |
| }, |
| "startDate.year": { |
| "format": "int32", |
| "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", |
| "location": "query", |
| "type": "integer" |
| }, |
| "endDate.day": { |
| "format": "int32", |
| "type": "integer", |
| "location": "query", |
| "description": "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.year": { |
| "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", |
| "type": "integer", |
| "location": "query", |
| "format": "int32" |
| }, |
| "endDate.month": { |
| "format": "int32", |
| "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", |
| "type": "integer", |
| "location": "query" |
| }, |
| "startDate.day": { |
| "format": "int32", |
| "description": "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.", |
| "type": "integer", |
| "location": "query" |
| } |
| }, |
| "flatPath": "v1/accountReports:search", |
| "httpMethod": "GET", |
| "response": { |
| "$ref": "GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse" |
| }, |
| "description": "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.", |
| "id": "localservices.accountReports.search", |
| "path": "v1/accountReports:search" |
| } |
| } |
| } |
| }, |
| "ownerDomain": "google.com" |
| } |
