ReportService¶
- class google.ads.admanager_v1.services.report_service.ReportServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.ads.admanager_v1.services.report_service.transports.base.ReportServiceTransport, typing.Callable[[...], google.ads.admanager_v1.services.report_service.transports.base.ReportServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
Provides methods for interacting with reports.
Instantiates the report service client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,ReportServiceTransport,Callable[..., ReportServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the ReportServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.
1. The
api_endpointproperty can be used to override the default endpoint provided by the client whentransportis not explicitly provided. Only if this property is not set andtransportwas not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the
client_cert_sourceproperty can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.3. The
universe_domainproperty can be used to override the default “googleapis.com” universe. Note that theapi_endpointproperty still takes precedence; anduniverse_domainis currently not supported for mTLS.client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If
None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- __exit__(type, value, traceback)[source]¶
Releases underlying transport’s resources.
Warning
ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- static common_billing_account_path(billing_account: str) str[source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str[source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str[source]¶
Returns a fully-qualified organization string.
- create_report(request: Optional[Union[google.ads.admanager_v1.types.report_service.CreateReportRequest, dict]] = None, *, parent: Optional[str] = None, report: Optional[google.ads.admanager_v1.types.report_messages.Report] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.ads.admanager_v1.types.report_messages.Report[source]¶
API to create a
Reportobject.# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.ads import admanager_v1 def sample_create_report(): # Create a client client = admanager_v1.ReportServiceClient() # Initialize request argument(s) report = admanager_v1.Report() report.report_definition.dimensions = ['CUSTOM_DIMENSION_9_VALUE'] report.report_definition.metrics = ['YIELD_GROUP_SUCCESSFUL_RESPONSES'] report.report_definition.report_type = "AD_SPEED" request = admanager_v1.CreateReportRequest( parent="parent_value", report=report, ) # Make the request response = client.create_report(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.CreateReportRequest, dict]) – The request object. Request object for
CreateReportmethod.parent (str) –
Required. The parent resource where this
Reportwill be created. Format:networks/{network_code}This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.report (google.ads.admanager_v1.types.Report) – Required. The
Reportto create. This corresponds to thereportfield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
The Report resource.
- Return type
- fetch_report_result_rows(request: Optional[Union[google.ads.admanager_v1.types.report_service.FetchReportResultRowsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.ads.admanager_v1.services.report_service.pagers.FetchReportResultRowsPager[source]¶
Returns the result rows from a completed report. The caller must have previously called
RunReportand waited for that operation to complete. The rows will be returned according to the order specified by thesortsmember of the report definition.# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.ads import admanager_v1 def sample_fetch_report_result_rows(): # Create a client client = admanager_v1.ReportServiceClient() # Initialize request argument(s) request = admanager_v1.FetchReportResultRowsRequest( ) # Make the request page_result = client.fetch_report_result_rows(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.FetchReportResultRowsRequest, dict]) – The request object. The request message for the fetch report result rows endpoint.
name (str) –
The report result being fetched. Format:
networks/{network_code}/reports/{report_id}/results/{report_result_id}This corresponds to the
namefield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
The response message for the fetch report result rows endpoint. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.ads.admanager_v1.services.report_service.pagers.FetchReportResultRowsPager
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
Deprecated. Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.
The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
- Parameters
client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.longrunning.operations_pb2.Operation[source]¶
Gets the latest state of a long-running operation.
- Parameters
request (
GetOperationRequest) – The request object. Request message for GetOperation method.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
An
Operationobject.- Return type
Operation
- get_report(request: Optional[Union[google.ads.admanager_v1.types.report_service.GetReportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.ads.admanager_v1.types.report_messages.Report[source]¶
API to retrieve a
Reportobject.# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.ads import admanager_v1 def sample_get_report(): # Create a client client = admanager_v1.ReportServiceClient() # Initialize request argument(s) request = admanager_v1.GetReportRequest( name="name_value", ) # Make the request response = client.get_report(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.GetReportRequest, dict]) – The request object. Request object for
GetReportmethod.name (str) –
Required. The resource name of the report. Format:
networks/{network_code}/reports/{report_id}This corresponds to the
namefield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
The Report resource.
- Return type
- list_reports(request: Optional[Union[google.ads.admanager_v1.types.report_service.ListReportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.ads.admanager_v1.services.report_service.pagers.ListReportsPager[source]¶
API to retrieve a list of
Reportobjects.# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.ads import admanager_v1 def sample_list_reports(): # Create a client client = admanager_v1.ReportServiceClient() # Initialize request argument(s) request = admanager_v1.ListReportsRequest( parent="parent_value", ) # Make the request page_result = client.list_reports(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.ListReportsRequest, dict]) – The request object. Request object for
ListReportsmethod.parent (str) –
Required. The parent, which owns this collection of reports. Format:
networks/{network_code}This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
- Response object for ListReportsResponse containing matching Report
objects.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.ads.admanager_v1.services.report_service.pagers.ListReportsPager
- static parse_common_billing_account_path(path: str) Dict[str, str][source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str][source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str][source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str][source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str][source]¶
Parse a project path into its component segments.
- static parse_network_path(path: str) Dict[str, str][source]¶
Parses a network path into its component segments.
- static parse_report_path(path: str) Dict[str, str][source]¶
Parses a report path into its component segments.
- static report_path(network_code: str, report: str) str[source]¶
Returns a fully-qualified report string.
- run_report(request: Optional[Union[google.ads.admanager_v1.types.report_service.RunReportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.api_core.operation.Operation[source]¶
Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using
OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain aRunReportResponsein its response field containing a report_result that can be passed to theFetchReportResultRowsmethod to retrieve the report data.# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.ads import admanager_v1 def sample_run_report(): # Create a client client = admanager_v1.ReportServiceClient() # Initialize request argument(s) request = admanager_v1.RunReportRequest( name="name_value", ) # Make the request operation = client.run_report(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.RunReportRequest, dict]) – The request object. Request message for a running a report.
name (str) –
Required. The report to run. Format:
networks/{network_code}/reports/{report_id}This corresponds to the
namefield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.ads.admanager_v1.types.RunReportResponseResponse message for a completed RunReport operation.- Return type
- property transport: google.ads.admanager_v1.services.report_service.transports.base.ReportServiceTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
ReportServiceTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
The universe domain used by the client instance.
- Return type
- update_report(request: Optional[Union[google.ads.admanager_v1.types.report_service.UpdateReportRequest, dict]] = None, *, report: Optional[google.ads.admanager_v1.types.report_messages.Report] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.ads.admanager_v1.types.report_messages.Report[source]¶
API to update a
Reportobject.# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.ads import admanager_v1 def sample_update_report(): # Create a client client = admanager_v1.ReportServiceClient() # Initialize request argument(s) report = admanager_v1.Report() report.report_definition.dimensions = ['CUSTOM_DIMENSION_9_VALUE'] report.report_definition.metrics = ['YIELD_GROUP_SUCCESSFUL_RESPONSES'] report.report_definition.report_type = "AD_SPEED" request = admanager_v1.UpdateReportRequest( report=report, ) # Make the request response = client.update_report(request=request) # Handle the response print(response)
- Parameters
request (Union[google.ads.admanager_v1.types.UpdateReportRequest, dict]) – The request object. Request object for
UpdateReportmethod.report (google.ads.admanager_v1.types.Report) – Required. The
Reportto update. This corresponds to thereportfield on therequestinstance; ifrequestis provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. The list of fields to update.
This corresponds to the
update_maskfield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
The Report resource.
- Return type
- class google.ads.admanager_v1.services.report_service.pagers.FetchReportResultRowsPager(method: Callable[[...], google.ads.admanager_v1.types.report_service.FetchReportResultRowsResponse], request: google.ads.admanager_v1.types.report_service.FetchReportResultRowsRequest, response: google.ads.admanager_v1.types.report_service.FetchReportResultRowsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]¶
A pager for iterating through
fetch_report_result_rowsrequests.This class thinly wraps an initial
google.ads.admanager_v1.types.FetchReportResultRowsResponseobject, and provides an__iter__method to iterate through itsrowsfield.If there are more pages, the
__iter__method will make additionalFetchReportResultRowsrequests and continue to iterate through therowsfield on the corresponding responses.All the usual
google.ads.admanager_v1.types.FetchReportResultRowsResponseattributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.ads.admanager_v1.types.FetchReportResultRowsRequest) – The initial request object.
response (google.ads.admanager_v1.types.FetchReportResultRowsResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- class google.ads.admanager_v1.services.report_service.pagers.ListReportsPager(method: Callable[[...], google.ads.admanager_v1.types.report_service.ListReportsResponse], request: google.ads.admanager_v1.types.report_service.ListReportsRequest, response: google.ads.admanager_v1.types.report_service.ListReportsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]¶
A pager for iterating through
list_reportsrequests.This class thinly wraps an initial
google.ads.admanager_v1.types.ListReportsResponseobject, and provides an__iter__method to iterate through itsreportsfield.If there are more pages, the
__iter__method will make additionalListReportsrequests and continue to iterate through thereportsfield on the corresponding responses.All the usual
google.ads.admanager_v1.types.ListReportsResponseattributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.ads.admanager_v1.types.ListReportsRequest) – The initial request object.
response (google.ads.admanager_v1.types.ListReportsResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.