Keys that can be defined in :attr:`Request.meta <scrapy.http.Request.meta>` for scrapy-zyte-api.
.. reqmeta:: zyte_api
Default: False
See :ref:`manual`.
.. reqmeta:: zyte_api_automap
Default: :setting:`ZYTE_API_TRANSPARENT_MODE` (False)
See :ref:`automap`.
.. reqmeta:: zyte_api_default_params
Default: True
If set to False, the values of :setting:`ZYTE_API_AUTOMAP_PARAMS` and
:setting:`ZYTE_API_DEFAULT_PARAMS` are ignored for this request.
.. reqmeta:: zyte_api_provider
Default: {}
Sets Zyte API parameters to include into requests made by the :ref:`scrapy-poet integration <scrapy-poet>`.
For example:
Request(
"https://example.com",
meta={
"zyte_api_provider": {
"requestCookies": [
{"name": "a", "value": "b", "domain": "example.com"},
],
}
},
)See also :setting:`ZYTE_API_PROVIDER_PARAMS`.
.. reqmeta:: zyte_api_retry_policy
Default: :setting:`ZYTE_API_RETRY_POLICY` (:data:`zyte_api.aio.retry.zyte_api_retrying`)
Determines the retry policy for Zyte API requests used to fulfill this request.
It must be a :class:`tenacity.AsyncRetrying` subclass or its import path as a string.
Note
If you need your request to be serializable, e.g. to use :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`, you must specify the import path of your retry policy class as a string, because retry policies are not serializable.
See :ref:`retry`.
.. reqmeta:: zyte_api_session_enabled
Default: :setting:`ZYTE_API_SESSION_ENABLED`
Whether to send the request with a :ref:`plugin-managed session <session>`
(True) or not (False).
.. seealso:: :meth:`scrapy_zyte_api.SessionConfig.enabled`
.. reqmeta:: zyte_api_session_location
Default: {}
See :ref:`session-init` for general information about location configuration and parameter precedence.
Example:
Request(
"https://example.com",
meta={
"zyte_api_session_location": {"postalCode": "10001"},
},
).. reqmeta:: zyte_api_session_params
Default: {}
See :ref:`session-init` for general information about defining session initialization parameters and parameter precedence.
.. reqmeta:: zyte_api_session_pool
Default: ""
If not falsy, it determines the default output of :meth:`scrapy_zyte_api.SessionConfig.pool` for the request.