Skip to content
This repository has been archived by the owner on Dec 31, 2023. It is now read-only.

docs: Fix formatting of request arg in docstring #335

Merged
merged 2 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -490,8 +490,7 @@ async def sample_list_accounts():

Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.ListAccountsRequest, dict]]):
The request object. Request message for ListAccounts
RPC.
The request object. Request message for ListAccounts RPC.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1597,8 +1596,8 @@ async def sample_batch_get_user_links():

Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.BatchGetUserLinksRequest, dict]]):
The request object. Request message for
BatchGetUserLinks RPC.
The request object. Request message for BatchGetUserLinks
RPC.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1903,14 +1902,16 @@ async def sample_create_user_link():
request (Optional[Union[google.analytics.admin_v1alpha.types.CreateUserLinkRequest, dict]]):
The request object. Request message for CreateUserLink
RPC.
Users can have multiple email addresses associated with
their Google account, and one of these email addresses
is the "primary" email address. Any of the email
addresses associated with a Google account may be used
for a new UserLink, but the returned UserLink will
always contain the "primary" email address. As a result,
the input and output email address for this request may
differ.
Users can have multiple email addresses
associated with their Google account,
and one of these email addresses is the
"primary" email address. Any of the
email addresses associated with a Google
account may be used for a new UserLink,
but the returned UserLink will always
contain the "primary" email address. As
a result, the input and output email
address for this request may differ.
parent (:class:`str`):
Required. Example format:
accounts/1234
Expand Down Expand Up @@ -2668,8 +2669,8 @@ async def sample_list_firebase_links():

Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.ListFirebaseLinksRequest, dict]]):
The request object. Request message for
ListFirebaseLinks RPC
The request object. Request message for ListFirebaseLinks
RPC
parent (:class:`str`):
Required. Format: properties/{property_id} Example:
properties/1234
Expand Down Expand Up @@ -5424,7 +5425,8 @@ async def sample_get_display_video360_advertiser_link_proposal():
Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.GetDisplayVideo360AdvertiserLinkProposalRequest, dict]]):
The request object. Request message for
GetDisplayVideo360AdvertiserLinkProposal RPC.
GetDisplayVideo360AdvertiserLinkProposal
RPC.
name (:class:`str`):
Required. The name of the
DisplayVideo360AdvertiserLinkProposal to
Expand Down Expand Up @@ -5543,7 +5545,8 @@ async def sample_list_display_video360_advertiser_link_proposals():
Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinkProposalsRequest, dict]]):
The request object. Request message for
ListDisplayVideo360AdvertiserLinkProposals RPC.
ListDisplayVideo360AdvertiserLinkProposals
RPC.
parent (:class:`str`):
Required. Example format:
properties/1234
Expand Down Expand Up @@ -5666,7 +5669,8 @@ async def sample_create_display_video360_advertiser_link_proposal():
Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.CreateDisplayVideo360AdvertiserLinkProposalRequest, dict]]):
The request object. Request message for
CreateDisplayVideo360AdvertiserLinkProposal RPC.
CreateDisplayVideo360AdvertiserLinkProposal
RPC.
parent (:class:`str`):
Required. Example format:
properties/1234
Expand Down Expand Up @@ -5791,7 +5795,8 @@ async def sample_delete_display_video360_advertiser_link_proposal():
Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteDisplayVideo360AdvertiserLinkProposalRequest, dict]]):
The request object. Request message for
DeleteDisplayVideo360AdvertiserLinkProposal RPC.
DeleteDisplayVideo360AdvertiserLinkProposal
RPC.
name (:class:`str`):
Required. The name of the
DisplayVideo360AdvertiserLinkProposal to
Expand Down Expand Up @@ -5895,7 +5900,8 @@ async def sample_approve_display_video360_advertiser_link_proposal():
Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.ApproveDisplayVideo360AdvertiserLinkProposalRequest, dict]]):
The request object. Request message for
ApproveDisplayVideo360AdvertiserLinkProposal RPC.
ApproveDisplayVideo360AdvertiserLinkProposal
RPC.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -5987,7 +5993,8 @@ async def sample_cancel_display_video360_advertiser_link_proposal():
Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.CancelDisplayVideo360AdvertiserLinkProposalRequest, dict]]):
The request object. Request message for
CancelDisplayVideo360AdvertiserLinkProposal RPC.
CancelDisplayVideo360AdvertiserLinkProposal
RPC.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -6852,8 +6859,8 @@ async def sample_list_custom_metrics():

Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.ListCustomMetricsRequest, dict]]):
The request object. Request message for
ListCustomMetrics RPC.
The request object. Request message for ListCustomMetrics
RPC.
parent (:class:`str`):
Required. Example format:
properties/1234
Expand Down Expand Up @@ -10774,7 +10781,8 @@ async def sample_set_automated_ga4_configuration_opt_out():
Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.SetAutomatedGa4ConfigurationOptOutRequest, dict]]):
The request object. Request for setting the opt out
status for the automated GA4 setup process.
status for the automated GA4 setup
process.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -10853,7 +10861,8 @@ async def sample_fetch_automated_ga4_configuration_opt_out():
Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.FetchAutomatedGa4ConfigurationOptOutRequest, dict]]):
The request object. Request for fetching the opt out
status for the automated GA4 setup process.
status for the automated GA4 setup
process.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -11033,8 +11042,8 @@ async def sample_list_big_query_links():

