get(accountId, webPropertyId, remarketingAudienceId)
-Gets remarketing audiences to which the user has access.
+Gets a remarketing audience to which the user has access.
insert(accountId, webPropertyId, body)
Creates a new remarketing audiences.
+Creates a new remarketing audience.
list(accountId, webPropertyId, max_results=None, type=None, start_index=None)
Lists remarketing audiences to which the user has access.
patch(accountId, webPropertyId, remarketingAudienceId, body)
Updates an existing remarketing audiences. This method supports patch semantics.
+Updates an existing remarketing audience. This method supports patch semantics.
update(accountId, webPropertyId, remarketingAudienceId, body)
Updates an existing remarketing audiences.
+Updates an existing remarketing audience.
Method Details
get(accountId, webPropertyId, remarketingAudienceId)
- Gets remarketing audiences to which the user has access. +Gets a remarketing audience to which the user has access. Args: - accountId: string, Account ID for the remarketing audience to retrieve. (required) - webPropertyId: string, Web property ID for the remarketing audience to retrieve. (required) - remarketingAudienceId: string, The ID to retrieve the Remarketing Audience for. (required) + accountId: string, The account ID of the remarketing audience to retrieve. (required) + webPropertyId: string, The web property ID of the remarketing audience to retrieve. (required) + remarketingAudienceId: string, The ID of the remarketing audience to retrieve. (required) Returns: An object of the form: @@ -132,7 +132,7 @@@@ -157,11 +157,11 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, "excludeConditions": { # Defines the conditions to exclude users from the audience. "segment": "A String", # The segment condition that will cause a user to be removed from an audience. @@ -149,7 +149,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, }, }Method Details
diff --git a/docs/dyn/plus_v1.comments.html b/docs/dyn/plus_v1.comments.html index e0e0e1b3e37..7565bdb949f 100644 --- a/docs/dyn/plus_v1.comments.html +++ b/docs/dyn/plus_v1.comments.html @@ -78,7 +78,7 @@insert(accountId, webPropertyId, body)-Creates a new remarketing audiences. +Creates a new remarketing audience. Args: - accountId: string, Account ID to create the remarketing audience for. (required) - webPropertyId: string, Web property ID to create the remarketing audience for. (required) + accountId: string, The account ID for which to create the remarketing audience. (required) + webPropertyId: string, Web property ID for which to create the remarketing audience. (required) body: object, The request body. (required) The object takes the form of: @@ -195,7 +195,7 @@@@ -279,8 +279,8 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, "excludeConditions": { # Defines the conditions to exclude users from the audience. "segment": "A String", # The segment condition that will cause a user to be removed from an audience. @@ -212,7 +212,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, }, } @@ -251,7 +251,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, "excludeConditions": { # Defines the conditions to exclude users from the audience. "segment": "A String", # The segment condition that will cause a user to be removed from an audience. @@ -268,7 +268,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, }, }Method Details
Lists remarketing audiences to which the user has access. Args: - accountId: string, Account ID for the remarketing audience to retrieve. (required) - webPropertyId: string, Web property ID for the remarketing audience to retrieve. (required) + accountId: string, The account ID of the remarketing audiences to retrieve. (required) + webPropertyId: string, The web property ID of the remarketing audiences to retrieve. (required) max_results: integer, The maximum number of remarketing audiences to include in this response. type: string, A parameter start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. @@ -322,7 +322,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, "excludeConditions": { # Defines the conditions to exclude users from the audience. "segment": "A String", # The segment condition that will cause a user to be removed from an audience. @@ -339,7 +339,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, }, }, @@ -354,12 +354,12 @@Method Details
@@ -382,17 +453,17 @@patch(accountId, webPropertyId, remarketingAudienceId, body)-Updates an existing remarketing audiences. This method supports patch semantics. +@@ -225,16 +260,16 @@Updates an existing remarketing audience. This method supports patch semantics. Args: - accountId: string, Account ID for the remarketing audience to update. (required) - webPropertyId: string, Web property ID for the remarketing audience to update. (required) - remarketingAudienceId: string, Remarketing audience ID of the remarketing audience to update. (required) + accountId: string, The account ID of the remarketing audience to update. (required) + webPropertyId: string, The web property ID of the remarketing audience to update. (required) + remarketingAudienceId: string, The ID of the remarketing audience to update. (required) body: object, The request body. (required) The object takes the form of: @@ -393,7 +393,7 @@@@ -474,12 +474,12 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, "excludeConditions": { # Defines the conditions to exclude users from the audience. "segment": "A String", # The segment condition that will cause a user to be removed from an audience. @@ -410,7 +410,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, }, } @@ -449,7 +449,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, "excludeConditions": { # Defines the conditions to exclude users from the audience. "segment": "A String", # The segment condition that will cause a user to be removed from an audience. @@ -466,7 +466,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, }, }Method Details
+ +update(accountId, webPropertyId, remarketingAudienceId, body)-Updates an existing remarketing audiences. ++Updates an existing remarketing audience. Args: - accountId: string, Account ID for the remarketing audience to update. (required) - webPropertyId: string, Web property ID for the remarketing audience to update. (required) - remarketingAudienceId: string, Remarketing audience ID of the remarketing audience to update. (required) + accountId: string, The account ID of the remarketing audience to update. (required) + webPropertyId: string, The web property ID of the remarketing audience to update. (required) + remarketingAudienceId: string, The ID of the remarketing audience to update. (required) body: object, The request body. (required) The object takes the form of: @@ -513,7 +513,7 @@diff --git a/docs/dyn/analytics_v3.provisioning.html b/docs/dyn/analytics_v3.provisioning.html index 542940d3895..261154aea36 100644 --- a/docs/dyn/analytics_v3.provisioning.html +++ b/docs/dyn/analytics_v3.provisioning.html @@ -89,7 +89,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, "excludeConditions": { # Defines the conditions to exclude users from the audience. "segment": "A String", # The segment condition that will cause a user to be removed from an audience. @@ -530,7 +530,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, }, } @@ -569,7 +569,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, "excludeConditions": { # Defines the conditions to exclude users from the audience. "segment": "A String", # The segment condition that will cause a user to be removed from an audience. @@ -586,7 +586,7 @@Method Details
"segment": "A String", # The segment condition that will cause a user to be added to an audience. "kind": "analytics#includeConditions", # Resource type for include conditions. "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience. }, }, }Method Details
{ # JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile. "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account. "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: - # ARS, AUD, BGN, BRL, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, HUF, IDR, INR, JPY, KRW, LTL, MXN, NOK, NZD, PHP, PLN, RUB, SEK, THB, TRY, TWD, USD, VND, ZAR + # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. @@ -185,7 +185,7 @@Method Details
{ # JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile. "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account. "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: - # ARS, AUD, BGN, BRL, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, HUF, IDR, INR, JPY, KRW, LTL, MXN, NOK, NZD, PHP, PLN, RUB, SEK, THB, TRY, TWD, USD, VND, ZAR + # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. diff --git a/docs/dyn/appengine_v1.apps.html b/docs/dyn/appengine_v1.apps.html index 7c765b0d95e..91638370d4a 100644 --- a/docs/dyn/appengine_v1.apps.html +++ b/docs/dyn/appengine_v1.apps.html @@ -92,6 +92,9 @@Instance Methods
Gets information about an application.
++
+patch(appsId, body, updateMask=None, x__xgafv=None)Updates application parameters.
repair(appsId, body, x__xgafv=None)Recreates the required App Engine features for the application in your project, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example "*Error retrieving the App Engine service account*".
@@ -108,6 +111,34 @@Method Details
An object of the form: { # An Application resource contains the top-level configuration of an App Engine application. + "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine. @OutputOnly + "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly + "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly + "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content. @OutputOnly + "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. @OutputOnly + { # Rules to match an HTTP request and dispatch that request to a service. + "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters. + "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`". + "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: `default`. + }, + ], + "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly + "locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US + "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account. + "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`. + }+diff --git a/docs/dyn/appengine_v1.apps.locations.html b/docs/dyn/appengine_v1.apps.locations.html index 47de30fc758..50a71c6ee9f 100644 --- a/docs/dyn/appengine_v1.apps.locations.html +++ b/docs/dyn/appengine_v1.apps.locations.html @@ -100,7 +100,7 @@patch(appsId, body, updateMask=None, x__xgafv=None)+Updates application parameters. + +Args: + appsId: string, Part of `name`. Name of the application to update. Example: `apps/myapp`. (required) + body: object, The request body. (required) + The object takes the form of: + +{ # An Application resource contains the top-level configuration of an App Engine application. "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine. @OutputOnly "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly @@ -123,6 +154,32 @@Method Details
"locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account. "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`. + } + + updateMask: string, Standard field mask for the set of fields to be updated. + x__xgafv: string, V1 error format. + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure. + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + }, + "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available. + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, }Method Details
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} "a_key": "A String", }, - "locationId": "A String", # The cononical id for this location. For example: `"us-east1"`. + "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` "metadata": { # Service-specific metadata. For example the available capacity at the given location. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -129,7 +129,7 @@Method Details
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} "a_key": "A String", }, - "locationId": "A String", # The cononical id for this location. For example: `"us-east1"`. + "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` "metadata": { # Service-specific metadata. For example the available capacity at the given location. "a_key": "", # Properties of the object. Contains field @type with type URL. diff --git a/docs/dyn/appengine_v1.apps.services.versions.html b/docs/dyn/appengine_v1.apps.services.versions.html index 7baac611b5e..00db1c35d83 100644 --- a/docs/dyn/appengine_v1.apps.services.versions.html +++ b/docs/dyn/appengine_v1.apps.services.versions.html @@ -209,7 +209,7 @@Method Details
"container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment. "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" }, - "zip": { # The zip file for this deployment, if this is a zip deployment. + "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'. }, @@ -429,7 +429,7 @@Method Details
"container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment. "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" }, - "zip": { # The zip file for this deployment, if this is a zip deployment. + "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'. }, @@ -594,7 +594,7 @@Method Details
"container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment. "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" }, - "zip": { # The zip file for this deployment, if this is a zip deployment. + "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'. }, @@ -768,7 +768,7 @@Method Details
"container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment. "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" }, - "zip": { # The zip file for this deployment, if this is a zip deployment. + "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'. }, diff --git a/docs/dyn/appengine_v1.experimental.apps.html b/docs/dyn/appengine_v1.experimental.apps.html new file mode 100644 index 00000000000..fa26ce240bf --- /dev/null +++ b/docs/dyn/appengine_v1.experimental.apps.html @@ -0,0 +1,82 @@ + + + +Google App Engine Admin API . experimental . apps
+Instance Methods
++
+operations()+Returns the operations Resource.
+ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1.experimental.apps.operations.html b/docs/dyn/appengine_v1.experimental.apps.operations.html new file mode 100644 index 00000000000..f9aae20fd22 --- /dev/null +++ b/docs/dyn/appengine_v1.experimental.apps.operations.html @@ -0,0 +1,174 @@ + + + +Google App Engine Admin API . experimental . apps . operations
+Instance Methods
++
+get(appsId, operationsId, x__xgafv=None)Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
++
+list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.
++
+list_next(previous_request, previous_response)Retrieves the next page of results.
+Method Details
+++ +get(appsId, operationsId, x__xgafv=None)+Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + +Args: + appsId: string, Part of `name`. The name of the operation resource. (required) + operationsId: string, Part of `name`. See documentation of `appsId`. (required) + x__xgafv: string, V1 error format. + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure. + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + }, + "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available. + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + }+++ +list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. + +Args: + appsId: string, Part of `name`. The name of the operation collection. (required) + pageSize: integer, The standard list page size. + filter: string, The standard list filter. + pageToken: string, The standard list page token. + x__xgafv: string, V1 error format. + +Returns: + An object of the form: + + { # The response message for Operations.ListOperations. + "operations": [ # A list of operations that matches the specified filter in the request. + { # This resource represents a long-running operation that is the result of a network API call. + "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure. + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + }, + "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available. + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + }, + ], + "nextPageToken": "A String", # The standard List next-page token. + }+++ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1.experimental.html b/docs/dyn/appengine_v1.experimental.html new file mode 100644 index 00000000000..2f06e1e6db5 --- /dev/null +++ b/docs/dyn/appengine_v1.experimental.html @@ -0,0 +1,82 @@ + + + +list_next(previous_request, previous_response)+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. ++Google App Engine Admin API . experimental
+Instance Methods
++
+apps()+Returns the apps Resource.
+ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1.html b/docs/dyn/appengine_v1.html index effe6f76734..14a727122c3 100644 --- a/docs/dyn/appengine_v1.html +++ b/docs/dyn/appengine_v1.html @@ -79,6 +79,11 @@Instance Methods
Returns the apps Resource.
++
+experimental()+Returns the experimental Resource.
+Create a BatchHttpRequest object based on the discovery document.
diff --git a/docs/dyn/identitytoolkit_v3.relyingparty.html b/docs/dyn/identitytoolkit_v3.relyingparty.html index 6a678a64474..2d514abba7e 100644 --- a/docs/dyn/identitytoolkit_v3.relyingparty.html +++ b/docs/dyn/identitytoolkit_v3.relyingparty.html @@ -147,7 +147,7 @@Method Details
"context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback. "appId": "A String", # The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS. "continueUri": "A String", # The URI to which the IDP redirects the user after the federated login flow. - "customParameter": { # The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state. + "customParameter": { # The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state, oauth_token. "a_key": "A String", # The customized query parameter. }, "identifier": "A String", # The email or federated ID of the user. @@ -699,6 +699,7 @@Method Details
"signerKey": "A String", # The key for to hash the password. "memoryCost": 42, # Memory cost for hash calculation. Used by scrypt similar algorithms. "saltSeparator": "A String", # The salt separator. + "targetProjectId": "A String", # Specify which project (field value is actually project id) to operate. Only used when provided credential. "rounds": 42, # Rounds for hash calculation. Used by scrypt and similar algorithms. } diff --git a/docs/dyn/ml_v1beta1.projects.jobs.html b/docs/dyn/ml_v1beta1.projects.jobs.html index 427080ec50c..3882bfda997 100644 --- a/docs/dyn/ml_v1beta1.projects.jobs.html +++ b/docs/dyn/ml_v1beta1.projects.jobs.html @@ -168,20 +168,20 @@Method Details
"modelName": "A String", # Use this field if you want to use the default version for the specified # model. The string must use the following format: # - # `"project/[YOUR_PROJECT]/models/[YOUR_MODEL]"` + # `"projects/[YOUR_PROJECT]/models/[YOUR_MODEL]"` "inputPaths": [ # Required. The Google Cloud Storage location of the input data files. # May contain wildcards. "A String", ], - "maxWorkerCount": "A String", # Optional. The maximum amount of workers to be used for parallel processing. - # Defaults to 10. + "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing. + # Defaults to 10 if not specified. "outputPath": "A String", # Required. The output Google Cloud Storage location. "dataFormat": "A String", # Required. The format of the input data files. "versionName": "A String", # Use this field if you want to specify a version of the model to use. The # string is formatted the same way as `model_version`, with the addition # of the version information: # - # `"project/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"` + # `"projects/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"` "region": "A String", # Required. The Google Compute Engine region to run the prediction job in. }, "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job. @@ -357,20 +357,20 @@Method Details
"modelName": "A String", # Use this field if you want to use the default version for the specified # model. The string must use the following format: # - # `"project/[YOUR_PROJECT]/models/[YOUR_MODEL]"` + # `"projects/[YOUR_PROJECT]/models/[YOUR_MODEL]"` "inputPaths": [ # Required. The Google Cloud Storage location of the input data files. # May contain wildcards. "A String", ], - "maxWorkerCount": "A String", # Optional. The maximum amount of workers to be used for parallel processing. - # Defaults to 10. + "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing. + # Defaults to 10 if not specified. "outputPath": "A String", # Required. The output Google Cloud Storage location. "dataFormat": "A String", # Required. The format of the input data files. "versionName": "A String", # Use this field if you want to specify a version of the model to use. The # string is formatted the same way as `model_version`, with the addition # of the version information: # - # `"project/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"` + # `"projects/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"` "region": "A String", # Required. The Google Compute Engine region to run the prediction job in. }, "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job. @@ -555,20 +555,20 @@Method Details
"modelName": "A String", # Use this field if you want to use the default version for the specified # model. The string must use the following format: # - # `"project/[YOUR_PROJECT]/models/[YOUR_MODEL]"` + # `"projects/[YOUR_PROJECT]/models/[YOUR_MODEL]"` "inputPaths": [ # Required. The Google Cloud Storage location of the input data files. # May contain wildcards. "A String", ], - "maxWorkerCount": "A String", # Optional. The maximum amount of workers to be used for parallel processing. - # Defaults to 10. + "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing. + # Defaults to 10 if not specified. "outputPath": "A String", # Required. The output Google Cloud Storage location. "dataFormat": "A String", # Required. The format of the input data files. "versionName": "A String", # Use this field if you want to specify a version of the model to use. The # string is formatted the same way as `model_version`, with the addition # of the version information: # - # `"project/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"` + # `"projects/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"` "region": "A String", # Required. The Google Compute Engine region to run the prediction job in. }, "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job. @@ -767,20 +767,20 @@Method Details
"modelName": "A String", # Use this field if you want to use the default version for the specified # model. The string must use the following format: # - # `"project/[YOUR_PROJECT]/models/[YOUR_MODEL]"` + # `"projects/[YOUR_PROJECT]/models/[YOUR_MODEL]"` "inputPaths": [ # Required. The Google Cloud Storage location of the input data files. # May contain wildcards. "A String", ], - "maxWorkerCount": "A String", # Optional. The maximum amount of workers to be used for parallel processing. - # Defaults to 10. + "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing. + # Defaults to 10 if not specified. "outputPath": "A String", # Required. The output Google Cloud Storage location. "dataFormat": "A String", # Required. The format of the input data files. "versionName": "A String", # Use this field if you want to specify a version of the model to use. The # string is formatted the same way as `model_version`, with the addition # of the version information: # - # `"project/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"` + # `"projects/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"` "region": "A String", # Required. The Google Compute Engine region to run the prediction job in. }, "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job. diff --git a/docs/dyn/ml_v1beta1.projects.models.html b/docs/dyn/ml_v1beta1.projects.models.html index 088032f3108..015558a6c0e 100644 --- a/docs/dyn/ml_v1beta1.projects.models.html +++ b/docs/dyn/ml_v1beta1.projects.models.html @@ -249,7 +249,7 @@Method Details
"name": "A String", # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the # `name` should have the format of `operations/some/unique/name`. - "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure. + "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # diff --git a/docs/dyn/ml_v1beta1.projects.models.versions.html b/docs/dyn/ml_v1beta1.projects.models.versions.html index a28a565a51b..36243288ef9 100644 --- a/docs/dyn/ml_v1beta1.projects.models.versions.html +++ b/docs/dyn/ml_v1beta1.projects.models.versions.html @@ -172,7 +172,7 @@Method Details
"name": "A String", # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the # `name` should have the format of `operations/some/unique/name`. - "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure. + "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # @@ -286,7 +286,7 @@Method Details
"name": "A String", # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the # `name` should have the format of `operations/some/unique/name`. - "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure. + "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # diff --git a/docs/dyn/ml_v1beta1.projects.operations.html b/docs/dyn/ml_v1beta1.projects.operations.html index 5c094a68196..3f1d5f7df90 100644 --- a/docs/dyn/ml_v1beta1.projects.operations.html +++ b/docs/dyn/ml_v1beta1.projects.operations.html @@ -98,7 +98,10 @@Method Details
`google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the -operation completed despite cancellation. +operation completed despite cancellation. On successful cancellation, +the operation is not deleted; instead, it becomes an operation with +an Operation.error value with a google.rpc.Status.code of 1, +corresponding to `Code.CANCELLED`. Args: name: string, The name of the operation resource to be cancelled. (required) @@ -191,7 +194,7 @@Method Details
"name": "A String", # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the # `name` should have the format of `operations/some/unique/name`. - "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure. + "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # @@ -305,7 +308,7 @@Method Details
"name": "A String", # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the # `name` should have the format of `operations/some/unique/name`. - "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure. + "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # diff --git a/docs/dyn/plus_v1.activities.html b/docs/dyn/plus_v1.activities.html index d52a12b2666..386d1c6110f 100644 --- a/docs/dyn/plus_v1.activities.html +++ b/docs/dyn/plus_v1.activities.html @@ -109,6 +109,7 @@Method Details
}, "title": "A String", # Title of this activity. "url": "A String", # The link to this activity. + "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. "object": { # The object of this activity. "resharers": { # People who reshared this activity. "totalItems": 42, # Total number of people who reshared this activity. @@ -116,75 +117,97 @@Method Details
}, "attachments": [ # The media objects attached to this activity. { - "displayName": "A String", # The title of the attachment (such as a photo caption or an article title). - "contentsource": { # If the attachment is audio, the link to the content. - "url": "A String", # URL of the link. - "type": "A String", # Media type of the link. - }, - "fullImage": { # The full image url for photo attachments. - "url": "A String", # URL of the link. + "displayName": "A String", # The title of the attachment, such as a photo caption or an article title. + "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album. + { + "url": "A String", # URL of the webpage containing the image. + "image": { # Image resource. + "url": "A String", # Image url. + "width": 42, # The width, in pixels, of the linked resource. + "type": "A String", # Media type of the link. + "height": 42, # The height, in pixels, of the linked resource. + }, + "description": "A String", # Potential name of the thumbnail. + }, + ], + "fullImage": { # The full image URL for photo attachments. + "url": "A String", # URL of the image. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "url": "A String", # The link to the attachment, should be of type text/html. + "url": "A String", # The link to the attachment, which should be of type text/html. "image": { # The preview image for photos or videos. - "url": "A String", # URL of the link. + "url": "A String", # Image URL. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. + "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types. "embed": { # If the attachment is a video, the embeddable link. "url": "A String", # URL of the link. "type": "A String", # Media type of the link. }, - "id": "A String", # The ID of the media object's resource. - "categories": [ # Specifies zero or more categories the attachment belongs to. - { - "term": "A String", # The tag, e.g. album. - "schema": "A String", # Domain of schema, e.g. http://google.com. - "label": "A String", # The category label, suitable for display (e.g. "album cover"). - }, - ], - "objectType": "A String", # The type of media object. Possible values are: + "id": "A String", # The ID of the attachment. + "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values: # - "photo" - A photo. + # - "album" - A photo album. # - "video" - A video. # - "article" - An article, specified by a link. }, ], - "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits. + "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request. "plusoners": { # People who +1'd this activity. "totalItems": 42, # Total number of people who +1'd this activity. "selfLink": "A String", # The URL for the collection of people who +1'd this activity. }, - "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor. + "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor. + "displayName": "A String", # The original actor's name, which is suitable for display. "url": "A String", # A link to the original actor's Google profile. "image": { # The image representation of the original actor. "url": "A String", # A URL that points to a thumbnail photo of the original actor. }, - "displayName": "A String", # The original actor's name, suitable for display. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, "id": "A String", # ID of the original actor. }, - "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property. + "content": "A String", # The HTML-formatted content, which is suitable for display. "url": "A String", # The URL that points to the linked resource. "replies": { # Comments in reply to this activity. "totalItems": 42, # Total number of comments on this activity. "selfLink": "A String", # The URL for the collection of comments in reply to this activity. }, - "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared. - "objectType": "A String", # The type of the object. Possible values are: + "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared. + "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values: # - "note" - Textual content. # - "activity" - A Google+ activity. }, "placeId": "A String", # ID of the place where this activity occurred. "actor": { # The person who performed this activity. + "displayName": "A String", # The name of the actor, suitable for display. + "name": { # An object representation of the individual components of name. + "givenName": "A String", # The given name ("first name") of the actor. + "familyName": "A String", # The family name ("last name") of the actor. + }, "url": "A String", # The link to the actor's Google profile. "image": { # The image representation of the actor. - "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, - "displayName": "A String", # The name of the actor, suitable for display. - "id": "A String", # The ID of the actor's person resource. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, + "id": "A String", # The ID of the actor's Person resource. }, "id": "A String", # The ID of this activity. "access": { # Identifies who has access to see this activity. @@ -194,23 +217,35 @@Method Details
# - "person" - Access to an individual. # - "circle" - Access to members of a circle. # - "myCircles" - Access to members of all the person's circles. - # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles. + # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. + # - "domain" - Access to members of the person's Google Apps domain. # - "public" - Access to anyone on the web. + "displayName": "A String", # A descriptive name for this entry. Suitable for display. "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. }, ], "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl". "description": "A String", # Description of the access granted, suitable for display. }, - "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are: + "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: # - "post" - Publish content to the stream. - # - "checkin" - Check in to a location. # - "share" - Reshare an activity. - "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. + "etag": "A String", # ETag of this response for caching purposes. "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. + "location": { # The location where this activity occurred. + "position": { # The position of the place. + "latitude": 3.14, # The latitude of this position. + "longitude": 3.14, # The longitude of this position. + }, + "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place". + "displayName": "A String", # The display name of the place. + "id": "A String", # The id of the place. + "address": { # The physical address of the place. + "formatted": "A String", # The formatted address for display. + }, + }, "address": "A String", # Street address where this activity occurred. "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity. - "placeholder": True or False, # True if this activity is a placeholder. "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity. "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. }Method Details
collection: string, The collection of activities to list. (required) Allowed values public - All public activities created by the specified user. - pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. - maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults. + pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. + maxResults: integer, The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. Returns: An object of the form: { - "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. + "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed". - "title": "A String", # The title of this collection of activities. + "title": "A String", # The title of this collection of activities, which is a truncated portion of the content. "items": [ # The activities in this page of results. { "placeName": "A String", # Name of the place where this activity occurred. @@ -245,6 +280,7 @@Method Details
}, "title": "A String", # Title of this activity. "url": "A String", # The link to this activity. + "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. "object": { # The object of this activity. "resharers": { # People who reshared this activity. "totalItems": 42, # Total number of people who reshared this activity. @@ -252,75 +288,97 @@Method Details
}, "attachments": [ # The media objects attached to this activity. { - "displayName": "A String", # The title of the attachment (such as a photo caption or an article title). - "contentsource": { # If the attachment is audio, the link to the content. - "url": "A String", # URL of the link. - "type": "A String", # Media type of the link. - }, - "fullImage": { # The full image url for photo attachments. - "url": "A String", # URL of the link. + "displayName": "A String", # The title of the attachment, such as a photo caption or an article title. + "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album. + { + "url": "A String", # URL of the webpage containing the image. + "image": { # Image resource. + "url": "A String", # Image url. + "width": 42, # The width, in pixels, of the linked resource. + "type": "A String", # Media type of the link. + "height": 42, # The height, in pixels, of the linked resource. + }, + "description": "A String", # Potential name of the thumbnail. + }, + ], + "fullImage": { # The full image URL for photo attachments. + "url": "A String", # URL of the image. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "url": "A String", # The link to the attachment, should be of type text/html. + "url": "A String", # The link to the attachment, which should be of type text/html. "image": { # The preview image for photos or videos. - "url": "A String", # URL of the link. + "url": "A String", # Image URL. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. + "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types. "embed": { # If the attachment is a video, the embeddable link. "url": "A String", # URL of the link. "type": "A String", # Media type of the link. }, - "id": "A String", # The ID of the media object's resource. - "categories": [ # Specifies zero or more categories the attachment belongs to. - { - "term": "A String", # The tag, e.g. album. - "schema": "A String", # Domain of schema, e.g. http://google.com. - "label": "A String", # The category label, suitable for display (e.g. "album cover"). - }, - ], - "objectType": "A String", # The type of media object. Possible values are: + "id": "A String", # The ID of the attachment. + "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values: # - "photo" - A photo. + # - "album" - A photo album. # - "video" - A video. # - "article" - An article, specified by a link. }, ], - "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits. + "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request. "plusoners": { # People who +1'd this activity. "totalItems": 42, # Total number of people who +1'd this activity. "selfLink": "A String", # The URL for the collection of people who +1'd this activity. }, - "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor. + "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor. + "displayName": "A String", # The original actor's name, which is suitable for display. "url": "A String", # A link to the original actor's Google profile. "image": { # The image representation of the original actor. "url": "A String", # A URL that points to a thumbnail photo of the original actor. }, - "displayName": "A String", # The original actor's name, suitable for display. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, "id": "A String", # ID of the original actor. }, - "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property. + "content": "A String", # The HTML-formatted content, which is suitable for display. "url": "A String", # The URL that points to the linked resource. "replies": { # Comments in reply to this activity. "totalItems": 42, # Total number of comments on this activity. "selfLink": "A String", # The URL for the collection of comments in reply to this activity. }, - "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared. - "objectType": "A String", # The type of the object. Possible values are: + "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared. + "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values: # - "note" - Textual content. # - "activity" - A Google+ activity. }, "placeId": "A String", # ID of the place where this activity occurred. "actor": { # The person who performed this activity. + "displayName": "A String", # The name of the actor, suitable for display. + "name": { # An object representation of the individual components of name. + "givenName": "A String", # The given name ("first name") of the actor. + "familyName": "A String", # The family name ("last name") of the actor. + }, "url": "A String", # The link to the actor's Google profile. "image": { # The image representation of the actor. - "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, - "displayName": "A String", # The name of the actor, suitable for display. - "id": "A String", # The ID of the actor's person resource. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, + "id": "A String", # The ID of the actor's Person resource. }, "id": "A String", # The ID of this activity. "access": { # Identifies who has access to see this activity. @@ -330,30 +388,43 @@Method Details
# - "person" - Access to an individual. # - "circle" - Access to members of a circle. # - "myCircles" - Access to members of all the person's circles. - # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles. + # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. + # - "domain" - Access to members of the person's Google Apps domain. # - "public" - Access to anyone on the web. + "displayName": "A String", # A descriptive name for this entry. Suitable for display. "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. }, ], "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl". "description": "A String", # Description of the access granted, suitable for display. }, - "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are: + "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: # - "post" - Publish content to the stream. - # - "checkin" - Check in to a location. # - "share" - Reshare an activity. - "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. + "etag": "A String", # ETag of this response for caching purposes. "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. + "location": { # The location where this activity occurred. + "position": { # The position of the place. + "latitude": 3.14, # The latitude of this position. + "longitude": 3.14, # The longitude of this position. + }, + "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place". + "displayName": "A String", # The display name of the place. + "id": "A String", # The id of the place. + "address": { # The physical address of the place. + "formatted": "A String", # The formatted address for display. + }, + }, "address": "A String", # Street address where this activity occurred. "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity. - "placeholder": True or False, # True if this activity is a placeholder. "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity. "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. }, ], "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp. "nextLink": "A String", # Link to the next page of activities. - "id": "A String", # The ID of this collection of activities. + "etag": "A String", # ETag of this response for caching purposes. + "id": "A String", # The ID of this collection of activities. Deprecated. "selfLink": "A String", # Link to this activity resource. }Method Details
Allowed values best - Sort activities by relevance to the user, most relevant first. recent - Sort activities by published date, most recent first. - language: string, Specify the preferred language to search with. See Language Codes for available values. - pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length. - maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults. + language: string, Specify the preferred language to search with. See search language codes for available values. + pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length. + maxResults: integer, The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. Returns: An object of the form: { - "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. + "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed". - "title": "A String", # The title of this collection of activities. + "title": "A String", # The title of this collection of activities, which is a truncated portion of the content. "items": [ # The activities in this page of results. { "placeName": "A String", # Name of the place where this activity occurred. @@ -403,6 +474,7 @@Method Details
}, "title": "A String", # Title of this activity. "url": "A String", # The link to this activity. + "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. "object": { # The object of this activity. "resharers": { # People who reshared this activity. "totalItems": 42, # Total number of people who reshared this activity. @@ -410,75 +482,97 @@Method Details
}, "attachments": [ # The media objects attached to this activity. { - "displayName": "A String", # The title of the attachment (such as a photo caption or an article title). - "contentsource": { # If the attachment is audio, the link to the content. - "url": "A String", # URL of the link. - "type": "A String", # Media type of the link. - }, - "fullImage": { # The full image url for photo attachments. - "url": "A String", # URL of the link. + "displayName": "A String", # The title of the attachment, such as a photo caption or an article title. + "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album. + { + "url": "A String", # URL of the webpage containing the image. + "image": { # Image resource. + "url": "A String", # Image url. + "width": 42, # The width, in pixels, of the linked resource. + "type": "A String", # Media type of the link. + "height": 42, # The height, in pixels, of the linked resource. + }, + "description": "A String", # Potential name of the thumbnail. + }, + ], + "fullImage": { # The full image URL for photo attachments. + "url": "A String", # URL of the image. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "url": "A String", # The link to the attachment, should be of type text/html. + "url": "A String", # The link to the attachment, which should be of type text/html. "image": { # The preview image for photos or videos. - "url": "A String", # URL of the link. + "url": "A String", # Image URL. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. + "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types. "embed": { # If the attachment is a video, the embeddable link. "url": "A String", # URL of the link. "type": "A String", # Media type of the link. }, - "id": "A String", # The ID of the media object's resource. - "categories": [ # Specifies zero or more categories the attachment belongs to. - { - "term": "A String", # The tag, e.g. album. - "schema": "A String", # Domain of schema, e.g. http://google.com. - "label": "A String", # The category label, suitable for display (e.g. "album cover"). - }, - ], - "objectType": "A String", # The type of media object. Possible values are: + "id": "A String", # The ID of the attachment. + "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values: # - "photo" - A photo. + # - "album" - A photo album. # - "video" - A video. # - "article" - An article, specified by a link. }, ], - "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits. + "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request. "plusoners": { # People who +1'd this activity. "totalItems": 42, # Total number of people who +1'd this activity. "selfLink": "A String", # The URL for the collection of people who +1'd this activity. }, - "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor. + "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor. + "displayName": "A String", # The original actor's name, which is suitable for display. "url": "A String", # A link to the original actor's Google profile. "image": { # The image representation of the original actor. "url": "A String", # A URL that points to a thumbnail photo of the original actor. }, - "displayName": "A String", # The original actor's name, suitable for display. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, "id": "A String", # ID of the original actor. }, - "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property. + "content": "A String", # The HTML-formatted content, which is suitable for display. "url": "A String", # The URL that points to the linked resource. "replies": { # Comments in reply to this activity. "totalItems": 42, # Total number of comments on this activity. "selfLink": "A String", # The URL for the collection of comments in reply to this activity. }, - "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared. - "objectType": "A String", # The type of the object. Possible values are: + "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared. + "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values: # - "note" - Textual content. # - "activity" - A Google+ activity. }, "placeId": "A String", # ID of the place where this activity occurred. "actor": { # The person who performed this activity. + "displayName": "A String", # The name of the actor, suitable for display. + "name": { # An object representation of the individual components of name. + "givenName": "A String", # The given name ("first name") of the actor. + "familyName": "A String", # The family name ("last name") of the actor. + }, "url": "A String", # The link to the actor's Google profile. "image": { # The image representation of the actor. - "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, - "displayName": "A String", # The name of the actor, suitable for display. - "id": "A String", # The ID of the actor's person resource. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, + "id": "A String", # The ID of the actor's Person resource. }, "id": "A String", # The ID of this activity. "access": { # Identifies who has access to see this activity. @@ -488,30 +582,43 @@Method Details
# - "person" - Access to an individual. # - "circle" - Access to members of a circle. # - "myCircles" - Access to members of all the person's circles. - # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles. + # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. + # - "domain" - Access to members of the person's Google Apps domain. # - "public" - Access to anyone on the web. + "displayName": "A String", # A descriptive name for this entry. Suitable for display. "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. }, ], "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl". "description": "A String", # Description of the access granted, suitable for display. }, - "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are: + "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: # - "post" - Publish content to the stream. - # - "checkin" - Check in to a location. # - "share" - Reshare an activity. - "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. + "etag": "A String", # ETag of this response for caching purposes. "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. + "location": { # The location where this activity occurred. + "position": { # The position of the place. + "latitude": 3.14, # The latitude of this position. + "longitude": 3.14, # The longitude of this position. + }, + "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place". + "displayName": "A String", # The display name of the place. + "id": "A String", # The id of the place. + "address": { # The physical address of the place. + "formatted": "A String", # The formatted address for display. + }, + }, "address": "A String", # Street address where this activity occurred. "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity. - "placeholder": True or False, # True if this activity is a placeholder. "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity. "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. }, ], "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp. "nextLink": "A String", # Link to the next page of activities. - "id": "A String", # The ID of this collection of activities. + "etag": "A String", # ETag of this response for caching purposes. + "id": "A String", # The ID of this collection of activities. Deprecated. "selfLink": "A String", # Link to this activity resource. }Instance Methods
get(commentId)Get a comment.
-
+list(activityId, pageToken=None, maxResults=None)list(activityId, pageToken=None, maxResults=None, sortOrder=None)List all of the comments for an activity.
@@ -97,27 +97,40 @@
list_next(previous_request, previous_response)Method Details
{ "inReplyTo": [ # The activity this comment replied to. { - "url": "A String", # The url of the activity. - "id": "A String", # The id of the activity. + "url": "A String", # The URL of the activity. + "id": "A String", # The ID of the activity. }, ], "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment". + "plusoners": { # People who +1'd this comment. + "totalItems": 42, # Total number of people who +1'd this comment. + }, "object": { # The object of this comment. - "content": "A String", # The content of this comment. + "content": "A String", # The HTML-formatted content, suitable for display. + "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request. "objectType": "comment", # The object type of this comment. Possible values are: # - "comment" - A comment in reply to an activity. }, "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. "actor": { # The person who posted this comment. - "url": "A String", # A link to the person resource for this actor. + "displayName": "A String", # The name of this actor, suitable for display. + "url": "A String", # A link to the Person resource for this actor. "image": { # The image representation of this actor. - "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + }, + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. }, - "displayName": "A String", # The name of this actor, suitable for display. "id": "A String", # The ID of the actor. }, "verb": "post", # This comment's verb, indicating what action was performed. Possible values are: # - "post" - Publish content to the stream. + "etag": "A String", # ETag of this response for caching purposes. "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp. "id": "A String", # The ID of this comment. "selfLink": "A String", # Link to this comment resource. @@ -125,46 +138,63 @@Method Details
-
diff --git a/docs/dyn/plus_v1.people.html b/docs/dyn/plus_v1.people.html
index 9e4638eafd4..e23259ec84a 100644
--- a/docs/dyn/plus_v1.people.html
+++ b/docs/dyn/plus_v1.people.html
@@ -76,13 +76,19 @@ list(activityId, pageToken=None, maxResults=None)
+ list(activityId, pageToken=None, maxResults=None, sortOrder=None)
List all of the comments for an activity.
Args:
activityId: string, The ID of the activity to get comments for. (required)
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of comments to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
+ pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
+ sortOrder: string, The order in which to sort the list of comments.
+ Allowed values
+ ascending - Sort oldest comments first.
+ descending - Sort newest comments first.
Returns:
An object of the form:
{
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
"kind": "plus#commentFeed", # Identifies this resource as a collection of comments. Value: "plus#commentFeed".
"title": "A String", # The title of this collection of comments.
"items": [ # The comments in this page of results.
{
"inReplyTo": [ # The activity this comment replied to.
{
- "url": "A String", # The url of the activity.
- "id": "A String", # The id of the activity.
+ "url": "A String", # The URL of the activity.
+ "id": "A String", # The ID of the activity.
},
],
"kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
+ "plusoners": { # People who +1'd this comment.
+ "totalItems": 42, # Total number of people who +1'd this comment.
+ },
"object": { # The object of this comment.
- "content": "A String", # The content of this comment.
+ "content": "A String", # The HTML-formatted content, suitable for display.
+ "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
"objectType": "comment", # The object type of this comment. Possible values are:
# - "comment" - A comment in reply to an activity.
},
"updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
"actor": { # The person who posted this comment.
- "url": "A String", # A link to the person resource for this actor.
+ "displayName": "A String", # The name of this actor, suitable for display.
+ "url": "A String", # A link to the Person resource for this actor.
"image": { # The image representation of this actor.
- "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ },
+ "clientSpecificActorInfo": { # Actor info specific to particular clients.
+ "youtubeActorInfo": { # Actor info specific to YouTube clients.
+ "channelId": "A String", # ID of the YouTube channel owned by the Actor.
+ },
+ },
+ "verification": { # Verification status of actor.
+ "adHocVerified": "A String", # Verification for one-time or manual processes.
},
- "displayName": "A String", # The name of this actor, suitable for display.
"id": "A String", # The ID of the actor.
},
"verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
# - "post" - Publish content to the stream.
+ "etag": "A String", # ETag of this response for caching purposes.
"published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
"id": "A String", # The ID of this comment.
"selfLink": "A String", # Link to this comment resource.
@@ -172,6 +202,7 @@ Method Details
],
"updated": "A String", # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
"nextLink": "A String", # Link to the next page of activities.
+ "etag": "A String", # ETag of this response for caching purposes.
"id": "A String", # The ID of this collection of comments.
}
Google+ API . peopl
Instance Methods
-Get a person's profile.
+Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.
+
+ list(userId, collection, orderBy=None, pageToken=None, maxResults=None)
+List all of the people in the specified collection.
listByActivity(activityId, collection, pageToken=None, maxResults=None)
List all of the people in the specified collection for a particular activity.
listByActivity_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ list_next(previous_request, previous_response)
+Retrieves the next page of results.
search(query, pageToken=None, language=None, maxResults=None)
Search all public profiles.
@@ -92,7 +98,7 @@ Instance Methods
Method Details
get(userId)
- Get a person's profile.
+ Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.
Args:
userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required)
@@ -101,7 +107,23 @@ Method Details
An object of the form:
{
- "relationshipStatus": "A String", # The person's relationship status. Possible values are:
+ "braggingRights": "A String", # The "bragging rights" line of this person.
+ "image": { # The representation of the person's profile photo.
+ "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "isDefault": True or False, # Whether the person's profile photo is the default one
+ },
+ "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
+ "id": "A String", # The ID of this person.
+ "occupation": "A String", # The occupation of this person.
+ "verified": True or False, # Whether the person or Google+ Page has been verified.
+ "tagline": "A String", # The brief description (tagline) of this person.
+ "currentLocation": "A String", # (this field is not currently used)
+ "etag": "A String", # ETag of this response for caching purposes.
+ "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
+ "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
+ # - "person" - represents an actual person.
+ # - "page" - represents a page.
+ "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
# - "single" - Person is single.
# - "in_a_relationship" - Person is in a relationship.
# - "engaged" - Person is engaged.
@@ -111,23 +133,42 @@ Method Details
# - "widowed" - Person is widowed.
# - "in_domestic_partnership" - Person is in a domestic partnership.
# - "in_civil_union" - Person is in a civil union.
+ "aboutMe": "A String", # A short biography for this person.
+ "placesLived": [ # A list of places where this person has lived.
+ {
+ "primary": True or False, # If "true", this place of residence is this person's primary residence.
+ "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
+ },
+ ],
+ "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ "nickname": "A String", # The nickname of this person.
+ "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
+ {
+ "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
+ # - "account" - Google account email address.
+ # - "home" - Home email address.
+ # - "work" - Work email address.
+ # - "other" - Other.
+ "value": "A String", # The email address.
+ },
+ ],
"organizations": [ # A list of current or past organizations with which this person is associated.
{
- "startDate": "A String", # The date the person joined this organization.
- "endDate": "A String", # The date the person left this organization.
- "description": "A String", # A short description of the person's role in this organization.
+ "startDate": "A String", # The date that the person joined this organization.
+ "endDate": "A String", # The date that the person left this organization.
+ "description": "A String", # A short description of the person's role in this organization. Deprecated.
"title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
- "location": "A String", # The location of this organization.
- "department": "A String", # The department within the organization.
- "type": "A String", # The type of organization. Possible values are:
+ "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
+ "location": "A String", # The location of this organization. Deprecated.
+ "department": "A String", # The department within the organization. Deprecated.
+ "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
# - "work" - Work.
# - "school" - School.
"name": "A String", # The name of the organization.
},
],
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "displayName": "A String", # The name of this person, suitable for display.
+ "displayName": "A String", # The name of this person, which is suitable for display.
"name": { # An object representation of the individual components of a person's name.
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
"middleName": "A String", # The middle name of this person.
@@ -136,76 +177,93 @@ Method Details
"givenName": "A String", # The given name (first name) of this person.
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
},
- "url": "A String", # The URL of this person's profile.
- "gender": "A String", # The person's gender. Possible values are:
+ "language": "A String", # The user's preferred language for rendering.
+ "skills": "A String", # The person's skills.
+ "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
# - "male" - Male gender.
# - "female" - Female gender.
# - "other" - Other.
- "aboutMe": "A String", # A short biography for this person.
- "tagline": "A String", # The brief description (tagline) of this person.
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
+ "cover": { # The cover photo content.
+ "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
+ # - "banner" - One large image banner.
+ "coverInfo": { # Extra information about the cover photo.
+ "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
+ "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
},
- ],
- "emails": [ # A list of email addresses for this person.
- {
- "type": "A String", # The type of address. Possible values are:
- # - "home" - Home email address.
- # - "work" - Work email address.
- # - "other" - Other.
- "primary": True or False, # If "true", indicates this email address is the person's primary one.
- "value": "A String", # The email address.
+ "coverPhoto": { # The person's primary cover image.
+ "url": "A String", # The URL of the image.
+ "width": 42, # The width of the image.
+ "height": 42, # The height of the image.
},
- ],
- "nickname": "A String", # The nickname of this person.
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ },
+ "url": "A String", # The URL of this person's profile.
+ "isPlusUser": True or False, # Whether this user has signed up for Google+.
+ "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
"urls": [ # A list of URLs for this person.
{
- "type": "A String", # The type of URL. Possible values are:
- # - "home" - URL for home.
- # - "work" - URL for work.
- # - "blog" - URL for blog.
- # - "profile" - URL for profile.
- # - "other" - Other.
- "primary": True or False, # If "true", this URL is the person's primary URL.
+ "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
+ # - "otherProfile" - URL for another profile.
+ # - "contributor" - URL to a site for which this person is a contributor.
+ # - "website" - URL for this Google+ Page's primary website.
+ # - "other" - Other URL.
"value": "A String", # The URL value.
+ "label": "A String", # The label of the URL.
},
],
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
+ "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
+ # - "17" - for age 17
+ # - "20" - for age 20
+ "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
+ # - "21" - for age 21
+ # - "18" - for age 18
},
- "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
- "id": "A String", # The ID of this person.
- "languagesSpoken": [ # The languages spoken by this person.
- "A String",
- ],
- "currentLocation": "A String", # The current location for this person.
}
- listByActivity(activityId, collection, pageToken=None, maxResults=None)
- List all of the people in the specified collection for a particular activity.
+ list(userId, collection, orderBy=None, pageToken=None, maxResults=None)
+ List all of the people in the specified collection.
Args:
- activityId: string, The ID of the activity to get the list of people for. (required)
+ userId: string, Get the collection of people for the person identified. Use "me" to indicate the authenticated user. (required)
collection: string, The collection of people to list. (required)
Allowed values
- plusoners - List all people who have +1'd this activity.
- resharers - List all people who have reshared this activity.
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
+ connected - The list of visible people in the authenticated user's circles who also use the requesting app. This list is limited to users who made their app activities visible to the authenticated user.
+ visible - The list of people who this user has added to one or more circles, limited to the circles visible to the requesting application.
+ orderBy: string, The order to return people in.
+ Allowed values
+ alphabetical - Order the people by their display name.
+ best - Order people based on the relevence to the viewer.
+ pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
Returns:
An object of the form:
{
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+ "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+ "title": "A String", # The title of this collection of people.
+ "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
{
- "relationshipStatus": "A String", # The person's relationship status. Possible values are:
+ "braggingRights": "A String", # The "bragging rights" line of this person.
+ "image": { # The representation of the person's profile photo.
+ "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "isDefault": True or False, # Whether the person's profile photo is the default one
+ },
+ "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
+ "id": "A String", # The ID of this person.
+ "occupation": "A String", # The occupation of this person.
+ "verified": True or False, # Whether the person or Google+ Page has been verified.
+ "tagline": "A String", # The brief description (tagline) of this person.
+ "currentLocation": "A String", # (this field is not currently used)
+ "etag": "A String", # ETag of this response for caching purposes.
+ "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
+ "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
+ # - "person" - represents an actual person.
+ # - "page" - represents a page.
+ "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
# - "single" - Person is single.
# - "in_a_relationship" - Person is in a relationship.
# - "engaged" - Person is engaged.
@@ -215,23 +273,42 @@ Method Details
# - "widowed" - Person is widowed.
# - "in_domestic_partnership" - Person is in a domestic partnership.
# - "in_civil_union" - Person is in a civil union.
+ "aboutMe": "A String", # A short biography for this person.
+ "placesLived": [ # A list of places where this person has lived.
+ {
+ "primary": True or False, # If "true", this place of residence is this person's primary residence.
+ "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
+ },
+ ],
+ "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ "nickname": "A String", # The nickname of this person.
+ "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
+ {
+ "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
+ # - "account" - Google account email address.
+ # - "home" - Home email address.
+ # - "work" - Work email address.
+ # - "other" - Other.
+ "value": "A String", # The email address.
+ },
+ ],
"organizations": [ # A list of current or past organizations with which this person is associated.
{
- "startDate": "A String", # The date the person joined this organization.
- "endDate": "A String", # The date the person left this organization.
- "description": "A String", # A short description of the person's role in this organization.
+ "startDate": "A String", # The date that the person joined this organization.
+ "endDate": "A String", # The date that the person left this organization.
+ "description": "A String", # A short description of the person's role in this organization. Deprecated.
"title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
- "location": "A String", # The location of this organization.
- "department": "A String", # The department within the organization.
- "type": "A String", # The type of organization. Possible values are:
+ "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
+ "location": "A String", # The location of this organization. Deprecated.
+ "department": "A String", # The department within the organization. Deprecated.
+ "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
# - "work" - Work.
# - "school" - School.
"name": "A String", # The name of the organization.
},
],
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "displayName": "A String", # The name of this person, suitable for display.
+ "displayName": "A String", # The name of this person, which is suitable for display.
"name": { # An object representation of the individual components of a person's name.
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
"middleName": "A String", # The middle name of this person.
@@ -240,57 +317,193 @@ Method Details
"givenName": "A String", # The given name (first name) of this person.
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
},
- "url": "A String", # The URL of this person's profile.
- "gender": "A String", # The person's gender. Possible values are:
+ "language": "A String", # The user's preferred language for rendering.
+ "skills": "A String", # The person's skills.
+ "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
# - "male" - Male gender.
# - "female" - Female gender.
# - "other" - Other.
- "aboutMe": "A String", # A short biography for this person.
+ "cover": { # The cover photo content.
+ "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
+ # - "banner" - One large image banner.
+ "coverInfo": { # Extra information about the cover photo.
+ "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
+ "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
+ },
+ "coverPhoto": { # The person's primary cover image.
+ "url": "A String", # The URL of the image.
+ "width": 42, # The width of the image.
+ "height": 42, # The height of the image.
+ },
+ },
+ "url": "A String", # The URL of this person's profile.
+ "isPlusUser": True or False, # Whether this user has signed up for Google+.
+ "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
+ "urls": [ # A list of URLs for this person.
+ {
+ "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
+ # - "otherProfile" - URL for another profile.
+ # - "contributor" - URL to a site for which this person is a contributor.
+ # - "website" - URL for this Google+ Page's primary website.
+ # - "other" - Other URL.
+ "value": "A String", # The URL value.
+ "label": "A String", # The label of the URL.
+ },
+ ],
+ "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
+ "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
+ # - "17" - for age 17
+ # - "20" - for age 20
+ "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
+ # - "21" - for age 21
+ # - "18" - for age 18
+ },
+ },
+ ],
+ "etag": "A String", # ETag of this response for caching purposes.
+ "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
+ "selfLink": "A String", # Link to this resource.
+ }
+
+
+
+ listByActivity(activityId, collection, pageToken=None, maxResults=None)
+ List all of the people in the specified collection for a particular activity.
+
+Args:
+ activityId: string, The ID of the activity to get the list of people for. (required)
+ collection: string, The collection of people to list. (required)
+ Allowed values
+ plusoners - List all people who have +1'd this activity.
+ resharers - List all people who have reshared this activity.
+ pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+ "title": "A String", # The title of this collection of people.
+ "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+ {
+ "braggingRights": "A String", # The "bragging rights" line of this person.
+ "image": { # The representation of the person's profile photo.
+ "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "isDefault": True or False, # Whether the person's profile photo is the default one
+ },
+ "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
+ "id": "A String", # The ID of this person.
+ "occupation": "A String", # The occupation of this person.
+ "verified": True or False, # Whether the person or Google+ Page has been verified.
"tagline": "A String", # The brief description (tagline) of this person.
+ "currentLocation": "A String", # (this field is not currently used)
+ "etag": "A String", # ETag of this response for caching purposes.
+ "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
+ "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
+ # - "person" - represents an actual person.
+ # - "page" - represents a page.
+ "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
+ # - "single" - Person is single.
+ # - "in_a_relationship" - Person is in a relationship.
+ # - "engaged" - Person is engaged.
+ # - "married" - Person is married.
+ # - "its_complicated" - The relationship is complicated.
+ # - "open_relationship" - Person is in an open relationship.
+ # - "widowed" - Person is widowed.
+ # - "in_domestic_partnership" - Person is in a domestic partnership.
+ # - "in_civil_union" - Person is in a civil union.
+ "aboutMe": "A String", # A short biography for this person.
"placesLived": [ # A list of places where this person has lived.
{
"primary": True or False, # If "true", this place of residence is this person's primary residence.
"value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
},
],
- "emails": [ # A list of email addresses for this person.
+ "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ "nickname": "A String", # The nickname of this person.
+ "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
{
- "type": "A String", # The type of address. Possible values are:
+ "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
+ # - "account" - Google account email address.
# - "home" - Home email address.
# - "work" - Work email address.
# - "other" - Other.
- "primary": True or False, # If "true", indicates this email address is the person's primary one.
"value": "A String", # The email address.
},
],
- "nickname": "A String", # The nickname of this person.
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ "organizations": [ # A list of current or past organizations with which this person is associated.
+ {
+ "startDate": "A String", # The date that the person joined this organization.
+ "endDate": "A String", # The date that the person left this organization.
+ "description": "A String", # A short description of the person's role in this organization. Deprecated.
+ "title": "A String", # The person's job title or role within the organization.
+ "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
+ "location": "A String", # The location of this organization. Deprecated.
+ "department": "A String", # The department within the organization. Deprecated.
+ "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
+ # - "work" - Work.
+ # - "school" - School.
+ "name": "A String", # The name of the organization.
+ },
+ ],
+ "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
+ "displayName": "A String", # The name of this person, which is suitable for display.
+ "name": { # An object representation of the individual components of a person's name.
+ "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
+ "middleName": "A String", # The middle name of this person.
+ "familyName": "A String", # The family name (last name) of this person.
+ "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
+ "givenName": "A String", # The given name (first name) of this person.
+ "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
+ },
+ "language": "A String", # The user's preferred language for rendering.
+ "skills": "A String", # The person's skills.
+ "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
+ # - "male" - Male gender.
+ # - "female" - Female gender.
+ # - "other" - Other.
+ "cover": { # The cover photo content.
+ "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
+ # - "banner" - One large image banner.
+ "coverInfo": { # Extra information about the cover photo.
+ "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
+ "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
+ },
+ "coverPhoto": { # The person's primary cover image.
+ "url": "A String", # The URL of the image.
+ "width": 42, # The width of the image.
+ "height": 42, # The height of the image.
+ },
+ },
+ "url": "A String", # The URL of this person's profile.
+ "isPlusUser": True or False, # Whether this user has signed up for Google+.
+ "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
"urls": [ # A list of URLs for this person.
{
- "type": "A String", # The type of URL. Possible values are:
- # - "home" - URL for home.
- # - "work" - URL for work.
- # - "blog" - URL for blog.
- # - "profile" - URL for profile.
- # - "other" - Other.
- "primary": True or False, # If "true", this URL is the person's primary URL.
+ "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
+ # - "otherProfile" - URL for another profile.
+ # - "contributor" - URL to a site for which this person is a contributor.
+ # - "website" - URL for this Google+ Page's primary website.
+ # - "other" - Other URL.
"value": "A String", # The URL value.
+ "label": "A String", # The label of the URL.
},
],
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
+ "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
+ # - "17" - for age 17
+ # - "20" - for age 20
+ "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
+ # - "21" - for age 21
+ # - "18" - for age 18
},
- "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
- "id": "A String", # The ID of this person.
- "languagesSpoken": [ # The languages spoken by this person.
- "A String",
- ],
- "currentLocation": "A String", # The current location for this person.
},
],
- "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+ "etag": "A String", # ETag of this response for caching purposes.
+ "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
"selfLink": "A String", # Link to this resource.
- "title": "A String", # The title of this collection of people.
}
@@ -308,24 +521,56 @@ Method Details
+
+ list_next(previous_request, previous_response)
+ 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.
+
+
+
search(query, pageToken=None, language=None, maxResults=None)
Search all public profiles.
Args:
- query: string, Full-text search query string. (required)
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.
- language: string, Specify the preferred language to search with. See Language Codes for available values.
- maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
+ query: string, Specify a query string for full text search of public text in all profiles. (required)
+ pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.
+ language: string, Specify the preferred language to search with. See search language codes for available values.
+ maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
Returns:
An object of the form:
{
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+ "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+ "title": "A String", # The title of this collection of people.
+ "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
{
- "relationshipStatus": "A String", # The person's relationship status. Possible values are:
+ "braggingRights": "A String", # The "bragging rights" line of this person.
+ "image": { # The representation of the person's profile photo.
+ "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "isDefault": True or False, # Whether the person's profile photo is the default one
+ },
+ "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
+ "id": "A String", # The ID of this person.
+ "occupation": "A String", # The occupation of this person.
+ "verified": True or False, # Whether the person or Google+ Page has been verified.
+ "tagline": "A String", # The brief description (tagline) of this person.
+ "currentLocation": "A String", # (this field is not currently used)
+ "etag": "A String", # ETag of this response for caching purposes.
+ "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
+ "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
+ # - "person" - represents an actual person.
+ # - "page" - represents a page.
+ "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
# - "single" - Person is single.
# - "in_a_relationship" - Person is in a relationship.
# - "engaged" - Person is engaged.
@@ -335,23 +580,42 @@ Method Details
# - "widowed" - Person is widowed.
# - "in_domestic_partnership" - Person is in a domestic partnership.
# - "in_civil_union" - Person is in a civil union.
+ "aboutMe": "A String", # A short biography for this person.
+ "placesLived": [ # A list of places where this person has lived.
+ {
+ "primary": True or False, # If "true", this place of residence is this person's primary residence.
+ "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
+ },
+ ],
+ "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ "nickname": "A String", # The nickname of this person.
+ "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
+ {
+ "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
+ # - "account" - Google account email address.
+ # - "home" - Home email address.
+ # - "work" - Work email address.
+ # - "other" - Other.
+ "value": "A String", # The email address.
+ },
+ ],
"organizations": [ # A list of current or past organizations with which this person is associated.
{
- "startDate": "A String", # The date the person joined this organization.
- "endDate": "A String", # The date the person left this organization.
- "description": "A String", # A short description of the person's role in this organization.
+ "startDate": "A String", # The date that the person joined this organization.
+ "endDate": "A String", # The date that the person left this organization.
+ "description": "A String", # A short description of the person's role in this organization. Deprecated.
"title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
- "location": "A String", # The location of this organization.
- "department": "A String", # The department within the organization.
- "type": "A String", # The type of organization. Possible values are:
+ "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
+ "location": "A String", # The location of this organization. Deprecated.
+ "department": "A String", # The department within the organization. Deprecated.
+ "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
# - "work" - Work.
# - "school" - School.
"name": "A String", # The name of the organization.
},
],
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "displayName": "A String", # The name of this person, suitable for display.
+ "displayName": "A String", # The name of this person, which is suitable for display.
"name": { # An object representation of the individual components of a person's name.
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
"middleName": "A String", # The middle name of this person.
@@ -360,57 +624,52 @@ Method Details
"givenName": "A String", # The given name (first name) of this person.
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
},
- "url": "A String", # The URL of this person's profile.
- "gender": "A String", # The person's gender. Possible values are:
+ "language": "A String", # The user's preferred language for rendering.
+ "skills": "A String", # The person's skills.
+ "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
# - "male" - Male gender.
# - "female" - Female gender.
# - "other" - Other.
- "aboutMe": "A String", # A short biography for this person.
- "tagline": "A String", # The brief description (tagline) of this person.
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
+ "cover": { # The cover photo content.
+ "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
+ # - "banner" - One large image banner.
+ "coverInfo": { # Extra information about the cover photo.
+ "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
+ "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
},
- ],
- "emails": [ # A list of email addresses for this person.
- {
- "type": "A String", # The type of address. Possible values are:
- # - "home" - Home email address.
- # - "work" - Work email address.
- # - "other" - Other.
- "primary": True or False, # If "true", indicates this email address is the person's primary one.
- "value": "A String", # The email address.
+ "coverPhoto": { # The person's primary cover image.
+ "url": "A String", # The URL of the image.
+ "width": 42, # The width of the image.
+ "height": 42, # The height of the image.
},
- ],
- "nickname": "A String", # The nickname of this person.
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ },
+ "url": "A String", # The URL of this person's profile.
+ "isPlusUser": True or False, # Whether this user has signed up for Google+.
+ "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
"urls": [ # A list of URLs for this person.
{
- "type": "A String", # The type of URL. Possible values are:
- # - "home" - URL for home.
- # - "work" - URL for work.
- # - "blog" - URL for blog.
- # - "profile" - URL for profile.
- # - "other" - Other.
- "primary": True or False, # If "true", this URL is the person's primary URL.
+ "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
+ # - "otherProfile" - URL for another profile.
+ # - "contributor" - URL to a site for which this person is a contributor.
+ # - "website" - URL for this Google+ Page's primary website.
+ # - "other" - Other URL.
"value": "A String", # The URL value.
+ "label": "A String", # The label of the URL.
},
],
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
+ "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
+ # - "17" - for age 17
+ # - "20" - for age 20
+ "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
+ # - "21" - for age 21
+ # - "18" - for age 18
},
- "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
- "id": "A String", # The ID of this person.
- "languagesSpoken": [ # The languages spoken by this person.
- "A String",
- ],
- "currentLocation": "A String", # The current location for this person.
},
],
- "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+ "etag": "A String", # ETag of this response for caching purposes.
+ "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
"selfLink": "A String", # Link to this resource.
- "title": "A String", # The title of this collection of people.
}
diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html
index c2677f660f2..ae93d11218a 100644
--- a/docs/dyn/storage_v1.buckets.html
+++ b/docs/dyn/storage_v1.buckets.html
@@ -91,10 +91,10 @@ Instance Methods
Retrieves the next page of results.
-Updates a bucket. This method supports patch semantics.
+Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. This method supports patch semantics.
-Updates a bucket.
+Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
Method Details
delete(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)
@@ -669,7 +669,7 @@ Method Details
patch(bucket, body, projection=None, ifMetagenerationMatch=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None)
- Updates a bucket. This method supports patch semantics.
+ Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. This method supports patch semantics.
Args:
bucket: string, Name of a bucket. (required)
@@ -940,7 +940,7 @@ Method Details
update(bucket, body, projection=None, ifMetagenerationMatch=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None)
- Updates a bucket.
+ Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
Args:
bucket: string, Name of a bucket. (required)
diff --git a/docs/dyn/tasks_v1.tasklists.html b/docs/dyn/tasks_v1.tasklists.html
index 626711773a0..3e70ee3cb37 100644
--- a/docs/dyn/tasks_v1.tasklists.html
+++ b/docs/dyn/tasks_v1.tasklists.html
@@ -117,10 +117,11 @@ Method Details
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+ "title": "A String", # Title of the task list.
+ "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- "title": "A String", # Title of the task list.
}
@@ -134,10 +135,11 @@ Method Details
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+ "title": "A String", # Title of the task list.
+ "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- "title": "A String", # Title of the task list.
}
@@ -146,10 +148,11 @@ Method Details
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+ "title": "A String", # Title of the task list.
+ "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- "title": "A String", # Title of the task list.
}
@@ -159,7 +162,7 @@ Method Details
Args:
pageToken: string, Token specifying the result page to return. Optional.
- maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100.
+ maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
Returns:
An object of the form:
@@ -169,10 +172,11 @@ Method Details
"items": [ # Collection of task lists.
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+ "title": "A String", # Title of the task list.
+ "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- "title": "A String", # Title of the task list.
},
],
"kind": "tasks#taskLists", # Type of the resource. This is always "tasks#taskLists".
@@ -205,10 +209,11 @@ Method Details
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+ "title": "A String", # Title of the task list.
+ "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- "title": "A String", # Title of the task list.
}
@@ -217,10 +222,11 @@ Method Details
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+ "title": "A String", # Title of the task list.
+ "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- "title": "A String", # Title of the task list.
}
@@ -235,10 +241,11 @@ Method Details
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+ "title": "A String", # Title of the task list.
+ "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- "title": "A String", # Title of the task list.
}
@@ -247,10 +254,11 @@ Method Details
{
"kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+ "title": "A String", # Title of the task list.
+ "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
"etag": "A String", # ETag of the resource.
"id": "A String", # Task list identifier.
"selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- "title": "A String", # Title of the task list.
}
diff --git a/docs/dyn/tasks_v1.tasks.html b/docs/dyn/tasks_v1.tasks.html
index 6f2117eeef1..d5808334f69 100644
--- a/docs/dyn/tasks_v1.tasks.html
+++ b/docs/dyn/tasks_v1.tasks.html
@@ -87,7 +87,7 @@ Instance Methods
insert(tasklist, body, parent=None, previous=None)
Creates a new task on the specified task list.
+ list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)
Returns all tasks in the specified task list.
list_next(previous_request, previous_response)
@@ -137,6 +137,13 @@ Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+ "links": [ # Collection of links. This collection is read-only.
+ {
+ "type": "A String", # Type of the link, e.g. "email".
+ "link": "A String", # The URL.
+ "description": "A String", # The description. In HTML speak: Everything between and .
+ },
+ ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -164,6 +171,13 @@ Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+ "links": [ # Collection of links. This collection is read-only.
+ {
+ "type": "A String", # Type of the link, e.g. "email".
+ "link": "A String", # The URL.
+ "description": "A String", # The description. In HTML speak: Everything between and .
+ },
+ ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -187,6 +201,13 @@ Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+ "links": [ # Collection of links. This collection is read-only.
+ {
+ "type": "A String", # Type of the link, e.g. "email".
+ "link": "A String", # The URL.
+ "description": "A String", # The description. In HTML speak: Everything between and .
+ },
+ ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -201,21 +222,21 @@ Method Details
- list(tasklist, dueMax=None, pageToken=None, updatedMin=None, maxResults=None, completedMin=None, showDeleted=None, completedMax=None, showHidden=None, showCompleted=None, dueMin=None)
+ list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)
Returns all tasks in the specified task list.
Args:
tasklist: string, Task list identifier. (required)
+ showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.
+ dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
dueMax: string, Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
pageToken: string, Token specifying the result page to return. Optional.
updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
- maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100.
- completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.
completedMax: string, Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
+ maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
+ completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.
- showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.
- dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
Returns:
An object of the form:
@@ -228,6 +249,13 @@ Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+ "links": [ # Collection of links. This collection is read-only.
+ {
+ "type": "A String", # Type of the link, e.g. "email".
+ "link": "A String", # The URL.
+ "description": "A String", # The description. In HTML speak: Everything between and .
+ },
+ ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -277,6 +305,13 @@ Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+ "links": [ # Collection of links. This collection is read-only.
+ {
+ "type": "A String", # Type of the link, e.g. "email".
+ "link": "A String", # The URL.
+ "description": "A String", # The description. In HTML speak: Everything between and .
+ },
+ ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -305,6 +340,13 @@ Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+ "links": [ # Collection of links. This collection is read-only.
+ {
+ "type": "A String", # Type of the link, e.g. "email".
+ "link": "A String", # The URL.
+ "description": "A String", # The description. In HTML speak: Everything between and .
+ },
+ ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -326,6 +368,13 @@ Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+ "links": [ # Collection of links. This collection is read-only.
+ {
+ "type": "A String", # Type of the link, e.g. "email".
+ "link": "A String", # The URL.
+ "description": "A String", # The description. In HTML speak: Everything between and .
+ },
+ ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -354,6 +403,13 @@ Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+ "links": [ # Collection of links. This collection is read-only.
+ {
+ "type": "A String", # Type of the link, e.g. "email".
+ "link": "A String", # The URL.
+ "description": "A String", # The description. In HTML speak: Everything between and .
+ },
+ ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
@@ -375,6 +431,13 @@ Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+ "links": [ # Collection of links. This collection is read-only.
+ {
+ "type": "A String", # Type of the link, e.g. "email".
+ "link": "A String", # The URL.
+ "description": "A String", # The description. In HTML speak: Everything between and .
+ },
+ ],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
diff --git a/docs/epy/class-tree.html b/docs/epy/class-tree.html
index da4095b7f8e..ae26e2a744a 100644
--- a/docs/epy/class-tree.html
+++ b/docs/epy/class-tree.html
@@ -163,7 +163,7 @@ Class Hierarchy
list(userId, collection, orderBy=None, pageToken=None, maxResults=None)listByActivity(activityId, collection, pageToken=None, maxResults=None)listByActivity_next(previous_request, previous_response)list_next(previous_request, previous_response)search(query, pageToken=None, language=None, maxResults=None)get(userId)
- Get a person's profile. +Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language. Args: userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required) @@ -101,7 +107,23 @@Method Details
An object of the form: { - "relationshipStatus": "A String", # The person's relationship status. Possible values are: + "braggingRights": "A String", # The "bragging rights" line of this person. + "image": { # The representation of the person's profile photo. + "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "isDefault": True or False, # Whether the person's profile photo is the default one + }, + "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name. + "id": "A String", # The ID of this person. + "occupation": "A String", # The occupation of this person. + "verified": True or False, # Whether the person or Google+ Page has been verified. + "tagline": "A String", # The brief description (tagline) of this person. + "currentLocation": "A String", # (this field is not currently used) + "etag": "A String", # ETag of this response for caching purposes. + "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle. + "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values: + # - "person" - represents an actual person. + # - "page" - represents a page. + "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values: # - "single" - Person is single. # - "in_a_relationship" - Person is in a relationship. # - "engaged" - Person is engaged. @@ -111,23 +133,42 @@Method Details
# - "widowed" - Person is widowed. # - "in_domestic_partnership" - Person is in a domestic partnership. # - "in_civil_union" - Person is in a civil union. + "aboutMe": "A String", # A short biography for this person. + "placesLived": [ # A list of places where this person has lived. + { + "primary": True or False, # If "true", this place of residence is this person's primary residence. + "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". + }, + ], + "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. + "nickname": "A String", # The nickname of this person. + "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. + { + "type": "A String", # The type of address. Possible values include, but are not limited to, the following values: + # - "account" - Google account email address. + # - "home" - Home email address. + # - "work" - Work email address. + # - "other" - Other. + "value": "A String", # The email address. + }, + ], "organizations": [ # A list of current or past organizations with which this person is associated. { - "startDate": "A String", # The date the person joined this organization. - "endDate": "A String", # The date the person left this organization. - "description": "A String", # A short description of the person's role in this organization. + "startDate": "A String", # The date that the person joined this organization. + "endDate": "A String", # The date that the person left this organization. + "description": "A String", # A short description of the person's role in this organization. Deprecated. "title": "A String", # The person's job title or role within the organization. - "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one). - "location": "A String", # The location of this organization. - "department": "A String", # The department within the organization. - "type": "A String", # The type of organization. Possible values are: + "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one. + "location": "A String", # The location of this organization. Deprecated. + "department": "A String", # The department within the organization. Deprecated. + "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values: # - "work" - Work. # - "school" - School. "name": "A String", # The name of the organization. }, ], "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person". - "displayName": "A String", # The name of this person, suitable for display. + "displayName": "A String", # The name of this person, which is suitable for display. "name": { # An object representation of the individual components of a person's name. "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person. "middleName": "A String", # The middle name of this person. @@ -136,76 +177,93 @@Method Details
"givenName": "A String", # The given name (first name) of this person. "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person. }, - "url": "A String", # The URL of this person's profile. - "gender": "A String", # The person's gender. Possible values are: + "language": "A String", # The user's preferred language for rendering. + "skills": "A String", # The person's skills. + "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values: # - "male" - Male gender. # - "female" - Female gender. # - "other" - Other. - "aboutMe": "A String", # A short biography for this person. - "tagline": "A String", # The brief description (tagline) of this person. - "placesLived": [ # A list of places where this person has lived. - { - "primary": True or False, # If "true", this place of residence is this person's primary residence. - "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". + "cover": { # The cover photo content. + "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values: + # - "banner" - One large image banner. + "coverInfo": { # Extra information about the cover photo. + "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout. + "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout. }, - ], - "emails": [ # A list of email addresses for this person. - { - "type": "A String", # The type of address. Possible values are: - # - "home" - Home email address. - # - "work" - Work email address. - # - "other" - Other. - "primary": True or False, # If "true", indicates this email address is the person's primary one. - "value": "A String", # The email address. + "coverPhoto": { # The person's primary cover image. + "url": "A String", # The URL of the image. + "width": 42, # The width of the image. + "height": 42, # The height of the image. }, - ], - "nickname": "A String", # The nickname of this person. - "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. + }, + "url": "A String", # The URL of this person's profile. + "isPlusUser": True or False, # Whether this user has signed up for Google+. + "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page. "urls": [ # A list of URLs for this person. { - "type": "A String", # The type of URL. Possible values are: - # - "home" - URL for home. - # - "work" - URL for work. - # - "blog" - URL for blog. - # - "profile" - URL for profile. - # - "other" - Other. - "primary": True or False, # If "true", this URL is the person's primary URL. + "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values: + # - "otherProfile" - URL for another profile. + # - "contributor" - URL to a site for which this person is a contributor. + # - "website" - URL for this Google+ Page's primary website. + # - "other" - Other URL. "value": "A String", # The URL value. + "label": "A String", # The label of the URL. }, ], - "image": { # The representation of the person's profile photo. - "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning. + "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following: + # - "17" - for age 17 + # - "20" - for age 20 + "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following: + # - "21" - for age 21 + # - "18" - for age 18 }, - "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private). - "id": "A String", # The ID of this person. - "languagesSpoken": [ # The languages spoken by this person. - "A String", - ], - "currentLocation": "A String", # The current location for this person. }
listByActivity(activityId, collection, pageToken=None, maxResults=None)
- List all of the people in the specified collection for a particular activity. +list(userId, collection, orderBy=None, pageToken=None, maxResults=None)+List all of the people in the specified collection. Args: - activityId: string, The ID of the activity to get the list of people for. (required) + userId: string, Get the collection of people for the person identified. Use "me" to indicate the authenticated user. (required) collection: string, The collection of people to list. (required) Allowed values - plusoners - List all people who have +1'd this activity. - resharers - List all people who have reshared this activity. - pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. - maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults. + connected - The list of visible people in the authenticated user's circles who also use the requesting app. This list is limited to users who made their app activities visible to the authenticated user. + visible - The list of people who this user has added to one or more circles, limited to the circles visible to the requesting application. + orderBy: string, The order to return people in. + Allowed values + alphabetical - Order the people by their display name. + best - Order people based on the relevence to the viewer. + pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. + maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. Returns: An object of the form: { - "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. - "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method. + "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. + "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed". + "title": "A String", # The title of this collection of people. + "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method. { - "relationshipStatus": "A String", # The person's relationship status. Possible values are: + "braggingRights": "A String", # The "bragging rights" line of this person. + "image": { # The representation of the person's profile photo. + "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "isDefault": True or False, # Whether the person's profile photo is the default one + }, + "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name. + "id": "A String", # The ID of this person. + "occupation": "A String", # The occupation of this person. + "verified": True or False, # Whether the person or Google+ Page has been verified. + "tagline": "A String", # The brief description (tagline) of this person. + "currentLocation": "A String", # (this field is not currently used) + "etag": "A String", # ETag of this response for caching purposes. + "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle. + "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values: + # - "person" - represents an actual person. + # - "page" - represents a page. + "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values: # - "single" - Person is single. # - "in_a_relationship" - Person is in a relationship. # - "engaged" - Person is engaged. @@ -215,23 +273,42 @@+Method Details
# - "widowed" - Person is widowed. # - "in_domestic_partnership" - Person is in a domestic partnership. # - "in_civil_union" - Person is in a civil union. + "aboutMe": "A String", # A short biography for this person. + "placesLived": [ # A list of places where this person has lived. + { + "primary": True or False, # If "true", this place of residence is this person's primary residence. + "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". + }, + ], + "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. + "nickname": "A String", # The nickname of this person. + "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. + { + "type": "A String", # The type of address. Possible values include, but are not limited to, the following values: + # - "account" - Google account email address. + # - "home" - Home email address. + # - "work" - Work email address. + # - "other" - Other. + "value": "A String", # The email address. + }, + ], "organizations": [ # A list of current or past organizations with which this person is associated. { - "startDate": "A String", # The date the person joined this organization. - "endDate": "A String", # The date the person left this organization. - "description": "A String", # A short description of the person's role in this organization. + "startDate": "A String", # The date that the person joined this organization. + "endDate": "A String", # The date that the person left this organization. + "description": "A String", # A short description of the person's role in this organization. Deprecated. "title": "A String", # The person's job title or role within the organization. - "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one). - "location": "A String", # The location of this organization. - "department": "A String", # The department within the organization. - "type": "A String", # The type of organization. Possible values are: + "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one. + "location": "A String", # The location of this organization. Deprecated. + "department": "A String", # The department within the organization. Deprecated. + "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values: # - "work" - Work. # - "school" - School. "name": "A String", # The name of the organization. }, ], "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person". - "displayName": "A String", # The name of this person, suitable for display. + "displayName": "A String", # The name of this person, which is suitable for display. "name": { # An object representation of the individual components of a person's name. "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person. "middleName": "A String", # The middle name of this person. @@ -240,57 +317,193 @@Method Details
"givenName": "A String", # The given name (first name) of this person. "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person. }, - "url": "A String", # The URL of this person's profile. - "gender": "A String", # The person's gender. Possible values are: + "language": "A String", # The user's preferred language for rendering. + "skills": "A String", # The person's skills. + "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values: # - "male" - Male gender. # - "female" - Female gender. # - "other" - Other. - "aboutMe": "A String", # A short biography for this person. + "cover": { # The cover photo content. + "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values: + # - "banner" - One large image banner. + "coverInfo": { # Extra information about the cover photo. + "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout. + "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout. + }, + "coverPhoto": { # The person's primary cover image. + "url": "A String", # The URL of the image. + "width": 42, # The width of the image. + "height": 42, # The height of the image. + }, + }, + "url": "A String", # The URL of this person's profile. + "isPlusUser": True or False, # Whether this user has signed up for Google+. + "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page. + "urls": [ # A list of URLs for this person. + { + "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values: + # - "otherProfile" - URL for another profile. + # - "contributor" - URL to a site for which this person is a contributor. + # - "website" - URL for this Google+ Page's primary website. + # - "other" - Other URL. + "value": "A String", # The URL value. + "label": "A String", # The label of the URL. + }, + ], + "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning. + "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following: + # - "17" - for age 17 + # - "20" - for age 20 + "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following: + # - "21" - for age 21 + # - "18" - for age 18 + }, + }, + ], + "etag": "A String", # ETag of this response for caching purposes. + "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections. + "selfLink": "A String", # Link to this resource. + }
listByActivity(activityId, collection, pageToken=None, maxResults=None)
+ List all of the people in the specified collection for a particular activity.
+
+Args:
+ activityId: string, The ID of the activity to get the list of people for. (required)
+ collection: string, The collection of people to list. (required)
+ Allowed values
+ plusoners - List all people who have +1'd this activity.
+ resharers - List all people who have reshared this activity.
+ pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+ "title": "A String", # The title of this collection of people.
+ "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+ {
+ "braggingRights": "A String", # The "bragging rights" line of this person.
+ "image": { # The representation of the person's profile photo.
+ "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "isDefault": True or False, # Whether the person's profile photo is the default one
+ },
+ "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
+ "id": "A String", # The ID of this person.
+ "occupation": "A String", # The occupation of this person.
+ "verified": True or False, # Whether the person or Google+ Page has been verified.
"tagline": "A String", # The brief description (tagline) of this person.
+ "currentLocation": "A String", # (this field is not currently used)
+ "etag": "A String", # ETag of this response for caching purposes.
+ "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
+ "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
+ # - "person" - represents an actual person.
+ # - "page" - represents a page.
+ "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
+ # - "single" - Person is single.
+ # - "in_a_relationship" - Person is in a relationship.
+ # - "engaged" - Person is engaged.
+ # - "married" - Person is married.
+ # - "its_complicated" - The relationship is complicated.
+ # - "open_relationship" - Person is in an open relationship.
+ # - "widowed" - Person is widowed.
+ # - "in_domestic_partnership" - Person is in a domestic partnership.
+ # - "in_civil_union" - Person is in a civil union.
+ "aboutMe": "A String", # A short biography for this person.
"placesLived": [ # A list of places where this person has lived.
{
"primary": True or False, # If "true", this place of residence is this person's primary residence.
"value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
},
],
- "emails": [ # A list of email addresses for this person.
+ "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ "nickname": "A String", # The nickname of this person.
+ "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
{
- "type": "A String", # The type of address. Possible values are:
+ "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
+ # - "account" - Google account email address.
# - "home" - Home email address.
# - "work" - Work email address.
# - "other" - Other.
- "primary": True or False, # If "true", indicates this email address is the person's primary one.
"value": "A String", # The email address.
},
],
- "nickname": "A String", # The nickname of this person.
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ "organizations": [ # A list of current or past organizations with which this person is associated.
+ {
+ "startDate": "A String", # The date that the person joined this organization.
+ "endDate": "A String", # The date that the person left this organization.
+ "description": "A String", # A short description of the person's role in this organization. Deprecated.
+ "title": "A String", # The person's job title or role within the organization.
+ "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
+ "location": "A String", # The location of this organization. Deprecated.
+ "department": "A String", # The department within the organization. Deprecated.
+ "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
+ # - "work" - Work.
+ # - "school" - School.
+ "name": "A String", # The name of the organization.
+ },
+ ],
+ "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
+ "displayName": "A String", # The name of this person, which is suitable for display.
+ "name": { # An object representation of the individual components of a person's name.
+ "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
+ "middleName": "A String", # The middle name of this person.
+ "familyName": "A String", # The family name (last name) of this person.
+ "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
+ "givenName": "A String", # The given name (first name) of this person.
+ "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
+ },
+ "language": "A String", # The user's preferred language for rendering.
+ "skills": "A String", # The person's skills.
+ "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
+ # - "male" - Male gender.
+ # - "female" - Female gender.
+ # - "other" - Other.
+ "cover": { # The cover photo content.
+ "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
+ # - "banner" - One large image banner.
+ "coverInfo": { # Extra information about the cover photo.
+ "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
+ "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
+ },
+ "coverPhoto": { # The person's primary cover image.
+ "url": "A String", # The URL of the image.
+ "width": 42, # The width of the image.
+ "height": 42, # The height of the image.
+ },
+ },
+ "url": "A String", # The URL of this person's profile.
+ "isPlusUser": True or False, # Whether this user has signed up for Google+.
+ "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
"urls": [ # A list of URLs for this person.
{
- "type": "A String", # The type of URL. Possible values are:
- # - "home" - URL for home.
- # - "work" - URL for work.
- # - "blog" - URL for blog.
- # - "profile" - URL for profile.
- # - "other" - Other.
- "primary": True or False, # If "true", this URL is the person's primary URL.
+ "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
+ # - "otherProfile" - URL for another profile.
+ # - "contributor" - URL to a site for which this person is a contributor.
+ # - "website" - URL for this Google+ Page's primary website.
+ # - "other" - Other URL.
"value": "A String", # The URL value.
+ "label": "A String", # The label of the URL.
},
],
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
+ "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
+ # - "17" - for age 17
+ # - "20" - for age 20
+ "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
+ # - "21" - for age 21
+ # - "18" - for age 18
},
- "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
- "id": "A String", # The ID of this person.
- "languagesSpoken": [ # The languages spoken by this person.
- "A String",
- ],
- "currentLocation": "A String", # The current location for this person.
},
],
- "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+ "etag": "A String", # ETag of this response for caching purposes.
+ "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
"selfLink": "A String", # Link to this resource.
- "title": "A String", # The title of this collection of people.
}
list_next(previous_request, previous_response)
+ 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. ++
search(query, pageToken=None, language=None, maxResults=None)
Search all public profiles.
Args:
- query: string, Full-text search query string. (required)
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.
- language: string, Specify the preferred language to search with. See Language Codes for available values.
- maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
+ query: string, Specify a query string for full text search of public text in all profiles. (required)
+ pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.
+ language: string, Specify the preferred language to search with. See search language codes for available values.
+ maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
Returns:
An object of the form:
{
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+ "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+ "title": "A String", # The title of this collection of people.
+ "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
{
- "relationshipStatus": "A String", # The person's relationship status. Possible values are:
+ "braggingRights": "A String", # The "bragging rights" line of this person.
+ "image": { # The representation of the person's profile photo.
+ "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "isDefault": True or False, # Whether the person's profile photo is the default one
+ },
+ "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
+ "id": "A String", # The ID of this person.
+ "occupation": "A String", # The occupation of this person.
+ "verified": True or False, # Whether the person or Google+ Page has been verified.
+ "tagline": "A String", # The brief description (tagline) of this person.
+ "currentLocation": "A String", # (this field is not currently used)
+ "etag": "A String", # ETag of this response for caching purposes.
+ "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
+ "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
+ # - "person" - represents an actual person.
+ # - "page" - represents a page.
+ "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
# - "single" - Person is single.
# - "in_a_relationship" - Person is in a relationship.
# - "engaged" - Person is engaged.
@@ -335,23 +580,42 @@ Method Details
# - "widowed" - Person is widowed.
# - "in_domestic_partnership" - Person is in a domestic partnership.
# - "in_civil_union" - Person is in a civil union.
+ "aboutMe": "A String", # A short biography for this person.
+ "placesLived": [ # A list of places where this person has lived.
+ {
+ "primary": True or False, # If "true", this place of residence is this person's primary residence.
+ "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
+ },
+ ],
+ "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ "nickname": "A String", # The nickname of this person.
+ "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
+ {
+ "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
+ # - "account" - Google account email address.
+ # - "home" - Home email address.
+ # - "work" - Work email address.
+ # - "other" - Other.
+ "value": "A String", # The email address.
+ },
+ ],
"organizations": [ # A list of current or past organizations with which this person is associated.
{
- "startDate": "A String", # The date the person joined this organization.
- "endDate": "A String", # The date the person left this organization.
- "description": "A String", # A short description of the person's role in this organization.
+ "startDate": "A String", # The date that the person joined this organization.
+ "endDate": "A String", # The date that the person left this organization.
+ "description": "A String", # A short description of the person's role in this organization. Deprecated.
"title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
- "location": "A String", # The location of this organization.
- "department": "A String", # The department within the organization.
- "type": "A String", # The type of organization. Possible values are:
+ "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
+ "location": "A String", # The location of this organization. Deprecated.
+ "department": "A String", # The department within the organization. Deprecated.
+ "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
# - "work" - Work.
# - "school" - School.
"name": "A String", # The name of the organization.
},
],
"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "displayName": "A String", # The name of this person, suitable for display.
+ "displayName": "A String", # The name of this person, which is suitable for display.
"name": { # An object representation of the individual components of a person's name.
"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
"middleName": "A String", # The middle name of this person.
@@ -360,57 +624,52 @@ Method Details
"givenName": "A String", # The given name (first name) of this person.
"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
},
- "url": "A String", # The URL of this person's profile.
- "gender": "A String", # The person's gender. Possible values are:
+ "language": "A String", # The user's preferred language for rendering.
+ "skills": "A String", # The person's skills.
+ "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
# - "male" - Male gender.
# - "female" - Female gender.
# - "other" - Other.
- "aboutMe": "A String", # A short biography for this person.
- "tagline": "A String", # The brief description (tagline) of this person.
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
+ "cover": { # The cover photo content.
+ "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
+ # - "banner" - One large image banner.
+ "coverInfo": { # Extra information about the cover photo.
+ "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
+ "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
},
- ],
- "emails": [ # A list of email addresses for this person.
- {
- "type": "A String", # The type of address. Possible values are:
- # - "home" - Home email address.
- # - "work" - Work email address.
- # - "other" - Other.
- "primary": True or False, # If "true", indicates this email address is the person's primary one.
- "value": "A String", # The email address.
+ "coverPhoto": { # The person's primary cover image.
+ "url": "A String", # The URL of the image.
+ "width": 42, # The width of the image.
+ "height": 42, # The height of the image.
},
- ],
- "nickname": "A String", # The nickname of this person.
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+ },
+ "url": "A String", # The URL of this person's profile.
+ "isPlusUser": True or False, # Whether this user has signed up for Google+.
+ "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
"urls": [ # A list of URLs for this person.
{
- "type": "A String", # The type of URL. Possible values are:
- # - "home" - URL for home.
- # - "work" - URL for work.
- # - "blog" - URL for blog.
- # - "profile" - URL for profile.
- # - "other" - Other.
- "primary": True or False, # If "true", this URL is the person's primary URL.
+ "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
+ # - "otherProfile" - URL for another profile.
+ # - "contributor" - URL to a site for which this person is a contributor.
+ # - "website" - URL for this Google+ Page's primary website.
+ # - "other" - Other URL.
"value": "A String", # The URL value.
+ "label": "A String", # The label of the URL.
},
],
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+ "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
+ "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
+ # - "17" - for age 17
+ # - "20" - for age 20
+ "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
+ # - "21" - for age 21
+ # - "18" - for age 18
},
- "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
- "id": "A String", # The ID of this person.
- "languagesSpoken": [ # The languages spoken by this person.
- "A String",
- ],
- "currentLocation": "A String", # The current location for this person.
},
],
- "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+ "etag": "A String", # ETag of this response for caching purposes.
+ "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
"selfLink": "A String", # Link to this resource.
- "title": "A String", # The title of this collection of people.
}
delete(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)
@@ -669,7 +669,7 @@ Method Details
patch(bucket, body, projection=None, ifMetagenerationMatch=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None)
- Updates a bucket. This method supports patch semantics. +Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. This method supports patch semantics. Args: bucket: string, Name of a bucket. (required) @@ -940,7 +940,7 @@Method Details
@@ -134,10 +135,11 @@update(bucket, body, projection=None, ifMetagenerationMatch=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None)-Updates a bucket. +Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. Args: bucket: string, Name of a bucket. (required) diff --git a/docs/dyn/tasks_v1.tasklists.html b/docs/dyn/tasks_v1.tasklists.html index 626711773a0..3e70ee3cb37 100644 --- a/docs/dyn/tasks_v1.tasklists.html +++ b/docs/dyn/tasks_v1.tasklists.html @@ -117,10 +117,11 @@Method Details
{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. }Method Details
{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. } @@ -146,10 +148,11 @@Method Details
{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. }
Method Details
Args: pageToken: string, Token specifying the result page to return. Optional. - maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100. + maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100. Returns: An object of the form: @@ -169,10 +172,11 @@Method Details
"items": [ # Collection of task lists. { "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. }, ], "kind": "tasks#taskLists", # Type of the resource. This is always "tasks#taskLists". @@ -205,10 +209,11 @@Method Details
{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. } @@ -217,10 +222,11 @@Method Details
{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. }list_next(previous_request, previous_response)list(tasklist, dueMax=None, pageToken=None, updatedMin=None, maxResults=None, completedMin=None, showDeleted=None, completedMax=None, showHidden=None, showCompleted=None, dueMin=None)
+ list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)
Returns all tasks in the specified task list. Args: tasklist: string, Task list identifier. (required) + showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True. + dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. dueMax: string, Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. pageToken: string, Token specifying the result page to return. Optional. updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time. - maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100. - completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False. completedMax: string, Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. + maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100. + completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False. - showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True. - dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. Returns: An object of the form: @@ -228,6 +249,13 @@Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -277,6 +305,13 @@Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -305,6 +340,13 @@Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -326,6 +368,13 @@Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -354,6 +403,13 @@Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -375,6 +431,13 @@Method Details
"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. diff --git a/docs/epy/class-tree.html b/docs/epy/class-tree.html index da4095b7f8e..ae26e2a744a 100644 --- a/docs/epy/class-tree.html +++ b/docs/epy/class-tree.html @@ -163,7 +163,7 @@Class Hierarchy
