Google Business Performance API has a
NEW API method that allows fetching multiple `DailyMetrics` in a single API request. Review the
deprecation schedule and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
Method: accounts.invitations.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists pending invitations for the specified account.
HTTP request
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/invitations
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
parent |
string
The name of the account from which the list of invitations is being retrieved.
|
Query parameters
Parameters |
targetType |
enum (TargetType )
Specifies which target types should appear in the response.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for AccessControl.ListInvitations.
JSON representation |
{
"invitations": [
{
object (Invitation )
}
]
} |
Fields |
invitations[] |
object (Invitation )
A collection of location invitations that are pending for the account. The number of invitations listed here cannot exceed 1000.
|
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
For more information, see the OAuth 2.0 Overview.
TargetType
The type of target an invitation is for.
Enums |
ALL |
List invitations for all target types. This is the default. |
ACCOUNTS_ONLY |
List invitations only for targets of type Account. |
LOCATIONS_ONLY |
List invitations only for targets of type Location. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-16 UTC."],[[["This endpoint retrieves pending invitations for a specified Google My Business account."],["It allows filtering by target type (Account or Location) using the `targetType` query parameter."],["The response includes a list of invitations with details, limited to a maximum of 1000."],["Authorization is required using specific OAuth scopes related to business management."],["This endpoint is deprecated; consider using the Account Management API instead."]]],["This document outlines the process of listing pending invitations for a specified account using the deprecated API. It uses a `GET` request to `https://mybusiness.googleapis.com/v4/{parent=accounts/*}/invitations`. The `parent` path parameter specifies the account. The `targetType` query parameter filters invitation types. An empty request body is required. The response returns a JSON array of `invitations`, each represented as an object. The request needs either the `plus.business.manage` or `business.manage` authorization scope. Three types are available: ALL, ACCOUNTS_ONLY and LOCATIONS_ONLY.\n"]]