Args:
request (Optional[Union[google.analytics.admin_v1alpha.types.ListBigQueryLinksRequest, dict]]):
The request object. Request message for
ListBigQueryLinks RPC.
The request object. Request message for ListBigQueryLinks
RPC.
parent (:class:`str`):
Required. The name of the property to list BigQuery
links under. Format: properties/{property_id} Example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1016,8 +1016,7 @@ def sample_list_accounts():

Args:
request (Union[google.analytics.admin_v1alpha.types.ListAccountsRequest, dict]):
The request object. Request message for ListAccounts
RPC.
The request object. Request message for ListAccounts RPC.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2127,8 +2126,8 @@ def sample_batch_get_user_links():

Args:
request (Union[google.analytics.admin_v1alpha.types.BatchGetUserLinksRequest, dict]):
The request object. Request message for
BatchGetUserLinks RPC.
The request object. Request message for BatchGetUserLinks
RPC.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2435,14 +2434,16 @@ def sample_create_user_link():
request (Union[google.analytics.admin_v1alpha.types.CreateUserLinkRequest, dict]):
The request object. Request message for CreateUserLink
RPC.
Users can have multiple email addresses associated with
their Google account, and one of these email addresses
is the "primary" email address. Any of the email
addresses associated with a Google account may be used
for a new UserLink, but the returned UserLink will
always contain the "primary" email address. As a result,
the input and output email address for this request may
differ.
Users can have multiple email addresses
associated with their Google account,
and one of these email addresses is the
"primary" email address. Any of the
email addresses associated with a Google
account may be used for a new UserLink,
but the returned UserLink will always
contain the "primary" email address. As
a result, the input and output email
address for this request may differ.
parent (str):
Required. Example format:
accounts/1234
Expand Down Expand Up @@ -3203,8 +3204,8 @@ def sample_list_firebase_links():

