Documentation ¶
Overview ¶
Package localservices provides access to the Local Services API.
For product documentation, see: https://ads.google.com/local-services-ads/
Library status ¶
These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.
When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.
Creating a client ¶
Usage example:
import "google.golang.org/api/localservices/v1" ... ctx := context.Background() localservicesService, err := localservices.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:
localservicesService, err := localservices.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) localservicesService, err := localservices.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See google.golang.org/api/option.ClientOption for details on options.
Index ¶
- Constants
- type AccountReportsSearchCall
- func (c *AccountReportsSearchCall) Context(ctx context.Context) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) Do(opts ...googleapi.CallOption) (*GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse, error)
- func (c *AccountReportsSearchCall) EndDateDay(endDateDay int64) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) EndDateMonth(endDateMonth int64) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) EndDateYear(endDateYear int64) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) Fields(s ...googleapi.Field) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) Header() http.Header
- func (c *AccountReportsSearchCall) IfNoneMatch(entityTag string) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) PageSize(pageSize int64) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) PageToken(pageToken string) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) Pages(ctx context.Context, ...) error
- func (c *AccountReportsSearchCall) Query(query string) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) StartDateDay(startDateDay int64) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) StartDateMonth(startDateMonth int64) *AccountReportsSearchCall
- func (c *AccountReportsSearchCall) StartDateYear(startDateYear int64) *AccountReportsSearchCall
- type AccountReportsService
- type DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) Context(ctx context.Context) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) Do(opts ...googleapi.CallOption) (*GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse, error)
- func (c *DetailedLeadReportsSearchCall) EndDateDay(endDateDay int64) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) EndDateMonth(endDateMonth int64) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) EndDateYear(endDateYear int64) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) Fields(s ...googleapi.Field) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) Header() http.Header
- func (c *DetailedLeadReportsSearchCall) IfNoneMatch(entityTag string) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) PageSize(pageSize int64) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) PageToken(pageToken string) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) Pages(ctx context.Context, ...) error
- func (c *DetailedLeadReportsSearchCall) Query(query string) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) StartDateDay(startDateDay int64) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) StartDateMonth(startDateMonth int64) *DetailedLeadReportsSearchCall
- func (c *DetailedLeadReportsSearchCall) StartDateYear(startDateYear int64) *DetailedLeadReportsSearchCall
- type DetailedLeadReportsService
- type GoogleAdsHomeservicesLocalservicesV1AccountReport
- type GoogleAdsHomeservicesLocalservicesV1AggregatorInfo
- type GoogleAdsHomeservicesLocalservicesV1BookingLead
- type GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport
- type GoogleAdsHomeservicesLocalservicesV1MessageLead
- type GoogleAdsHomeservicesLocalservicesV1PhoneLead
- type GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse
- type GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse
- type GoogleTypeTimeZone
- type Service
Constants ¶
const (
// See, edit, create, and delete your Google Ads accounts and data.
AdwordsScope = "https://www.googleapis.com/auth/adwords"
)
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountReportsSearchCall ¶
type AccountReportsSearchCall struct {
// contains filtered or unexported fields
}
func (*AccountReportsSearchCall) Context ¶
func (c *AccountReportsSearchCall) Context(ctx context.Context) *AccountReportsSearchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AccountReportsSearchCall) Do ¶
func (c *AccountReportsSearchCall) Do(opts ...googleapi.CallOption) (*GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse, error)
Do executes the "localservices.accountReports.search" call. Exactly one of *GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse.Serv erResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*AccountReportsSearchCall) EndDateDay ¶
func (c *AccountReportsSearchCall) EndDateDay(endDateDay int64) *AccountReportsSearchCall
EndDateDay sets the optional parameter "endDate.day": 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.
func (*AccountReportsSearchCall) EndDateMonth ¶
func (c *AccountReportsSearchCall) EndDateMonth(endDateMonth int64) *AccountReportsSearchCall
EndDateMonth sets the optional parameter "endDate.month": Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
func (*AccountReportsSearchCall) EndDateYear ¶
func (c *AccountReportsSearchCall) EndDateYear(endDateYear int64) *AccountReportsSearchCall
EndDateYear sets the optional parameter "endDate.year": Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
func (*AccountReportsSearchCall) Fields ¶
func (c *AccountReportsSearchCall) Fields(s ...googleapi.Field) *AccountReportsSearchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AccountReportsSearchCall) Header ¶
func (c *AccountReportsSearchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*AccountReportsSearchCall) IfNoneMatch ¶
func (c *AccountReportsSearchCall) IfNoneMatch(entityTag string) *AccountReportsSearchCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*AccountReportsSearchCall) PageSize ¶
func (c *AccountReportsSearchCall) PageSize(pageSize int64) *AccountReportsSearchCall
PageSize sets the optional parameter "pageSize": The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000.
func (*AccountReportsSearchCall) PageToken ¶
func (c *AccountReportsSearchCall) PageToken(pageToken string) *AccountReportsSearchCall
PageToken sets the optional parameter "pageToken": The `next_page_token` value returned from a previous request to SearchAccountReports that indicates where listing should continue.
func (*AccountReportsSearchCall) Pages ¶
func (c *AccountReportsSearchCall) Pages(ctx context.Context, f func(*GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*AccountReportsSearchCall) Query ¶
func (c *AccountReportsSearchCall) Query(query string) *AccountReportsSearchCall
Query sets the optional parameter "query": 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.
func (*AccountReportsSearchCall) StartDateDay ¶
func (c *AccountReportsSearchCall) StartDateDay(startDateDay int64) *AccountReportsSearchCall
StartDateDay sets the optional parameter "startDate.day": 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.
func (*AccountReportsSearchCall) StartDateMonth ¶
func (c *AccountReportsSearchCall) StartDateMonth(startDateMonth int64) *AccountReportsSearchCall
StartDateMonth sets the optional parameter "startDate.month": Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
func (*AccountReportsSearchCall) StartDateYear ¶
func (c *AccountReportsSearchCall) StartDateYear(startDateYear int64) *AccountReportsSearchCall
StartDateYear sets the optional parameter "startDate.year": Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
type AccountReportsService ¶
type AccountReportsService struct {
// contains filtered or unexported fields
}
func NewAccountReportsService ¶
func NewAccountReportsService(s *Service) *AccountReportsService
func (*AccountReportsService) Search ¶
func (r *AccountReportsService) Search() *AccountReportsSearchCall
Search: 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.
type DetailedLeadReportsSearchCall ¶
type DetailedLeadReportsSearchCall struct {
// contains filtered or unexported fields
}
func (*DetailedLeadReportsSearchCall) Context ¶
func (c *DetailedLeadReportsSearchCall) Context(ctx context.Context) *DetailedLeadReportsSearchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*DetailedLeadReportsSearchCall) Do ¶
func (c *DetailedLeadReportsSearchCall) Do(opts ...googleapi.CallOption) (*GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse, error)
Do executes the "localservices.detailedLeadReports.search" call. Exactly one of *GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse
or error will be non-nil. Any non-2xx status code is an error.
Response headers are in either *GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse .ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*DetailedLeadReportsSearchCall) EndDateDay ¶
func (c *DetailedLeadReportsSearchCall) EndDateDay(endDateDay int64) *DetailedLeadReportsSearchCall
EndDateDay sets the optional parameter "endDate.day": 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.
func (*DetailedLeadReportsSearchCall) EndDateMonth ¶
func (c *DetailedLeadReportsSearchCall) EndDateMonth(endDateMonth int64) *DetailedLeadReportsSearchCall
EndDateMonth sets the optional parameter "endDate.month": Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
func (*DetailedLeadReportsSearchCall) EndDateYear ¶
func (c *DetailedLeadReportsSearchCall) EndDateYear(endDateYear int64) *DetailedLeadReportsSearchCall
EndDateYear sets the optional parameter "endDate.year": Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
func (*DetailedLeadReportsSearchCall) Fields ¶
func (c *DetailedLeadReportsSearchCall) Fields(s ...googleapi.Field) *DetailedLeadReportsSearchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*DetailedLeadReportsSearchCall) Header ¶
func (c *DetailedLeadReportsSearchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*DetailedLeadReportsSearchCall) IfNoneMatch ¶
func (c *DetailedLeadReportsSearchCall) IfNoneMatch(entityTag string) *DetailedLeadReportsSearchCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*DetailedLeadReportsSearchCall) PageSize ¶
func (c *DetailedLeadReportsSearchCall) PageSize(pageSize int64) *DetailedLeadReportsSearchCall
PageSize sets the optional parameter "pageSize": The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000.
func (*DetailedLeadReportsSearchCall) PageToken ¶
func (c *DetailedLeadReportsSearchCall) PageToken(pageToken string) *DetailedLeadReportsSearchCall
PageToken sets the optional parameter "pageToken": The `next_page_token` value returned from a previous request to SearchDetailedLeadReports that indicates where listing should continue.
func (*DetailedLeadReportsSearchCall) Pages ¶
func (c *DetailedLeadReportsSearchCall) Pages(ctx context.Context, f func(*GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*DetailedLeadReportsSearchCall) Query ¶
func (c *DetailedLeadReportsSearchCall) Query(query string) *DetailedLeadReportsSearchCall
Query sets the optional parameter "query": 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.
func (*DetailedLeadReportsSearchCall) StartDateDay ¶
func (c *DetailedLeadReportsSearchCall) StartDateDay(startDateDay int64) *DetailedLeadReportsSearchCall
StartDateDay sets the optional parameter "startDate.day": 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.
func (*DetailedLeadReportsSearchCall) StartDateMonth ¶
func (c *DetailedLeadReportsSearchCall) StartDateMonth(startDateMonth int64) *DetailedLeadReportsSearchCall
StartDateMonth sets the optional parameter "startDate.month": Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
func (*DetailedLeadReportsSearchCall) StartDateYear ¶
func (c *DetailedLeadReportsSearchCall) StartDateYear(startDateYear int64) *DetailedLeadReportsSearchCall
StartDateYear sets the optional parameter "startDate.year": Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
type DetailedLeadReportsService ¶
type DetailedLeadReportsService struct {
// contains filtered or unexported fields
}
func NewDetailedLeadReportsService ¶
func NewDetailedLeadReportsService(s *Service) *DetailedLeadReportsService
func (*DetailedLeadReportsService) Search ¶
func (r *DetailedLeadReportsService) Search() *DetailedLeadReportsSearchCall
Search: 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.
type GoogleAdsHomeservicesLocalservicesV1AccountReport ¶
type GoogleAdsHomeservicesLocalservicesV1AccountReport struct { // AccountId: Unique identifier of the GLS account. AccountId int64 `json:"accountId,omitempty,string"` // AggregatorInfo: Aggregator specific information related to the // account. AggregatorInfo *GoogleAdsHomeservicesLocalservicesV1AggregatorInfo `json:"aggregatorInfo,omitempty"` // AverageFiveStarRating: Average review rating score from 1-5 stars. AverageFiveStarRating float64 `json:"averageFiveStarRating,omitempty"` // AverageWeeklyBudget: Average weekly budget in the currency code of // the account. AverageWeeklyBudget float64 `json:"averageWeeklyBudget,omitempty"` // BusinessName: Business name of the account. BusinessName string `json:"businessName,omitempty"` // CurrencyCode: Currency code of the account. CurrencyCode string `json:"currencyCode,omitempty"` // CurrentPeriodChargedLeads: Number of charged leads the account // received in current specified period. CurrentPeriodChargedLeads int64 `json:"currentPeriodChargedLeads,omitempty,string"` // CurrentPeriodConnectedPhoneCalls: Number of connected phone calls // (duration over 30s) in current specified period. CurrentPeriodConnectedPhoneCalls int64 `json:"currentPeriodConnectedPhoneCalls,omitempty,string"` // CurrentPeriodPhoneCalls: Number of phone calls in current specified // period, including both connected and unconnected calls. CurrentPeriodPhoneCalls int64 `json:"currentPeriodPhoneCalls,omitempty,string"` // CurrentPeriodTotalCost: Total cost of the account in current // specified period in the account's specified currency. CurrentPeriodTotalCost float64 `json:"currentPeriodTotalCost,omitempty"` // ImpressionsLastTwoDays: Number of impressions that customers have had // in the past 2 days. ImpressionsLastTwoDays int64 `json:"impressionsLastTwoDays,omitempty,string"` // PhoneLeadResponsiveness: 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. PhoneLeadResponsiveness float64 `json:"phoneLeadResponsiveness,omitempty"` // PreviousPeriodChargedLeads: Number of charged leads the account // received in previous specified period. PreviousPeriodChargedLeads int64 `json:"previousPeriodChargedLeads,omitempty,string"` // PreviousPeriodConnectedPhoneCalls: Number of connected phone calls // (duration over 30s) in previous specified period. PreviousPeriodConnectedPhoneCalls int64 `json:"previousPeriodConnectedPhoneCalls,omitempty,string"` // PreviousPeriodPhoneCalls: Number of phone calls in previous specified // period, including both connected and unconnected calls. PreviousPeriodPhoneCalls int64 `json:"previousPeriodPhoneCalls,omitempty,string"` // PreviousPeriodTotalCost: Total cost of the account in previous // specified period in the account's specified currency. PreviousPeriodTotalCost float64 `json:"previousPeriodTotalCost,omitempty"` // TotalReview: Total number of reviews the account has up to current // date. TotalReview int64 `json:"totalReview,omitempty"` // ForceSendFields is a list of field names (e.g. "AccountId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleAdsHomeservicesLocalservicesV1AccountReport: An Account Report of a GLS account identified by their account id containing aggregate data gathered from a particular date range. Next ID: 18
func (*GoogleAdsHomeservicesLocalservicesV1AccountReport) MarshalJSON ¶
func (s *GoogleAdsHomeservicesLocalservicesV1AccountReport) MarshalJSON() ([]byte, error)
func (*GoogleAdsHomeservicesLocalservicesV1AccountReport) UnmarshalJSON ¶
func (s *GoogleAdsHomeservicesLocalservicesV1AccountReport) UnmarshalJSON(data []byte) error
type GoogleAdsHomeservicesLocalservicesV1AggregatorInfo ¶
type GoogleAdsHomeservicesLocalservicesV1AggregatorInfo struct { // AggregatorProviderId: Provider id (listed in aggregator system) which // maps to a account id in GLS system. AggregatorProviderId string `json:"aggregatorProviderId,omitempty"` // ForceSendFields is a list of field names (e.g. // "AggregatorProviderId") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AggregatorProviderId") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleAdsHomeservicesLocalservicesV1AggregatorInfo: Conatiner for aggregator specific information if lead is for an aggregator GLS account.
func (*GoogleAdsHomeservicesLocalservicesV1AggregatorInfo) MarshalJSON ¶
func (s *GoogleAdsHomeservicesLocalservicesV1AggregatorInfo) MarshalJSON() ([]byte, error)
type GoogleAdsHomeservicesLocalservicesV1BookingLead ¶
type GoogleAdsHomeservicesLocalservicesV1BookingLead struct { // BookingAppointmentTimestamp: Timestamp of when service is provided by // advertiser. BookingAppointmentTimestamp string `json:"bookingAppointmentTimestamp,omitempty"` // ConsumerEmail: Consumer email associated with the booking lead. ConsumerEmail string `json:"consumerEmail,omitempty"` // ConsumerPhoneNumber: Consumer phone number associated with the // booking lead. ConsumerPhoneNumber string `json:"consumerPhoneNumber,omitempty"` // CustomerName: Name of the customer who created the lead. CustomerName string `json:"customerName,omitempty"` // JobType: The job type of the specified lead. JobType string `json:"jobType,omitempty"` // ForceSendFields is a list of field names (e.g. // "BookingAppointmentTimestamp") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "BookingAppointmentTimestamp") to include in API requests with the // JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
GoogleAdsHomeservicesLocalservicesV1BookingLead: Container for booking lead specific information.
func (*GoogleAdsHomeservicesLocalservicesV1BookingLead) MarshalJSON ¶
func (s *GoogleAdsHomeservicesLocalservicesV1BookingLead) MarshalJSON() ([]byte, error)
type GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport ¶
type GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport struct { // AccountId: Identifies account that received the lead. AccountId int64 `json:"accountId,omitempty,string"` // AggregatorInfo: Aggregator specific information related to the lead. AggregatorInfo *GoogleAdsHomeservicesLocalservicesV1AggregatorInfo `json:"aggregatorInfo,omitempty"` // BookingLead: More information associated to only booking leads. BookingLead *GoogleAdsHomeservicesLocalservicesV1BookingLead `json:"bookingLead,omitempty"` // BusinessName: Business name associated to the account. BusinessName string `json:"businessName,omitempty"` // ChargeStatus: Whether the lead has been charged. // // Possible values: // "CHARGE_STATUS_UNSPECIFIED" - Not specified. // "CHARGED" - Charged. // "NOT_CHARGED" - Not charged. ChargeStatus string `json:"chargeStatus,omitempty"` // CurrencyCode: Currency code. CurrencyCode string `json:"currencyCode,omitempty"` // DisputeStatus: Dispute status related to the lead. DisputeStatus string `json:"disputeStatus,omitempty"` // Geo: Location of the associated account's home city. Geo string `json:"geo,omitempty"` // GoogleAdsLeadId: Unique identifier of a Detailed Lead Report. GoogleAdsLeadId int64 `json:"googleAdsLeadId,omitempty,string"` // LeadCategory: Lead category (e.g. hvac, plumber) LeadCategory string `json:"leadCategory,omitempty"` // LeadCreationTimestamp: Timestamp of when the lead was created. LeadCreationTimestamp string `json:"leadCreationTimestamp,omitempty"` // LeadId: Deprecated in favor of google_ads_lead_id. Unique identifier // of a Detailed Lead Report. LeadId int64 `json:"leadId,omitempty,string"` // LeadPrice: Price of the lead (available only after it has been // charged). LeadPrice float64 `json:"leadPrice,omitempty"` // LeadType: Lead type. // // Possible values: // "LEAD_TYPE_UNSPECIFIED" - Not specified. // "MESSAGE" - Message lead. // "PHONE_CALL" - Phone call lead. // "BOOKING" - Booking lead. LeadType string `json:"leadType,omitempty"` // MessageLead: More information associated to only message leads. MessageLead *GoogleAdsHomeservicesLocalservicesV1MessageLead `json:"messageLead,omitempty"` // PhoneLead: More information associated to only phone leads. PhoneLead *GoogleAdsHomeservicesLocalservicesV1PhoneLead `json:"phoneLead,omitempty"` // Timezone: Timezone of the particular provider associated to a lead. Timezone *GoogleTypeTimeZone `json:"timezone,omitempty"` // ForceSendFields is a list of field names (e.g. "AccountId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport: A Detailed Lead Report of a lead identified by their lead id and contains consumer, account, monetization, and lead data.
func (*GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport) MarshalJSON ¶
func (s *GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport) MarshalJSON() ([]byte, error)
func (*GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport) UnmarshalJSON ¶
func (s *GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport) UnmarshalJSON(data []byte) error
type GoogleAdsHomeservicesLocalservicesV1MessageLead ¶
type GoogleAdsHomeservicesLocalservicesV1MessageLead struct { // ConsumerPhoneNumber: Consumer phone number associated with the // message lead. ConsumerPhoneNumber string `json:"consumerPhoneNumber,omitempty"` // CustomerName: Name of the customer who created the lead. CustomerName string `json:"customerName,omitempty"` // JobType: The job type of the specified lead. JobType string `json:"jobType,omitempty"` // PostalCode: The postal code of the customer who created the lead. PostalCode string `json:"postalCode,omitempty"` // ForceSendFields is a list of field names (e.g. "ConsumerPhoneNumber") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConsumerPhoneNumber") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleAdsHomeservicesLocalservicesV1MessageLead: Container for message lead specific information.
func (*GoogleAdsHomeservicesLocalservicesV1MessageLead) MarshalJSON ¶
func (s *GoogleAdsHomeservicesLocalservicesV1MessageLead) MarshalJSON() ([]byte, error)
type GoogleAdsHomeservicesLocalservicesV1PhoneLead ¶
type GoogleAdsHomeservicesLocalservicesV1PhoneLead struct { // ChargedCallTimestamp: Timestamp of the phone call which resulted in a // charged phone lead. ChargedCallTimestamp string `json:"chargedCallTimestamp,omitempty"` // ChargedConnectedCallDurationSeconds: Duration of the charged phone // call in seconds. ChargedConnectedCallDurationSeconds string `json:"chargedConnectedCallDurationSeconds,omitempty"` // ConsumerPhoneNumber: Consumer phone number associated with the phone // lead. ConsumerPhoneNumber string `json:"consumerPhoneNumber,omitempty"` // ForceSendFields is a list of field names (e.g. // "ChargedCallTimestamp") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ChargedCallTimestamp") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleAdsHomeservicesLocalservicesV1PhoneLead: Container for phone lead specific information.
func (*GoogleAdsHomeservicesLocalservicesV1PhoneLead) MarshalJSON ¶
func (s *GoogleAdsHomeservicesLocalservicesV1PhoneLead) MarshalJSON() ([]byte, error)
type GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse ¶
type GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse struct { // AccountReports: List of account reports which maps 1:1 to a // particular linked GLS account. AccountReports []*GoogleAdsHomeservicesLocalservicesV1AccountReport `json:"accountReports,omitempty"` // NextPageToken: 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. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AccountReports") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountReports") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse: 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.
func (*GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse) MarshalJSON ¶
func (s *GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse) MarshalJSON() ([]byte, error)
type GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse ¶
type GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse struct { // DetailedLeadReports: List of detailed lead reports uniquely // identified by external lead id. DetailedLeadReports []*GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport `json:"detailedLeadReports,omitempty"` // NextPageToken: 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. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "DetailedLeadReports") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DetailedLeadReports") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse:
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.
func (*GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse) MarshalJSON ¶
func (s *GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse) MarshalJSON() ([]byte, error)
type GoogleTypeTimeZone ¶
type GoogleTypeTimeZone struct { // Id: IANA Time Zone Database time zone, e.g. "America/New_York". Id string `json:"id,omitempty"` // Version: Optional. IANA Time Zone Database version number, e.g. // "2019a". Version string `json:"version,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Id") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleTypeTimeZone: Represents a time zone from the IANA Time Zone Database (https://www.iana.org/time-zones).
func (*GoogleTypeTimeZone) MarshalJSON ¶
func (s *GoogleTypeTimeZone) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment AccountReports *AccountReportsService DetailedLeadReports *DetailedLeadReportsService // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶
NewService creates a new Service.