Fix method doc signatures for multiline required parameters (#374)
* Fix method doc signatures for multiline required parameters.
Existing doc generator failed to recognize parameters as required when parameter descriptions
extended over more than one line. Besides presenting incorrect information, resulting
inconsistencies broke checks for automated sample generation.
* Regen docs
diff --git a/docs/dyn/partners_v2.users.html b/docs/dyn/partners_v2.users.html
index 18c1228..cd7bb00 100644
--- a/docs/dyn/partners_v2.users.html
+++ b/docs/dyn/partners_v2.users.html
@@ -75,20 +75,20 @@
<h1><a href="partners_v2.html">Google Partners API</a> . <a href="partners_v2.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#createCompanyRelation">createCompanyRelation(userId=None, body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p>
+ <code><a href="#createCompanyRelation">createCompanyRelation(userId, body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p>
<p class="firstline">Creates a user's company relation. Affiliates the user to a company.</p>
<p class="toc_element">
- <code><a href="#deleteCompanyRelation">deleteCompanyRelation(userId=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p>
+ <code><a href="#deleteCompanyRelation">deleteCompanyRelation(userId, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p>
<p class="firstline">Deletes a user's company relation. Unaffiliaites the user from a company.</p>
<p class="toc_element">
- <code><a href="#get">get(userId=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, userView=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p>
+ <code><a href="#get">get(userId, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, userView=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p>
<p class="firstline">Gets a user.</p>
<p class="toc_element">
<code><a href="#updateProfile">updateProfile(body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p>
<p class="firstline">Updates a user's profile. A user can only update their own profile and</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="createCompanyRelation">createCompanyRelation(userId=None, body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code>
+ <code class="details" id="createCompanyRelation">createCompanyRelation(userId, body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code>
<pre>Creates a user's company relation. Affiliates the user to a company.
Args:
@@ -99,31 +99,31 @@
{ # A CompanyRelation resource representing information about a user's
# affiliation and standing with a company in Partners.
- "managerAccount": "A String", # The AdWords manager account # associated this company.
"website": "A String", # The website URL for this company.
- "name": "A String", # The name (in the company's primary language) for the company.
- "companyId": "A String", # The ID of the company. There may be no id if this is a
- # pending company.5
- "isPending": True or False, # The flag that indicates if the company is pending verification.
- "logoUrl": "A String", # A URL to a profile photo, e.g. a G+ profile photo.
- "creationTime": "A String", # The timestamp of when affiliation was requested.
- # @OutputOnly
- "companyAdmin": True or False, # Indicates if the user is an admin for this company.
- "badgeTier": "A String", # Whether the company is a Partner.
- "state": "A String", # The state of relationship, in terms of approvals.
- "phoneNumber": "A String", # The phone number for the company's primary address.
- "address": "A String", # The primary address for this company.
- "resolvedTimestamp": "A String", # The timestamp when the user was approved.
- # @OutputOnly
- "segment": [ # The segment the company is classified as.
- "A String",
- ],
+ "managerAccount": "A String", # The AdWords manager account # associated this company.
"specializationStatus": [ # The list of Google Partners specialization statuses for the company.
{ # Agency specialization status
"badgeSpecialization": "A String", # The specialization this status is for.
"badgeSpecializationState": "A String", # State of agency specialization.
},
],
+ "companyId": "A String", # The ID of the company. There may be no id if this is a
+ # pending company.5
+ "isPending": True or False, # The flag that indicates if the company is pending verification.
+ "address": "A String", # The primary address for this company.
+ "creationTime": "A String", # The timestamp of when affiliation was requested.
+ # @OutputOnly
+ "companyAdmin": True or False, # Indicates if the user is an admin for this company.
+ "badgeTier": "A String", # Whether the company is a Partner.
+ "state": "A String", # The state of relationship, in terms of approvals.
+ "phoneNumber": "A String", # The phone number for the company's primary address.
+ "logoUrl": "A String", # A URL to a profile photo, e.g. a G+ profile photo.
+ "resolvedTimestamp": "A String", # The timestamp when the user was approved.
+ # @OutputOnly
+ "segment": [ # The segment the company is classified as.
+ "A String",
+ ],
+ "name": "A String", # The name (in the company's primary language) for the company.
}
requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
@@ -147,36 +147,36 @@
{ # A CompanyRelation resource representing information about a user's
# affiliation and standing with a company in Partners.
- "managerAccount": "A String", # The AdWords manager account # associated this company.
"website": "A String", # The website URL for this company.
- "name": "A String", # The name (in the company's primary language) for the company.
- "companyId": "A String", # The ID of the company. There may be no id if this is a
- # pending company.5
- "isPending": True or False, # The flag that indicates if the company is pending verification.
- "logoUrl": "A String", # A URL to a profile photo, e.g. a G+ profile photo.
- "creationTime": "A String", # The timestamp of when affiliation was requested.
- # @OutputOnly
- "companyAdmin": True or False, # Indicates if the user is an admin for this company.
- "badgeTier": "A String", # Whether the company is a Partner.
- "state": "A String", # The state of relationship, in terms of approvals.
- "phoneNumber": "A String", # The phone number for the company's primary address.
- "address": "A String", # The primary address for this company.
- "resolvedTimestamp": "A String", # The timestamp when the user was approved.
- # @OutputOnly
- "segment": [ # The segment the company is classified as.
- "A String",
- ],
+ "managerAccount": "A String", # The AdWords manager account # associated this company.
"specializationStatus": [ # The list of Google Partners specialization statuses for the company.
{ # Agency specialization status
"badgeSpecialization": "A String", # The specialization this status is for.
"badgeSpecializationState": "A String", # State of agency specialization.
},
],
+ "companyId": "A String", # The ID of the company. There may be no id if this is a
+ # pending company.5
+ "isPending": True or False, # The flag that indicates if the company is pending verification.
+ "address": "A String", # The primary address for this company.
+ "creationTime": "A String", # The timestamp of when affiliation was requested.
+ # @OutputOnly
+ "companyAdmin": True or False, # Indicates if the user is an admin for this company.
+ "badgeTier": "A String", # Whether the company is a Partner.
+ "state": "A String", # The state of relationship, in terms of approvals.
+ "phoneNumber": "A String", # The phone number for the company's primary address.
+ "logoUrl": "A String", # A URL to a profile photo, e.g. a G+ profile photo.
+ "resolvedTimestamp": "A String", # The timestamp when the user was approved.
+ # @OutputOnly
+ "segment": [ # The segment the company is classified as.
+ "A String",
+ ],
+ "name": "A String", # The name (in the company's primary language) for the company.
}</pre>
</div>
<div class="method">
- <code class="details" id="deleteCompanyRelation">deleteCompanyRelation(userId=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code>
+ <code class="details" id="deleteCompanyRelation">deleteCompanyRelation(userId, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code>
<pre>Deletes a user's company relation. Unaffiliaites the user from a company.
Args:
@@ -214,7 +214,7 @@
</div>
<div class="method">
- <code class="details" id="get">get(userId=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, userView=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code>
+ <code class="details" id="get">get(userId, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, userView=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code>
<pre>Gets a user.
Args:
@@ -241,19 +241,21 @@
An object of the form:
{ # A resource representing a user of the Partners platform.
+ "companyVerificationEmail": "A String", # The email address used by the user used for company verification.
+ # @OutputOnly
"profile": { # The profile information of a Partners user. # The profile information of a Partners user, contains all the directly
# editable user information.
"industries": [ # A list of ids representing which industries the user selected.
"A String",
],
- "languages": [ # The list of languages this user understands.
- "A String",
- ],
+ "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
"adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the
# preferred account and it is used when a personal account is needed. Can
# be empty.
- "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
- "markets": [ # A list of ids representing which markets the user was interested in.
+ "languages": [ # The list of languages this user understands.
+ "A String",
+ ],
+ "jobFunctions": [ # A list of ids represnting which job categories the user selected.
"A String",
],
"emailOptIns": { # A set of opt-ins for a user. # The list of opt-ins for the user, related to communication preferences.
@@ -269,7 +271,7 @@
"channels": [ # A list of ids representing which channels the user selected they were in.
"A String",
],
- "phoneNumber": "A String", # The user's phone number.
+ "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
"address": { # A location with address and geographic coordinates. May optionally contain a # The user's mailing address, contains multiple fields.
# detailed (multi-field) version of the address.
"languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
@@ -277,8 +279,7 @@
# address.
"A String",
],
- "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
- # neighborhoods or boroughs in other locations.
+ "locality": "A String", # Generally refers to the city/town portion of an address.
"sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
# classification code for sorting mail.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
@@ -326,29 +327,28 @@
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
- "locality": "A String", # Generally refers to the city/town portion of an address.
+ "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
+ # neighborhoods or boroughs in other locations.
"regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
"administrativeArea": "A String", # Top-level administrative subdivision of this country.
"address": "A String", # The single string version of the address.
"postalCode": "A String", # Values are frequently alphanumeric.
},
- "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
+ "phoneNumber": "A String", # The user's phone number.
"givenName": "A String", # The user's given name.
- "jobFunctions": [ # A list of ids represnting which job categories the user selected.
+ "markets": [ # A list of ids representing which markets the user was interested in.
"A String",
],
"profilePublic": True or False, # Whether the user's public profile is visible to anyone with the URL.
},
- "companyVerificationEmail": "A String", # The email address used by the user used for company verification.
- # @OutputOnly
"certificationStatus": [ # The list of achieved certifications. These are calculated based on exam
# results and other requirements.
# @OutputOnly
{ # A user's information on a specific certification.
- "lastAchieved": "A String", # The date the user last achieved certification.
"warning": True or False, # Whether this certification is in the state of warning.
- "expiration": "A String", # Date this certification is due to expire.
"certificationType": "A String", # The type of certification, the area of expertise.
+ "lastAchieved": "A String", # The date the user last achieved certification.
+ "expiration": "A String", # Date this certification is due to expire.
"achieved": True or False, # Whether this certification has been achieved.
},
],
@@ -359,38 +359,38 @@
# @OutputOnly
{ # Information about a particular AdWords Manager Account.
# Read more at https://support.google.com/adwords/answer/6139186
- "id": "A String", # The AdWords Manager Account id.
"customerName": "A String", # Name of the customer this account represents.
+ "id": "A String", # The AdWords Manager Account id.
},
],
"company": { # A CompanyRelation resource representing information about a user's # The company that the user is associated with.
# If not present, the user is not associated with any company.
# affiliation and standing with a company in Partners.
- "managerAccount": "A String", # The AdWords manager account # associated this company.
"website": "A String", # The website URL for this company.
- "name": "A String", # The name (in the company's primary language) for the company.
- "companyId": "A String", # The ID of the company. There may be no id if this is a
- # pending company.5
- "isPending": True or False, # The flag that indicates if the company is pending verification.
- "logoUrl": "A String", # A URL to a profile photo, e.g. a G+ profile photo.
- "creationTime": "A String", # The timestamp of when affiliation was requested.
- # @OutputOnly
- "companyAdmin": True or False, # Indicates if the user is an admin for this company.
- "badgeTier": "A String", # Whether the company is a Partner.
- "state": "A String", # The state of relationship, in terms of approvals.
- "phoneNumber": "A String", # The phone number for the company's primary address.
- "address": "A String", # The primary address for this company.
- "resolvedTimestamp": "A String", # The timestamp when the user was approved.
- # @OutputOnly
- "segment": [ # The segment the company is classified as.
- "A String",
- ],
+ "managerAccount": "A String", # The AdWords manager account # associated this company.
"specializationStatus": [ # The list of Google Partners specialization statuses for the company.
{ # Agency specialization status
"badgeSpecialization": "A String", # The specialization this status is for.
"badgeSpecializationState": "A String", # State of agency specialization.
},
],
+ "companyId": "A String", # The ID of the company. There may be no id if this is a
+ # pending company.5
+ "isPending": True or False, # The flag that indicates if the company is pending verification.
+ "address": "A String", # The primary address for this company.
+ "creationTime": "A String", # The timestamp of when affiliation was requested.
+ # @OutputOnly
+ "companyAdmin": True or False, # Indicates if the user is an admin for this company.
+ "badgeTier": "A String", # Whether the company is a Partner.
+ "state": "A String", # The state of relationship, in terms of approvals.
+ "phoneNumber": "A String", # The phone number for the company's primary address.
+ "logoUrl": "A String", # A URL to a profile photo, e.g. a G+ profile photo.
+ "resolvedTimestamp": "A String", # The timestamp when the user was approved.
+ # @OutputOnly
+ "segment": [ # The segment the company is classified as.
+ "A String",
+ ],
+ "name": "A String", # The name (in the company's primary language) for the company.
},
"lastAccessTime": "A String", # The most recent time the user interacted with the Partners site.
# @OutputOnly
@@ -433,14 +433,14 @@
"industries": [ # A list of ids representing which industries the user selected.
"A String",
],
- "languages": [ # The list of languages this user understands.
- "A String",
- ],
+ "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
"adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the
# preferred account and it is used when a personal account is needed. Can
# be empty.
- "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
- "markets": [ # A list of ids representing which markets the user was interested in.
+ "languages": [ # The list of languages this user understands.
+ "A String",
+ ],
+ "jobFunctions": [ # A list of ids represnting which job categories the user selected.
"A String",
],
"emailOptIns": { # A set of opt-ins for a user. # The list of opt-ins for the user, related to communication preferences.
@@ -456,7 +456,7 @@
"channels": [ # A list of ids representing which channels the user selected they were in.
"A String",
],
- "phoneNumber": "A String", # The user's phone number.
+ "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
"address": { # A location with address and geographic coordinates. May optionally contain a # The user's mailing address, contains multiple fields.
# detailed (multi-field) version of the address.
"languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
@@ -464,8 +464,7 @@
# address.
"A String",
],
- "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
- # neighborhoods or boroughs in other locations.
+ "locality": "A String", # Generally refers to the city/town portion of an address.
"sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
# classification code for sorting mail.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
@@ -513,15 +512,16 @@
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
- "locality": "A String", # Generally refers to the city/town portion of an address.
+ "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
+ # neighborhoods or boroughs in other locations.
"regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
"administrativeArea": "A String", # Top-level administrative subdivision of this country.
"address": "A String", # The single string version of the address.
"postalCode": "A String", # Values are frequently alphanumeric.
},
- "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
+ "phoneNumber": "A String", # The user's phone number.
"givenName": "A String", # The user's given name.
- "jobFunctions": [ # A list of ids represnting which job categories the user selected.
+ "markets": [ # A list of ids representing which markets the user was interested in.
"A String",
],
"profilePublic": True or False, # Whether the user's public profile is visible to anyone with the URL.
@@ -550,14 +550,14 @@
"industries": [ # A list of ids representing which industries the user selected.
"A String",
],
- "languages": [ # The list of languages this user understands.
- "A String",
- ],
+ "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
"adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the
# preferred account and it is used when a personal account is needed. Can
# be empty.
- "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
- "markets": [ # A list of ids representing which markets the user was interested in.
+ "languages": [ # The list of languages this user understands.
+ "A String",
+ ],
+ "jobFunctions": [ # A list of ids represnting which job categories the user selected.
"A String",
],
"emailOptIns": { # A set of opt-ins for a user. # The list of opt-ins for the user, related to communication preferences.
@@ -573,7 +573,7 @@
"channels": [ # A list of ids representing which channels the user selected they were in.
"A String",
],
- "phoneNumber": "A String", # The user's phone number.
+ "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
"address": { # A location with address and geographic coordinates. May optionally contain a # The user's mailing address, contains multiple fields.
# detailed (multi-field) version of the address.
"languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
@@ -581,8 +581,7 @@
# address.
"A String",
],
- "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
- # neighborhoods or boroughs in other locations.
+ "locality": "A String", # Generally refers to the city/town portion of an address.
"sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
# classification code for sorting mail.
"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
@@ -630,15 +629,16 @@
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
- "locality": "A String", # Generally refers to the city/town portion of an address.
+ "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
+ # neighborhoods or boroughs in other locations.
"regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
"administrativeArea": "A String", # Top-level administrative subdivision of this country.
"address": "A String", # The single string version of the address.
"postalCode": "A String", # Values are frequently alphanumeric.
},
- "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
+ "phoneNumber": "A String", # The user's phone number.
"givenName": "A String", # The user's given name.
- "jobFunctions": [ # A list of ids represnting which job categories the user selected.
+ "markets": [ # A list of ids representing which markets the user was interested in.
"A String",
],
"profilePublic": True or False, # Whether the user's public profile is visible to anyone with the URL.