accept(name, body=None, x__xgafv=None)

Accepts the specified invitation.

Args:
  name: string, Required. The name of the invitation that is being accepted. `accounts/{account_id}/invitations/{invitation_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AccessControl.AcceptInvitation.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}

close()

Close httplib2 connections.

decline(name, body=None, x__xgafv=None)

Declines the specified invitation.

Args:
  name: string, Required. The name of the account invitation that is being declined. `accounts/{account_id}/invitations/{invitation_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AccessControl.DeclineInvitation.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}

list(parent, filter=None, x__xgafv=None)

Lists pending invitations for the specified account.

Args:
parent: string, Required. The name of the account from which the list of invitations is being retrieved. `accounts/{account_id}/invitations` (required)
filter: string, Optional. Filtering the response is supported via the Invitation.target_type field.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for AccessControl.ListInvitations.
"invitations": [ # A collection of invitations that are pending for the account. The number of invitations listed here cannot exceed 1000.
{ # Represents a pending invitation.
"name": "A String", # Required. The resource name for the invitation. `accounts/{account_id}/invitations/{invitation_id}`.
"role": "A String", # Output only. The invited role on the account.
"targetAccount": { # An account is a container for your location. If you are the only user who manages locations for your business, you can use your personal Google Account. To share management of locations with multiple users, [create a business account] (https://support.google.com/business/answer/6085339?ref_topic=6085325). # The sparsely populated account this invitation is for.
"accountName": "A String", # Required. The name of the account. For an account of type `PERSONAL`, this is the first and last name of the user account.
"accountNumber": "A String", # Output only. Account reference number if provisioned.
"name": "A String", # Immutable. The resource name, in the format `accounts/{account_id}`.
"organizationInfo": { # Additional information stored for an organization. # Output only. Additional info for an organization. This is populated only for an organization account.
"address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Output only. The postal address for the account.
"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
"A String",
],
"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
"organization": "A String", # Optional. The name of the organization at the address.
"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
"recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
"A String",
],
"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
},
"phoneNumber": "A String", # Output only. The contact number for the organization.
"registeredDomain": "A String", # Output only. The registered domain for the account.
},
"permissionLevel": "A String", # Output only. Specifies the permission level the user has for this account.
"primaryOwner": "A String", # Required. Input only. The resource name of the account which will be the primary owner of the account being created. It should be of the form `accounts/{account_id}/`.
"role": "A String", # Output only. Specifies the AccountRole of this account.
"type": "A String", # Required. Contains the type of account. Accounts of type PERSONAL and ORGANIZATION cannot be created using this API.
"verificationState": "A String", # Output only. If verified, future locations that are created are automatically connected to Google Maps, and have Google+ pages created, without requiring moderation.
"vettedState": "A String", # Output only. Indicates whether the account is vetted by Google. A vetted account is able to verify locations via the VETTED_PARTNER method.
},
"targetLocation": { # Represents a target location for a pending invitation. # The target location this invitation is for.
"address": "A String", # The address of the location to which the user is invited.
"locationName": "A String", # The name of the location to which the user is invited.
},
"targetType": "A String", # Output only. Specifies which target types should appear in the response.
},
],
}

My Business Account Management API . accounts . invitations

Instance Methods

Method Details