| Name | Type | Description | Notes |
|---|---|---|---|
| Query | string | Search query to inspect. | |
| Target | Pointer to string | Optional domain or URL to mark in the results, such as example.com or https://example.com/page. | [optional] |
| Location | Pointer to SeoSerpLocation | [optional] | |
| Language | Pointer to string | Search language as an ISO code or full language name. Defaults to en. | [optional] |
| Device | Pointer to string | SERP device type. Defaults to desktop. | [optional] |
| Os | Pointer to SeoSerpOs | [optional] | |
| Page | Pointer to int32 | 1-based Google result page to start from. Defaults to 1. Implemented with Google's start parameter and ranks are adjusted to global SERP positions. | [optional] |
| Depth | Pointer to int32 | Organic result depth to crawl from the requested page. Defaults to 10. DataForSEO bills source in 10-result pages; UnifAPI bills returned billable organic records. | [optional] |
| Limit | Pointer to int32 | Number of organic results to return, matching the limit parameter used across other UnifAPI endpoints. Maps to DataForSEO depth and is used only when depth is omitted; defaults to 10. | [optional] |
| View | Pointer to SeoSerpView | [optional] | |
| IncludeAiOverview | Pointer to bool | When true, ask DataForSEO to load asynchronous Google AI Overview blocks in the organic SERP when available. This can add source cost. | [optional] |
| PeopleAlsoAskDepth | Pointer to int32 | Optional click depth for People Also Ask expansion. Useful for SEO content-gap research and can add source cost. | [optional] |
| IncludePixelRankings | Pointer to bool | When true, request pixel rectangle data for above-the-fold and visual rank analysis. This can add source cost. | [optional] |
| Viewport | Pointer to SeoSerpViewport | [optional] | |
| GoogleDomain | Pointer to string | Optional Google domain override such as google.co.uk or google.de. | [optional] |
| GoogleSearchParams | Pointer to string | Advanced Google search URL parameters such as nfpr=1. Prefer typed fields like page and include_omitted_results when available. | [optional] |
| IncludeOmittedResults | Pointer to bool | When true, adds filter=0 to inspect Google results that may otherwise be omitted. Useful for deep rank checks. | [optional] |
| RemoveUrlParams | Pointer to []string | URL query parameters to remove from result URLs before matching, such as srsltid. | [optional] |
| ExpandRelatedResults | Pointer to bool | When true, return related/sitelink-style organic results as separate organic elements instead of nesting them. | [optional] |
| StopAtTarget | Pointer to bool | When true and target is provided, stop crawling once the target is found. Useful for cheaper deep-rank checks, but later competitors may be omitted. | [optional] |
| TargetMatch | Pointer to SeoSerpTargetMatch | [optional] | |
| TargetSearchMode | Pointer to SeoSerpTargetSearchMode | [optional] | |
| TargetElementTypes | Pointer to []SeoSerpTargetElementType | SERP element types to inspect for stop_at_target matches. Defaults to all first-level URL/domain elements. | [optional] |
func NewSeoSerpRequest(query string, ) *SeoSerpRequest
NewSeoSerpRequest instantiates a new SeoSerpRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed
func NewSeoSerpRequestWithDefaults() *SeoSerpRequest
NewSeoSerpRequestWithDefaults instantiates a new SeoSerpRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set
func (o *SeoSerpRequest) GetQuery() string
GetQuery returns the Query field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetQueryOk() (*string, bool)
GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetQuery(v string)
SetQuery sets Query field to given value.
func (o *SeoSerpRequest) GetTarget() string
GetTarget returns the Target field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetTargetOk() (*string, bool)
GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetTarget(v string)
SetTarget sets Target field to given value.
func (o *SeoSerpRequest) HasTarget() bool
HasTarget returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetLocation() SeoSerpLocation
GetLocation returns the Location field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetLocationOk() (*SeoSerpLocation, bool)
GetLocationOk returns a tuple with the Location field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetLocation(v SeoSerpLocation)
SetLocation sets Location field to given value.
func (o *SeoSerpRequest) HasLocation() bool
HasLocation returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetLanguage() string
GetLanguage returns the Language field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetLanguageOk() (*string, bool)
GetLanguageOk returns a tuple with the Language field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetLanguage(v string)
SetLanguage sets Language field to given value.
func (o *SeoSerpRequest) HasLanguage() bool
HasLanguage returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetDevice() string
GetDevice returns the Device field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetDeviceOk() (*string, bool)
GetDeviceOk returns a tuple with the Device field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetDevice(v string)
SetDevice sets Device field to given value.
func (o *SeoSerpRequest) HasDevice() bool
HasDevice returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetOs() SeoSerpOs
GetOs returns the Os field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetOsOk() (*SeoSerpOs, bool)
GetOsOk returns a tuple with the Os field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetOs(v SeoSerpOs)
SetOs sets Os field to given value.
func (o *SeoSerpRequest) HasOs() bool
HasOs returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetPage() int32
GetPage returns the Page field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetPageOk() (*int32, bool)
GetPageOk returns a tuple with the Page field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetPage(v int32)
SetPage sets Page field to given value.
func (o *SeoSerpRequest) HasPage() bool
HasPage returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetDepth() int32
GetDepth returns the Depth field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetDepthOk() (*int32, bool)
GetDepthOk returns a tuple with the Depth field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetDepth(v int32)
SetDepth sets Depth field to given value.
func (o *SeoSerpRequest) HasDepth() bool
HasDepth returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetLimit() int32
GetLimit returns the Limit field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetLimitOk() (*int32, bool)
GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetLimit(v int32)
SetLimit sets Limit field to given value.
func (o *SeoSerpRequest) HasLimit() bool
HasLimit returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetView() SeoSerpView
GetView returns the View field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetViewOk() (*SeoSerpView, bool)
GetViewOk returns a tuple with the View field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetView(v SeoSerpView)
SetView sets View field to given value.
func (o *SeoSerpRequest) HasView() bool
HasView returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetIncludeAiOverview() bool
GetIncludeAiOverview returns the IncludeAiOverview field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetIncludeAiOverviewOk() (*bool, bool)
GetIncludeAiOverviewOk returns a tuple with the IncludeAiOverview field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetIncludeAiOverview(v bool)
SetIncludeAiOverview sets IncludeAiOverview field to given value.
func (o *SeoSerpRequest) HasIncludeAiOverview() bool
HasIncludeAiOverview returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetPeopleAlsoAskDepth() int32
GetPeopleAlsoAskDepth returns the PeopleAlsoAskDepth field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetPeopleAlsoAskDepthOk() (*int32, bool)
GetPeopleAlsoAskDepthOk returns a tuple with the PeopleAlsoAskDepth field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetPeopleAlsoAskDepth(v int32)
SetPeopleAlsoAskDepth sets PeopleAlsoAskDepth field to given value.
func (o *SeoSerpRequest) HasPeopleAlsoAskDepth() bool
HasPeopleAlsoAskDepth returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetIncludePixelRankings() bool
GetIncludePixelRankings returns the IncludePixelRankings field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetIncludePixelRankingsOk() (*bool, bool)
GetIncludePixelRankingsOk returns a tuple with the IncludePixelRankings field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetIncludePixelRankings(v bool)
SetIncludePixelRankings sets IncludePixelRankings field to given value.
func (o *SeoSerpRequest) HasIncludePixelRankings() bool
HasIncludePixelRankings returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetViewport() SeoSerpViewport
GetViewport returns the Viewport field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetViewportOk() (*SeoSerpViewport, bool)
GetViewportOk returns a tuple with the Viewport field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetViewport(v SeoSerpViewport)
SetViewport sets Viewport field to given value.
func (o *SeoSerpRequest) HasViewport() bool
HasViewport returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetGoogleDomain() string
GetGoogleDomain returns the GoogleDomain field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetGoogleDomainOk() (*string, bool)
GetGoogleDomainOk returns a tuple with the GoogleDomain field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetGoogleDomain(v string)
SetGoogleDomain sets GoogleDomain field to given value.
func (o *SeoSerpRequest) HasGoogleDomain() bool
HasGoogleDomain returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetGoogleSearchParams() string
GetGoogleSearchParams returns the GoogleSearchParams field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetGoogleSearchParamsOk() (*string, bool)
GetGoogleSearchParamsOk returns a tuple with the GoogleSearchParams field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetGoogleSearchParams(v string)
SetGoogleSearchParams sets GoogleSearchParams field to given value.
func (o *SeoSerpRequest) HasGoogleSearchParams() bool
HasGoogleSearchParams returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetIncludeOmittedResults() bool
GetIncludeOmittedResults returns the IncludeOmittedResults field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetIncludeOmittedResultsOk() (*bool, bool)
GetIncludeOmittedResultsOk returns a tuple with the IncludeOmittedResults field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetIncludeOmittedResults(v bool)
SetIncludeOmittedResults sets IncludeOmittedResults field to given value.
func (o *SeoSerpRequest) HasIncludeOmittedResults() bool
HasIncludeOmittedResults returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetRemoveUrlParams() []string
GetRemoveUrlParams returns the RemoveUrlParams field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetRemoveUrlParamsOk() (*[]string, bool)
GetRemoveUrlParamsOk returns a tuple with the RemoveUrlParams field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetRemoveUrlParams(v []string)
SetRemoveUrlParams sets RemoveUrlParams field to given value.
func (o *SeoSerpRequest) HasRemoveUrlParams() bool
HasRemoveUrlParams returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetExpandRelatedResults() bool
GetExpandRelatedResults returns the ExpandRelatedResults field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetExpandRelatedResultsOk() (*bool, bool)
GetExpandRelatedResultsOk returns a tuple with the ExpandRelatedResults field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetExpandRelatedResults(v bool)
SetExpandRelatedResults sets ExpandRelatedResults field to given value.
func (o *SeoSerpRequest) HasExpandRelatedResults() bool
HasExpandRelatedResults returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetStopAtTarget() bool
GetStopAtTarget returns the StopAtTarget field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetStopAtTargetOk() (*bool, bool)
GetStopAtTargetOk returns a tuple with the StopAtTarget field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetStopAtTarget(v bool)
SetStopAtTarget sets StopAtTarget field to given value.
func (o *SeoSerpRequest) HasStopAtTarget() bool
HasStopAtTarget returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetTargetMatch() SeoSerpTargetMatch
GetTargetMatch returns the TargetMatch field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetTargetMatchOk() (*SeoSerpTargetMatch, bool)
GetTargetMatchOk returns a tuple with the TargetMatch field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetTargetMatch(v SeoSerpTargetMatch)
SetTargetMatch sets TargetMatch field to given value.
func (o *SeoSerpRequest) HasTargetMatch() bool
HasTargetMatch returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetTargetSearchMode() SeoSerpTargetSearchMode
GetTargetSearchMode returns the TargetSearchMode field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetTargetSearchModeOk() (*SeoSerpTargetSearchMode, bool)
GetTargetSearchModeOk returns a tuple with the TargetSearchMode field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetTargetSearchMode(v SeoSerpTargetSearchMode)
SetTargetSearchMode sets TargetSearchMode field to given value.
func (o *SeoSerpRequest) HasTargetSearchMode() bool
HasTargetSearchMode returns a boolean if a field has been set.
func (o *SeoSerpRequest) GetTargetElementTypes() []SeoSerpTargetElementType
GetTargetElementTypes returns the TargetElementTypes field if non-nil, zero value otherwise.
func (o *SeoSerpRequest) GetTargetElementTypesOk() (*[]SeoSerpTargetElementType, bool)
GetTargetElementTypesOk returns a tuple with the TargetElementTypes field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *SeoSerpRequest) SetTargetElementTypes(v []SeoSerpTargetElementType)
SetTargetElementTypes sets TargetElementTypes field to given value.
func (o *SeoSerpRequest) HasTargetElementTypes() bool
HasTargetElementTypes returns a boolean if a field has been set.