You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
328 lines
16 KiB
328 lines
16 KiB
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="partners_v2.html">Google Partners API</a> . <a href="partners_v2.analytics.html">analytics</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(pageSize=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, pageToken=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p>
|
|
<p class="firstline">Lists analytics data for a user's associated company.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="list">list(pageSize=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, pageToken=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code>
|
|
<pre>Lists analytics data for a user's associated company.
|
|
Should only be called within the context of an authorized logged in user.
|
|
|
|
Args:
|
|
pageSize: integer, Requested page size. Server may return fewer analytics than requested.
|
|
If unspecified or set to 0, default value is 30.
|
|
Specifies the number of days in the date range when querying analytics.
|
|
The `page_token` represents the end date of the date range
|
|
and the start date is calculated using the `page_size` as the number
|
|
of days BEFORE the end date.
|
|
Must be a non-negative integer.
|
|
requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
|
|
requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from.
|
|
An identifier has multiple letters created by a team which redirected the
|
|
traffic to us.
|
|
requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
requestMetadata_locale: string, Locale to use for the current request.
|
|
pageToken: string, A token identifying a page of results that the server returns.
|
|
Typically, this is the value of `ListAnalyticsResponse.next_page_token`
|
|
returned from the previous call to
|
|
ListAnalytics.
|
|
Will be a date string in `YYYY-MM-DD` format representing the end date
|
|
of the date range of results to return.
|
|
If unspecified or set to "", default value is the current date.
|
|
requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
|
|
requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from.
|
|
An identifier has multiple letters created by a team which redirected the
|
|
traffic to us.
|
|
requestMetadata_partnersSessionId: string, Google Partners session ID.
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response message for
|
|
# ListAnalytics.
|
|
"nextPageToken": "A String", # A token to retrieve next page of results.
|
|
# Pass this value in the `ListAnalyticsRequest.page_token` field in the
|
|
# subsequent call to
|
|
# ListAnalytics to retrieve the
|
|
# next page of results.
|
|
"analytics": [ # The list of analytics.
|
|
# Sorted in ascending order of
|
|
# Analytics.event_date.
|
|
{ # Analytics data for a `Company` within a single day.
|
|
"searchViews": { # Details of the analytics events for a `Company` within a single day. # Instances of users seeing the `Company` in Google Partners Search results
|
|
# on the specified date.
|
|
"eventLocations": [ # Location information of where these events occurred.
|
|
{ # An object representing a latitude/longitude pair. This is expressed as a pair
|
|
# of doubles representing degrees latitude and degrees longitude. Unless
|
|
# specified otherwise, this must conform to the
|
|
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
|
|
# standard</a>. Values must be within normalized ranges.
|
|
#
|
|
# Example of normalization code in Python:
|
|
#
|
|
# def NormalizeLongitude(longitude):
|
|
# """Wraps decimal degrees longitude to [-180.0, 180.0]."""
|
|
# q, r = divmod(longitude, 360.0)
|
|
# if r > 180.0 or (r == 180.0 and q <= -1.0):
|
|
# return r - 360.0
|
|
# return r
|
|
#
|
|
# def NormalizeLatLng(latitude, longitude):
|
|
# """Wraps decimal degrees latitude and longitude to
|
|
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
|
|
# r = latitude % 360.0
|
|
# if r <= 90.0:
|
|
# return r, NormalizeLongitude(longitude)
|
|
# elif r >= 270.0:
|
|
# return r - 360, NormalizeLongitude(longitude)
|
|
# else:
|
|
# return 180 - r, NormalizeLongitude(longitude + 180.0)
|
|
#
|
|
# assert 180.0 == NormalizeLongitude(180.0)
|
|
# assert -180.0 == NormalizeLongitude(-180.0)
|
|
# assert -179.0 == NormalizeLongitude(181.0)
|
|
# assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
|
|
# assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
|
|
# assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
|
|
# assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
|
|
# assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
|
|
# assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
|
|
# assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
|
|
# assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
|
|
# assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
|
|
# assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
|
|
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
|
|
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
|
|
},
|
|
],
|
|
"eventCount": 42, # Number of times the type of event occurred.
|
|
# Meaning depends on context (e.g. profile views, contacts, etc.).
|
|
},
|
|
"contacts": { # Details of the analytics events for a `Company` within a single day. # Instances of users contacting the `Company`
|
|
# on the specified date.
|
|
"eventLocations": [ # Location information of where these events occurred.
|
|
{ # An object representing a latitude/longitude pair. This is expressed as a pair
|
|
# of doubles representing degrees latitude and degrees longitude. Unless
|
|
# specified otherwise, this must conform to the
|
|
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
|
|
# standard</a>. Values must be within normalized ranges.
|
|
#
|
|
# Example of normalization code in Python:
|
|
#
|
|
# def NormalizeLongitude(longitude):
|
|
# """Wraps decimal degrees longitude to [-180.0, 180.0]."""
|
|
# q, r = divmod(longitude, 360.0)
|
|
# if r > 180.0 or (r == 180.0 and q <= -1.0):
|
|
# return r - 360.0
|
|
# return r
|
|
#
|
|
# def NormalizeLatLng(latitude, longitude):
|
|
# """Wraps decimal degrees latitude and longitude to
|
|
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
|
|
# r = latitude % 360.0
|
|
# if r <= 90.0:
|
|
# return r, NormalizeLongitude(longitude)
|
|
# elif r >= 270.0:
|
|
# return r - 360, NormalizeLongitude(longitude)
|
|
# else:
|
|
# return 180 - r, NormalizeLongitude(longitude + 180.0)
|
|
#
|
|
# assert 180.0 == NormalizeLongitude(180.0)
|
|
# assert -180.0 == NormalizeLongitude(-180.0)
|
|
# assert -179.0 == NormalizeLongitude(181.0)
|
|
# assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
|
|
# assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
|
|
# assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
|
|
# assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
|
|
# assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
|
|
# assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
|
|
# assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
|
|
# assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
|
|
# assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
|
|
# assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
|
|
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
|
|
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
|
|
},
|
|
],
|
|
"eventCount": 42, # Number of times the type of event occurred.
|
|
# Meaning depends on context (e.g. profile views, contacts, etc.).
|
|
},
|
|
"eventDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and # Date on which these events occurred.
|
|
# time zone are either specified elsewhere or are not significant. The date
|
|
# is relative to the Proleptic Gregorian Calendar. The day may be 0 to
|
|
# represent a year and month where the day is not significant, e.g. credit card
|
|
# expiration date. The year may be 0 to represent a month and day independent
|
|
# of year, e.g. anniversary date. Related types are google.type.TimeOfDay
|
|
# and `google.protobuf.Timestamp`.
|
|
"month": 42, # Month of year. Must be from 1 to 12.
|
|
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
|
|
# if specifying a year/month where the day is not significant.
|
|
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
|
|
# a year.
|
|
},
|
|
"profileViews": { # Details of the analytics events for a `Company` within a single day. # Instances of users viewing the `Company` profile
|
|
# on the specified date.
|
|
"eventLocations": [ # Location information of where these events occurred.
|
|
{ # An object representing a latitude/longitude pair. This is expressed as a pair
|
|
# of doubles representing degrees latitude and degrees longitude. Unless
|
|
# specified otherwise, this must conform to the
|
|
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
|
|
# standard</a>. Values must be within normalized ranges.
|
|
#
|
|
# Example of normalization code in Python:
|
|
#
|
|
# def NormalizeLongitude(longitude):
|
|
# """Wraps decimal degrees longitude to [-180.0, 180.0]."""
|
|
# q, r = divmod(longitude, 360.0)
|
|
# if r > 180.0 or (r == 180.0 and q <= -1.0):
|
|
# return r - 360.0
|
|
# return r
|
|
#
|
|
# def NormalizeLatLng(latitude, longitude):
|
|
# """Wraps decimal degrees latitude and longitude to
|
|
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
|
|
# r = latitude % 360.0
|
|
# if r <= 90.0:
|
|
# return r, NormalizeLongitude(longitude)
|
|
# elif r >= 270.0:
|
|
# return r - 360, NormalizeLongitude(longitude)
|
|
# else:
|
|
# return 180 - r, NormalizeLongitude(longitude + 180.0)
|
|
#
|
|
# assert 180.0 == NormalizeLongitude(180.0)
|
|
# assert -180.0 == NormalizeLongitude(-180.0)
|
|
# assert -179.0 == NormalizeLongitude(181.0)
|
|
# assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
|
|
# assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
|
|
# assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
|
|
# assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
|
|
# assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
|
|
# assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
|
|
# assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
|
|
# assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
|
|
# assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
|
|
# assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
|
|
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
|
|
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
|
|
},
|
|
],
|
|
"eventCount": 42, # Number of times the type of event occurred.
|
|
# Meaning depends on context (e.g. profile views, contacts, etc.).
|
|
},
|
|
},
|
|
],
|
|
"responseMetadata": { # Common data that is in each API response. # Current response metadata.
|
|
"debugInfo": { # Debug information about this request. # Debug information about this request.
|
|
"serverTraceInfo": "A String", # Server-side debug stack trace.
|
|
"serviceUrl": "A String", # URL of the service that handled this request.
|
|
"serverInfo": "A String", # Info about the server that serviced this request.
|
|
},
|
|
},
|
|
"analyticsSummary": { # Analytics aggregated data for a `Company` for a given date range. # Aggregated information across the response's
|
|
# analytics.
|
|
"contactsCount": 42, # Aggregated number of times users contacted the `Company`
|
|
# for given date range.
|
|
"searchViewsCount": 42, # Aggregated number of times users saw the `Company`
|
|
# in Google Partners Search results for given date range.
|
|
"profileViewsCount": 42, # Aggregated number of profile views for the `Company` for given date range.
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
<pre>Retrieves the next page of results.
|
|
|
|
Args:
|
|
previous_request: The request for the previous page. (required)
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
Returns:
|
|
A request object that you can call 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
</body></html> |