Args:
request (Union[google.analytics.admin_v1alpha.types.ListFirebaseLinksRequest, dict]):
The request object. Request message for
ListFirebaseLinks RPC
The request object. Request message for ListFirebaseLinks
RPC
parent (str):
Required. Format: properties/{property_id} Example:
properties/1234
Expand Down Expand Up @@ -6017,7 +6018,8 @@ def sample_get_display_video360_advertiser_link_proposal():
Args:
request (Union[google.analytics.admin_v1alpha.types.GetDisplayVideo360AdvertiserLinkProposalRequest, dict]):
The request object. Request message for
GetDisplayVideo360AdvertiserLinkProposal RPC.
GetDisplayVideo360AdvertiserLinkProposal
RPC.
name (str):
Required. The name of the
DisplayVideo360AdvertiserLinkProposal to
Expand Down Expand Up @@ -6140,7 +6142,8 @@ def sample_list_display_video360_advertiser_link_proposals():
Args:
request (Union[google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinkProposalsRequest, dict]):
The request object. Request message for
ListDisplayVideo360AdvertiserLinkProposals RPC.
ListDisplayVideo360AdvertiserLinkProposals
RPC.
parent (str):
Required. Example format:
properties/1234
Expand Down Expand Up @@ -6267,7 +6270,8 @@ def sample_create_display_video360_advertiser_link_proposal():
Args:
request (Union[google.analytics.admin_v1alpha.types.CreateDisplayVideo360AdvertiserLinkProposalRequest, dict]):
The request object. Request message for
CreateDisplayVideo360AdvertiserLinkProposal RPC.
CreateDisplayVideo360AdvertiserLinkProposal
RPC.
parent (str):
Required. Example format:
properties/1234
Expand Down Expand Up @@ -6398,7 +6402,8 @@ def sample_delete_display_video360_advertiser_link_proposal():
Args:
request (Union[google.analytics.admin_v1alpha.types.DeleteDisplayVideo360AdvertiserLinkProposalRequest, dict]):
The request object. Request message for
DeleteDisplayVideo360AdvertiserLinkProposal RPC.
DeleteDisplayVideo360AdvertiserLinkProposal
RPC.
name (str):
Required. The name of the
DisplayVideo360AdvertiserLinkProposal to
Expand Down Expand Up @@ -6508,7 +6513,8 @@ def sample_approve_display_video360_advertiser_link_proposal():
Args:
request (Union[google.analytics.admin_v1alpha.types.ApproveDisplayVideo360AdvertiserLinkProposalRequest, dict]):
The request object. Request message for
ApproveDisplayVideo360AdvertiserLinkProposal RPC.
ApproveDisplayVideo360AdvertiserLinkProposal
RPC.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -6607,7 +6613,8 @@ def sample_cancel_display_video360_advertiser_link_proposal():
Args:
request (Union[google.analytics.admin_v1alpha.types.CancelDisplayVideo360AdvertiserLinkProposalRequest, dict]):
The request object. Request message for
CancelDisplayVideo360AdvertiserLinkProposal RPC.
CancelDisplayVideo360AdvertiserLinkProposal
RPC.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -7479,8 +7486,8 @@ def sample_list_custom_metrics():

Args:
request (Union[google.analytics.admin_v1alpha.types.ListCustomMetricsRequest, dict]):
The request object. Request message for
ListCustomMetrics RPC.
The request object. Request message for ListCustomMetrics
RPC.
parent (str):
Required. Example format:
properties/1234
Expand Down Expand Up @@ -11427,7 +11434,8 @@ def sample_set_automated_ga4_configuration_opt_out():
Args:
request (Union[google.analytics.admin_v1alpha.types.SetAutomatedGa4ConfigurationOptOutRequest, dict]):
The request object. Request for setting the opt out
status for the automated GA4 setup process.
status for the automated GA4 setup
process.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -11511,7 +11519,8 @@ def sample_fetch_automated_ga4_configuration_opt_out():
Args:
request (Union[google.analytics.admin_v1alpha.types.FetchAutomatedGa4ConfigurationOptOutRequest, dict]):
The request object. Request for fetching the opt out
status for the automated GA4 setup process.
status for the automated GA4 setup
process.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -11698,8 +11707,8 @@ def sample_list_big_query_links():

Args:
request (Union[google.analytics.admin_v1alpha.types.ListBigQueryLinksRequest, dict]):
The request object. Request message for
ListBigQueryLinks RPC.
The request object. Request message for ListBigQueryLinks
RPC.
parent (str):
Required. The name of the property to list BigQuery
links under. Format: properties/{property_id} Example:
Expand Down
Loading