| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="datamanager_v1.html">Data Manager API</a> . <a href="datamanager_v1.requestStatus.html">requestStatus</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#retrieve">retrieve(requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the status of a request given request id.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="retrieve">retrieve(requestId=None, x__xgafv=None)</code> |
| <pre>Gets the status of a request given request id. |
| |
| Args: |
| requestId: string, Required. Required. The request ID of the Data Manager API request. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response from the RetrieveRequestStatusRequest. |
| "requestStatusPerDestination": [ # A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request. |
| { # A request status per destination. |
| "audienceMembersIngestionStatus": { # The status of the ingest audience members request. # The status of the ingest audience members request. |
| "mobileDataIngestionStatus": { # The status of the mobile data ingestion to the destination containing stats related to the ingestion. # The status of the mobile data ingestion to the destination. |
| "mobileIdCount": "A String", # The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not. |
| "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
| }, |
| "pairDataIngestionStatus": { # The status of the pair data ingestion to the destination containing stats related to the ingestion. # The status of the pair data ingestion to the destination. |
| "pairIdCount": "A String", # The total count of pair ids sent in the upload request for the destination. Includes all pair ids in the request, regardless of whether they were successfully ingested or not. |
| "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
| }, |
| "userDataIngestionStatus": { # The status of the user data ingestion to the destination containing stats related to the ingestion. # The status of the user data ingestion to the destination. |
| "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
| "uploadMatchRateRange": "A String", # The match rate range of the upload. |
| "userIdentifierCount": "A String", # The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not. |
| }, |
| }, |
| "audienceMembersRemovalStatus": { # The status of the remove audience members request. # The status of the remove audience members request. |
| "mobileDataRemovalStatus": { # The status of the mobile data removal from the destination. # The status of the mobile data removal from the destination. |
| "mobileIdCount": "A String", # The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not. |
| "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
| }, |
| "pairDataRemovalStatus": { # The status of the pair data removal from the destination. # The status of the pair data removal from the destination. |
| "pairIdCount": "A String", # The total count of pair ids sent in the removal request. Includes all pair ids in the request, regardless of whether they were successfully removed or not. |
| "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
| }, |
| "userDataRemovalStatus": { # The status of the user data removal from the destination. # The status of the user data removal from the destination. |
| "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
| "userIdentifierCount": "A String", # The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not. |
| }, |
| }, |
| "destination": { # The Google product you're sending data to. For example, a Google Ads account. # A destination within a DM API request. |
| "linkedAccount": { # Represents a specific account. # Optional. An account that the calling user's `login_account` has access to, through an established account link. For example, a data partner's `login_account` might have access to a client's `linked_account`. The partner might use this field to send data from the `linked_account` to another `operating_account`. |
| "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID. |
| "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match. |
| "product": "A String", # Deprecated. Use `account_type` instead. |
| }, |
| "loginAccount": { # Represents a specific account. # Optional. The account used to make this API call. To add or remove data from the `operating_account`, this `login_account` must have write access to the `operating_account`. For example, a manager account of the `operating_account`, or an account with an established link to the `operating_account`. |
| "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID. |
| "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match. |
| "product": "A String", # Deprecated. Use `account_type` instead. |
| }, |
| "operatingAccount": { # Represents a specific account. # Required. The account to send the data to or remove the data from. |
| "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID. |
| "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match. |
| "product": "A String", # Deprecated. Use `account_type` instead. |
| }, |
| "productDestinationId": "A String", # Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID. |
| "reference": "A String", # Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest. |
| }, |
| "errorInfo": { # Error counts for each type of error. # An error info error containing the error reason and error counts related to the upload. |
| "errorCounts": [ # A list of errors and counts per error reason. May not be populated in all cases. |
| { # The error count for a given error reason. |
| "reason": "A String", # The error reason of the failed records. |
| "recordCount": "A String", # The count of records that failed to upload for a given reason. |
| }, |
| ], |
| }, |
| "eventsIngestionStatus": { # The status of the events ingestion to the destination. # The status of the ingest events request. |
| "recordCount": "A String", # The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not. |
| }, |
| "requestStatus": "A String", # The request status of the destination. |
| "warningInfo": { # Warning counts for each type of warning. # A warning info containing the warning reason and warning counts related to the upload. |
| "warningCounts": [ # A list of warnings and counts per warning reason. |
| { # The warning count for a given warning reason. |
| "reason": "A String", # The warning reason. |
| "recordCount": "A String", # The count of records that have a warning. |
| }, |
| ], |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
