Skip to content
This repository was archived by the owner on Sep 19, 2023. It is now read-only.

Commit f55c2bf

Browse files
feat!: added ListAccountSummaries method (#40)
PiperOrigin-RevId: 336969301 Source-Author: Google APIs <noreply@google.com> Source-Date: Tue Oct 13 15:33:17 2020 -0700 Source-Repo: googleapis/googleapis Source-Sha: 71088f11302e80aae77751d5a915dd2e8b684ec8 Source-Link: googleapis/googleapis@71088f1
1 parent 59d3662 commit f55c2bf

9 files changed

Lines changed: 4095 additions & 2034 deletions

File tree

protos/google/analytics/admin/v1alpha/analytics_admin.proto

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,13 @@ service AnalyticsAdminService {
9494
};
9595
}
9696

97+
// Returns summaries of all accounts accessible by the caller.
98+
rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse) {
99+
option (google.api.http) = {
100+
get: "/v1alpha/accountSummaries"
101+
};
102+
}
103+
97104
// Lookup for a single "App+Web" Property.
98105
//
99106
// Throws "Target not found" if no such property found, if property is not
@@ -1342,3 +1349,28 @@ message GetDataSharingSettingsRequest {
13421349
}
13431350
];
13441351
}
1352+
1353+
// Request message for ListAccountSummaries RPC.
1354+
message ListAccountSummariesRequest {
1355+
// The maximum number of AccountSummary resources to return. The service may
1356+
// return fewer than this value, even if there are additional pages.
1357+
// If unspecified, at most 50 resources will be returned.
1358+
// The maximum value is 200; (higher values will be coerced to the maximum)
1359+
int32 page_size = 1;
1360+
1361+
// A page token, received from a previous `ListAccountSummaries` call.
1362+
// Provide this to retrieve the subsequent page.
1363+
// When paginating, all other parameters provided to `ListAccountSummaries`
1364+
// must match the call that provided the page token.
1365+
string page_token = 2;
1366+
}
1367+
1368+
// Response message for ListAccountSummaries RPC.
1369+
message ListAccountSummariesResponse {
1370+
// Account summaries of all accounts the caller has access to.
1371+
repeated AccountSummary account_summaries = 1;
1372+
1373+
// A token, which can be sent as `page_token` to retrieve the next page.
1374+
// If this field is omitted, there are no subsequent pages.
1375+
string next_page_token = 2;
1376+
}

protos/google/analytics/admin/v1alpha/resources.proto

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -569,3 +569,43 @@ enum MaximumUserAccess {
569569
// the Firebase link.
570570
EDITOR_INCLUDING_LINK_MANAGEMENT = 4;
571571
}
572+
573+
// A virtual resource representing an overview of an account and
574+
// all its child App+Web properties.
575+
message AccountSummary {
576+
option (google.api.resource) = {
577+
type: "analyticsadmin.googleapis.com/AccountSummary"
578+
pattern: "accountSummaries/{account_summary}"
579+
};
580+
581+
// Resource name for this account summary.
582+
// Format: accountSummaries/{account_id}
583+
// Example: "accountSummaries/1000"
584+
string name = 1;
585+
586+
// Resource name of account referred to by this account summary
587+
// Format: accounts/{account_id}
588+
// Example: "accounts/1000"
589+
string account = 2 [(google.api.resource_reference) = {
590+
type: "analyticsadmin.googleapis.com/Account"
591+
}];
592+
593+
// Display name for the account referred to in this account summary.
594+
string display_name = 3;
595+
596+
// List of summaries for child accounts of this account.
597+
repeated PropertySummary property_summaries = 4;
598+
}
599+
600+
// A virtual resource representing metadata for an App+Web property.
601+
message PropertySummary {
602+
// Resource name of property referred to by this property summary
603+
// Format: properties/{property_id}
604+
// Example: "properties/1000"
605+
string property = 1 [(google.api.resource_reference) = {
606+
type: "analyticsadmin.googleapis.com/Property"
607+
}];
608+
609+
// Display name for the property referred to in this account summary.
610+
string display_name = 2;
611+
}

protos/protos.d.ts

Lines changed: 417 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

protos/protos.js

Lines changed: 2991 additions & 2031 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

protos/protos.json

Lines changed: 75 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)