fix: 'requests' field of CreateUserLink, UpdateUserLink, DeleteUserLink methods is now required

docs: minor documentation updates

PiperOrigin-RevId: 340922897
pull/628/head
Google APIs 4 years ago committed by Copybara-Service
parent 7b75aa9066
commit b365fff50d
  1. 43
      google/analytics/admin/v1alpha/analytics_admin.proto
  2. 216
      google/analytics/admin/v1alpha/resources.proto

@ -841,8 +841,8 @@ message CreateUserLinkRequest {
}
];
// Optional. If notify_new_user is set, then email new user that they've been given
// permissions on the resource.
// Optional. If set, then email the new user notifying them that they've been granted
// permissions to the resource.
bool notify_new_user = 2 [(google.api.field_behavior) = OPTIONAL];
// Required. The user link to create.
@ -855,15 +855,21 @@ message BatchCreateUserLinksRequest {
// This field is required. The parent field in the CreateUserLinkRequest
// messages must either be empty or match this field.
// Example format: accounts/1234
string parent = 1 [(google.api.field_behavior) = REQUIRED];
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/UserLink"
}
];
// Optional. If notify_new_users is set, then email new users that they've been given
// permissions on the resource.
// Optional. If set, then email the new users notifying them that they've been granted
// permissions to the resource. Regardless of whether this is set or not,
// notify_new_user field inside each individual request is ignored.
bool notify_new_users = 2 [(google.api.field_behavior) = OPTIONAL];
// The requests specifying the user links to create.
// Required. The requests specifying the user links to create.
// A maximum of 1000 user links can be created in a batch.
repeated CreateUserLinkRequest requests = 3;
repeated CreateUserLinkRequest requests = 3 [(google.api.field_behavior) = REQUIRED];
}
// Response message for BatchCreateUserLinks RPC.
@ -884,11 +890,16 @@ message BatchUpdateUserLinksRequest {
// for. The parent field in the UpdateUserLinkRequest messages must either be
// empty or match this field.
// Example format: accounts/1234
string parent = 1 [(google.api.field_behavior) = REQUIRED];
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/UserLink"
}
];
// The requests specifying the user links to update.
// Required. The requests specifying the user links to update.
// A maximum of 1000 user links can be updated in a batch.
repeated UpdateUserLinkRequest requests = 2;
repeated UpdateUserLinkRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
}
// Response message for BatchUpdateUserLinks RPC.
@ -914,11 +925,16 @@ message BatchDeleteUserLinksRequest {
// for. The parent of all values for user link names to delete must match this
// field.
// Example format: accounts/1234
string parent = 1 [(google.api.field_behavior) = REQUIRED];
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/UserLink"
}
];
// The requests specifying the user links to update.
// Required. The requests specifying the user links to update.
// A maximum of 1000 user links can be updated in a batch.
repeated DeleteUserLinkRequest requests = 2;
repeated DeleteUserLinkRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for GetWebDataStream RPC.
@ -1182,6 +1198,7 @@ message ListAndroidAppDataStreamsResponse {
message GetEnhancedMeasurementSettingsRequest {
// Required. The name of the settings to lookup.
// Format:
//
// properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings
// Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
string name = 1 [

@ -26,6 +26,111 @@ option java_multiple_files = true;
option java_outer_classname = "ResourcesProto";
option java_package = "com.google.analytics.admin.v1alpha";
// Maximum access settings that Firebase user receive on the linked Analytics
// property.
enum MaximumUserAccess {
// Unspecified maximum user access.
MAXIMUM_USER_ACCESS_UNSPECIFIED = 0;
// Firebase users have no access to the Analytics property.
NO_ACCESS = 1;
// Firebase users have Read & Analyze access to the Analytics property.
READ_AND_ANALYZE = 2;
// Firebase users have edit access to the Analytics property, but may not
// manage the Firebase link.
EDITOR_WITHOUT_LINK_MANAGEMENT = 3;
// Firebase users have edit access to the Analytics property and may manage
// the Firebase link.
EDITOR_INCLUDING_LINK_MANAGEMENT = 4;
}
// The category selected for this property, used for industry benchmarking.
enum IndustryCategory {
// Industry category unspecified
INDUSTRY_CATEGORY_UNSPECIFIED = 0;
// Automotive
AUTOMOTIVE = 1;
// Business and industrial markets
BUSINESS_AND_INDUSTRIAL_MARKETS = 2;
// Finance
FINANCE = 3;
// Healthcare
HEALTHCARE = 4;
// Technology
TECHNOLOGY = 5;
// Travel
TRAVEL = 6;
// Other
OTHER = 7;
// Arts and entertainment
ARTS_AND_ENTERTAINMENT = 8;
// Beauty and fitness
BEAUTY_AND_FITNESS = 9;
// Books and literature
BOOKS_AND_LITERATURE = 10;
// Food and drink
FOOD_AND_DRINK = 11;
// Games
GAMES = 12;
// Hobbies and leisure
HOBBIES_AND_LEISURE = 13;
// Home and garden
HOME_AND_GARDEN = 14;
// Internet and telecom
INTERNET_AND_TELECOM = 15;
// Law and government
LAW_AND_GOVERNMENT = 16;
// News
NEWS = 17;
// Online communities
ONLINE_COMMUNITIES = 18;
// People and society
PEOPLE_AND_SOCIETY = 19;
// Pets and animals
PETS_AND_ANIMALS = 20;
// Real estate
REAL_ESTATE = 21;
// Reference
REFERENCE = 22;
// Science
SCIENCE = 23;
// Sports
SPORTS = 24;
// Jobs and education
JOBS_AND_EDUCATION = 25;
// Shopping
SHOPPING = 26;
}
// A resource message representing a Google Analytics account.
message Account {
option (google.api.resource) = {
@ -48,7 +153,10 @@ message Account {
string display_name = 4 [(google.api.field_behavior) = REQUIRED];
// Country of business. Must be a non-deprecated code for a UN M.49 region.
// https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html
//
// https:
// //unicode.org/cldr/charts/latest/supplem
// // ental/territory_containment_un_m_49.html
string country_code = 5;
// Output only. Indicates whether this Account is soft-deleted or not. Deleted
@ -280,6 +388,7 @@ message EnhancedMeasurementSettings {
// Output only. Resource name of this Data Stream.
// Format:
//
// properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings
// Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
@ -465,111 +574,6 @@ message DataSharingSettings {
bool sharing_with_others_enabled = 6;
}
// The category selected for this property, used for industry benchmarking.
enum IndustryCategory {
// Industry category unspecified
INDUSTRY_CATEGORY_UNSPECIFIED = 0;
// Automotive
AUTOMOTIVE = 1;
// Business and industrial markets
BUSINESS_AND_INDUSTRIAL_MARKETS = 2;
// Finance
FINANCE = 3;
// Healthcare
HEALTHCARE = 4;
// Technology
TECHNOLOGY = 5;
// Travel
TRAVEL = 6;
// Other
OTHER = 7;
// Arts and entertainment
ARTS_AND_ENTERTAINMENT = 8;
// Beauty and fitness
BEAUTY_AND_FITNESS = 9;
// Books and literature
BOOKS_AND_LITERATURE = 10;
// Food and drink
FOOD_AND_DRINK = 11;
// Games
GAMES = 12;
// Hobbies and leisure
HOBBIES_AND_LEISURE = 13;
// Home and garden
HOME_AND_GARDEN = 14;
// Internet and telecom
INTERNET_AND_TELECOM = 15;
// Law and government
LAW_AND_GOVERNMENT = 16;
// News
NEWS = 17;
// Online communities
ONLINE_COMMUNITIES = 18;
// People and society
PEOPLE_AND_SOCIETY = 19;
// Pets and animals
PETS_AND_ANIMALS = 20;
// Real estate
REAL_ESTATE = 21;
// Reference
REFERENCE = 22;
// Science
SCIENCE = 23;
// Sports
SPORTS = 24;
// Jobs and education
JOBS_AND_EDUCATION = 25;
// Shopping
SHOPPING = 26;
}
// Maximum access settings that Firebase user receive on the linked Analytics
// property.
enum MaximumUserAccess {
// Unspecified maximum user access.
MAXIMUM_USER_ACCESS_UNSPECIFIED = 0;
// Firebase users have no access to the Analytics property.
NO_ACCESS = 1;
// Firebase users have Read & Analyze access to the Analytics property.
READ_AND_ANALYZE = 2;
// Firebase users have edit access to the Analytics property, but may not
// manage the Firebase link.
EDITOR_WITHOUT_LINK_MANAGEMENT = 3;
// Firebase users have edit access to the Analytics property and may manage
// the Firebase link.
EDITOR_INCLUDING_LINK_MANAGEMENT = 4;
}
// A virtual resource representing an overview of an account and
// all its child GA4 properties.
message AccountSummary {

Loading…
Cancel
Save