Skip to content

Commit 781d34e

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
feat: Add ProvisionCloudIdentity API definitions for Cloud Channel API. Update documentation for other APIs.
PiperOrigin-RevId: 350209421
1 parent ad3bb00 commit 781d34e

7 files changed

Lines changed: 196 additions & 140 deletions

File tree

‎google/cloud/channel/v1/channel_partner_links.proto‎

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,39 @@ option java_multiple_files = true;
2626
option java_outer_classname = "ChannelPartnerLinksProto";
2727
option java_package = "com.google.cloud.channel.v1";
2828

29+
// The level of granularity the [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] will display.
30+
enum ChannelPartnerLinkView {
31+
// The default / unset value.
32+
// The API will default to the BASIC view.
33+
UNSPECIFIED = 0;
34+
35+
// Includes all fields except the
36+
// [ChannelPartnerLink.channel_partner_cloud_identity_info][google.cloud.channel.v1.ChannelPartnerLink.channel_partner_cloud_identity_info].
37+
BASIC = 1;
38+
39+
// Includes all fields.
40+
FULL = 2;
41+
}
42+
43+
// ChannelPartnerLinkState represents state of a channel partner link.
44+
enum ChannelPartnerLinkState {
45+
// The state is not specified.
46+
CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED = 0;
47+
48+
// An invitation has been sent to the reseller to create a channel partner
49+
// link.
50+
INVITED = 1;
51+
52+
// Status when the reseller is active.
53+
ACTIVE = 2;
54+
55+
// Status when the reseller has been revoked by the distributor.
56+
REVOKED = 3;
57+
58+
// Status when the reseller is suspended by Google or distributor.
59+
SUSPENDED = 4;
60+
}
61+
2962
// Entity representing a link between distributors and their indirect
3063
// resellers in an n-tier resale channel.
3164
message ChannelPartnerLink {
@@ -55,22 +88,3 @@ message ChannelPartnerLink {
5588
// Output only. Cloud Identity info of the channel partner (IR).
5689
CloudIdentityInfo channel_partner_cloud_identity_info = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
5790
}
58-
59-
// ChannelPartnerLinkState represents state of a channel partner link.
60-
enum ChannelPartnerLinkState {
61-
// The state is not specified.
62-
CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED = 0;
63-
64-
// An invitation has been sent to the reseller to create a channel partner
65-
// link.
66-
INVITED = 1;
67-
68-
// Status when the reseller is active.
69-
ACTIVE = 2;
70-
71-
// Status when the reseller has been revoked by the distributor.
72-
REVOKED = 3;
73-
74-
// Status when the reseller is suspended by Google or distributor.
75-
SUSPENDED = 4;
76-
}

‎google/cloud/channel/v1/common.proto‎

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ option java_package = "com.google.cloud.channel.v1";
2929
message EduData {
3030
// Enum to specify the institute type.
3131
enum InstituteType {
32-
// Default value. This state is never returned unless an error occurs.
32+
// Default value. This state doesn't show unless an error occurs.
3333
INSTITUTE_TYPE_UNSPECIFIED = 0;
3434

35-
// Elementary/ Secondary Schools & Districts
35+
// Elementary/Secondary Schools & Districts
3636
K12 = 1;
3737

3838
// Higher Education Universities & Colleges
3939
UNIVERSITY = 2;
4040
}
4141

42-
// Number of students/staff the institute has.
42+
// Number of students and staff the institute has.
4343
enum InstituteSize {
44-
// Default value. This state is never returned unless an error occurs.
44+
// Default value. This state doesn't show unless an error occurs.
4545
INSTITUTE_SIZE_UNSPECIFIED = 0;
4646

4747
// 1 - 100
@@ -80,7 +80,7 @@ message EduData {
8080
message CloudIdentityInfo {
8181
// CustomerType of the customer
8282
enum CustomerType {
83-
// Default value. This state is never returned unless an error occurs.
83+
// Default value. This state doesn't show unless an error occurs.
8484
CUSTOMER_TYPE_UNSPECIFIED = 0;
8585

8686
// Domain-owning customer which needs domain verification to use services.
@@ -96,6 +96,9 @@ message CloudIdentityInfo {
9696
// Output only. The primary domain name.
9797
string primary_domain = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
9898

99+
// Whether the domain is verified.
100+
bool is_domain_verified = 4;
101+
99102
// The alternate email.
100103
string alternate_email = 6;
101104

@@ -129,3 +132,15 @@ message Value {
129132
google.protobuf.Any proto_value = 4;
130133
}
131134
}
135+
136+
// Information needed to create an Admin User for Google Workspace.
137+
message AdminUser {
138+
// Primary email of the admin user.
139+
string email = 1;
140+
141+
// Given name of the admin user.
142+
string given_name = 2;
143+
144+
// Family name of the admin user.
145+
string family_name = 3;
146+
}

‎google/cloud/channel/v1/entitlements.proto‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ option java_multiple_files = true;
3030
option java_outer_classname = "EntitlementsProto";
3131
option java_package = "com.google.cloud.channel.v1";
3232

33-
// An entitlement represents an entity which provides a customer means to start
34-
// using a service.
33+
// An entitlement is a representation of a customer's ability to use a service.
3534
message Entitlement {
3635
option (google.api.resource) = {
3736
type: "cloudchannel.googleapis.com/Entitlement"
@@ -40,7 +39,7 @@ message Entitlement {
4039

4140
// Indicates the current provisioning state of the entitlement.
4241
enum ProvisioningState {
43-
// Default value. This state is never returned unless an error occurs.
42+
// Default value. This state doesn't show unless an error occurs.
4443
PROVISIONING_STATE_UNSPECIFIED = 0;
4544

4645
// The entitlement is currently active.
@@ -52,7 +51,7 @@ message Entitlement {
5251

5352
// Suspension reason for an entitlement if [provisioning_state][google.cloud.channel.v1.Entitlement.provisioning_state] = SUSPENDED.
5453
enum SuspensionReason {
55-
// Default value. This state is never returned unless an error occurs.
54+
// Default value. This state doesn't show unless an error occurs.
5655
SUSPENSION_REASON_UNSPECIFIED = 0;
5756

5857
// Entitlement was manually suspended by the Reseller.

‎google/cloud/channel/v1/offers.proto‎

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,13 @@ enum PromotionalOrderType {
3434
// Not used.
3535
PROMOTIONAL_TYPE_UNSPECIFIED = 0;
3636

37-
// Order used for net new customers, trial conversions and upgrades.
37+
// Order used for new customers, trial conversions and upgrades.
3838
NEW_UPGRADE = 1;
3939

40-
// All orders for an existing customer transferring to the reseller.
40+
// All orders for transferring an existing customer.
4141
TRANSFER = 2;
4242

43-
// Orders for an existing customer switching from one promotion to another
44-
// (can be addition/removal of a promotion as well) on the same sku.
43+
// Orders for modifying an existing customer's promotion on the same SKU.
4544
PROMOTION_SWITCH = 3;
4645
}
4746

@@ -78,10 +77,9 @@ enum PaymentType {
7877
POSTPAY = 2;
7978
}
8079

81-
// Represents monetizable resource's type.
82-
// A monetizable resource is an entity on which billing happens. For example,
83-
// this could be MINUTES for Google Voice and GB for Google Drive. One SKU can
84-
// map to multiple monetizable resources.
80+
// Represents the type for a monetizable resource(any entity on which billing
81+
// happens). For example, this could be MINUTES for Google Voice and GB for
82+
// Google Drive. One SKU can map to multiple monetizable resources.
8583
enum ResourceType {
8684
// Not used.
8785
RESOURCE_TYPE_UNSPECIFIED = 0;
@@ -211,13 +209,11 @@ message ParameterDefinition {
211209

212210
// Represents the constraints for buying the Offer.
213211
message Constraints {
214-
// Represents constraints on a customer required for purchasing this Offer
215-
// for that customer.
212+
// Represents constraints required to purchase the Offer for a customer.
216213
CustomerConstraints customer_constraints = 1;
217214
}
218215

219-
// Represents constraints on a customer required for purchasing this Offer for
220-
// that customer.
216+
// Represents constraints required to purchase the Offer for a customer.
221217
message CustomerConstraints {
222218
// Allowed geographical regions of the customer.
223219
repeated string allowed_regions = 1;
@@ -229,7 +225,7 @@ message CustomerConstraints {
229225
repeated PromotionalOrderType promotional_order_types = 3;
230226
}
231227

232-
// The payment plan for the Offer, describing how a payment is made.
228+
// The payment plan for the Offer. Describes how to make a payment.
233229
message Plan {
234230
// Describes how a reseller will be billed.
235231
PaymentPlan payment_plan = 1;
@@ -242,11 +238,11 @@ message Plan {
242238
Period payment_cycle = 3;
243239

244240
// Present for Offers with a trial period.
245-
// For trial-only Offers, a paid service needs to be started before the trial
241+
// For trial-only Offers, a paid service needs to start before the trial
246242
// period ends for continued service.
247-
// For Regular Offers with an initial trial period, the regular pricing will
248-
// take effect after the trial period ends, or if paid service is started
249-
// before the end of the trial period.
243+
// For Regular Offers with a trial period, the regular pricing goes into
244+
// effect when trial period ends, or if paid service is started before the end
245+
// of the trial period.
250246
Period trial_period = 4;
251247
}
252248

@@ -279,8 +275,8 @@ message Price {
279275
}
280276

281277
// Specifies the price by the duration of months.
282-
// For example, for the first 6 months, 20% discount. From the seventh month,
283-
// 10% discount.
278+
// For example, a 20% discount for the first six months, then a 10% discount
279+
// starting on the seventh month.
284280
message PricePhase {
285281
// Defines the phase period type.
286282
PeriodType period_type = 1;
@@ -300,9 +296,11 @@ message PricePhase {
300296

301297
// Defines price at resource tier level.
302298
// For example, an offer with following definition :
303-
// Tier 1: Provide 25% discount for all seats between 1 and 25.
304-
// Tier 2: Provide 10% discount for all seats between 26 and 100.
305-
// Tier 3: Provide flat 15% discount for all seats above 100.
299+
//
300+
// * Tier 1: Provide 25% discount for all seats between 1 and 25.
301+
// * Tier 2: Provide 10% discount for all seats between 26 and 100.
302+
// * Tier 3: Provide flat 15% discount for all seats above 100.
303+
//
306304
// Each of these tiers is represented as a PriceTier.
307305
message PriceTier {
308306
// First resource for which the tier price applies.

‎google/cloud/channel/v1/operations.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ option java_package = "com.google.cloud.channel.v1";
2727
message OperationMetadata {
2828
// RPCs that return a Long Running Operation.
2929
enum OperationType {
30-
// Default value. This state is never returned unless an error occurs.
30+
// Default value. This state doesn't show unless an error occurs.
3131
OPERATION_TYPE_UNSPECIFIED = 0;
3232

3333
// Long Running Operation was triggered by CreateEntitlement.

‎google/cloud/channel/v1/products.proto‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,8 @@ enum MediaType {
3333
MEDIA_TYPE_IMAGE = 1;
3434
}
3535

36-
// Product is the entity that the customer is entitled to use when an order is
37-
// placed.
38-
// Example of products are Google Workspace, Google Voice, etc.
36+
// A Product is the entity a customer uses when placing an order. For example,
37+
// Google Workspace, Google Voice, etc.
3938
message Product {
4039
option (google.api.resource) = {
4140
type: "cloudchannel.googleapis.com/Product"
@@ -50,10 +49,10 @@ message Product {
5049
MarketingInfo marketing_info = 2;
5150
}
5251

53-
// Represents a purchasable Stock Keeping Unit (SKU) under a product.
52+
// Represents a product's purchasable Stock Keeping Unit (SKU).
5453
// SKUs represent the different variations of the product. For example, Google
55-
// Workspace Business Standard, Google Workspace Business Plus are SKUs of
56-
// Google Workspace product.
54+
// Workspace Business Standard and Google Workspace Business Plus are Google
55+
// Workspace product SKUs.
5756
message Sku {
5857
option (google.api.resource) = {
5958
type: "cloudchannel.googleapis.com/Sku"
@@ -71,7 +70,7 @@ message Sku {
7170
Product product = 3;
7271
}
7372

74-
// Represents a Product/SKU/Offer's marketing information.
73+
// Represents the marketing information for a Product, SKU or Offer.
7574
message MarketingInfo {
7675
// Human readable name.
7776
string display_name = 1;

0 commit comments

Comments
 (0)