Google Analytics Data API . properties . audienceExports

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the `QueryAudienceExport` method. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports for one audience on different days will return different results as users enter and exit the audience. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in each audience. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

Args:
  parent: string, Required. The parent resource where this audience export will be created. Format: `properties/{property}` (required)
  body: object, The request body.
    The object takes the form of:

{ # An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days.
  "audience": "A String", # Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: `properties/{property}/audiences/{audience}`
  "audienceDisplayName": "A String", # Output only. The descriptive display name for this audience. For example, "Purchasers".
  "beginCreatingTime": "A String", # Output only. The time when CreateAudienceExport was called and the AudienceExport began the `CREATING` state.
  "creationQuotaTokensCharged": 42, # Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceExport enters the `ACTIVE` or `FAILED` states.
  "dimensions": [ # Required. The dimensions requested and displayed in the query response.
    { # An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the `QueryAudienceExportResponse`.
      "dimensionName": "A String", # Optional. The API name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions) for the list of dimension names.
    },
  ],
  "errorMessage": "A String", # Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.
  "name": "A String", # Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this `AudienceExport`. Format: `properties/{property}/audienceExports/{audience_export}`
  "percentageCompleted": 3.14, # Output only. The percentage completed for this audience export ranging between 0 to 100.
  "rowCount": 42, # Output only. The total number of rows in the AudienceExport result.
  "state": "A String", # Output only. The current state for this AudienceExport.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

get(name, x__xgafv=None)

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

Args:
  name: string, Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days.
  "audience": "A String", # Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: `properties/{property}/audiences/{audience}`
  "audienceDisplayName": "A String", # Output only. The descriptive display name for this audience. For example, "Purchasers".
  "beginCreatingTime": "A String", # Output only. The time when CreateAudienceExport was called and the AudienceExport began the `CREATING` state.
  "creationQuotaTokensCharged": 42, # Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceExport enters the `ACTIVE` or `FAILED` states.
  "dimensions": [ # Required. The dimensions requested and displayed in the query response.
    { # An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the `QueryAudienceExportResponse`.
      "dimensionName": "A String", # Optional. The API name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions) for the list of dimension names.
    },
  ],
  "errorMessage": "A String", # Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.
  "name": "A String", # Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this `AudienceExport`. Format: `properties/{property}/audienceExports/{audience_export}`
  "percentageCompleted": 3.14, # Output only. The percentage completed for this audience export ranging between 0 to 100.
  "rowCount": 42, # Output only. The total number of rows in the AudienceExport result.
  "state": "A String", # Output only. The current state for this AudienceExport.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

Args:
  parent: string, Required. All audience exports for this property will be listed in the response. Format: `properties/{property}` (required)
  pageSize: integer, Optional. The maximum number of audience exports to return. The service may return fewer than this value. If unspecified, at most 200 audience exports will be returned. The maximum value is 1000 (higher values will be coerced to the maximum).
  pageToken: string, Optional. A page token, received from a previous `ListAudienceExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAudienceExports` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A list of all audience exports for a property.
  "audienceExports": [ # Each audience export for a property.
    { # An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days.
      "audience": "A String", # Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: `properties/{property}/audiences/{audience}`
      "audienceDisplayName": "A String", # Output only. The descriptive display name for this audience. For example, "Purchasers".
      "beginCreatingTime": "A String", # Output only. The time when CreateAudienceExport was called and the AudienceExport began the `CREATING` state.
      "creationQuotaTokensCharged": 42, # Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceExport enters the `ACTIVE` or `FAILED` states.
      "dimensions": [ # Required. The dimensions requested and displayed in the query response.
        { # An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the `QueryAudienceExportResponse`.
          "dimensionName": "A String", # Optional. The API name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions) for the list of dimension names.
        },
      ],
      "errorMessage": "A String", # Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.
      "name": "A String", # Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this `AudienceExport`. Format: `properties/{property}/audienceExports/{audience_export}`
      "percentageCompleted": 3.14, # Output only. The percentage completed for this audience export ranging between 0 to 100.
      "rowCount": 42, # Output only. The total number of rows in the AudienceExport result.
      "state": "A String", # Output only. The current state for this AudienceExport.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

query(name, body=None, x__xgafv=None)

Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to `CreateAudienceExport` is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.

Args:
  name: string, Required. The name of the audience export to retrieve users from. Format: `properties/{property}/audienceExports/{audience_export}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A request to list users in an audience export.
  "limit": "A String", # Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
  "offset": "A String", # Optional. The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A list of users in an audience export.
  "audienceExport": { # An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days. # Configuration data about AudienceExport being queried. Returned to help interpret the audience rows in this response. For example, the dimensions in this AudienceExport correspond to the columns in the AudienceRows.
    "audience": "A String", # Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: `properties/{property}/audiences/{audience}`
    "audienceDisplayName": "A String", # Output only. The descriptive display name for this audience. For example, "Purchasers".
    "beginCreatingTime": "A String", # Output only. The time when CreateAudienceExport was called and the AudienceExport began the `CREATING` state.
    "creationQuotaTokensCharged": 42, # Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceExport enters the `ACTIVE` or `FAILED` states.
    "dimensions": [ # Required. The dimensions requested and displayed in the query response.
      { # An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the `QueryAudienceExportResponse`.
        "dimensionName": "A String", # Optional. The API name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions) for the list of dimension names.
      },
    ],
    "errorMessage": "A String", # Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.
    "name": "A String", # Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this `AudienceExport`. Format: `properties/{property}/audienceExports/{audience_export}`
    "percentageCompleted": 3.14, # Output only. The percentage completed for this audience export ranging between 0 to 100.
    "rowCount": 42, # Output only. The total number of rows in the AudienceExport result.
    "state": "A String", # Output only. The current state for this AudienceExport.
  },
  "audienceRows": [ # Rows for each user in an audience export. The number of rows in this response will be less than or equal to request's page size.
    { # Dimension value attributes for the audience user row.
      "dimensionValues": [ # Each dimension value attribute for an audience user. One dimension value will be added for each dimension column requested.
        { # The value of a dimension.
          "value": "A String", # Value as a string if the dimension type is a string.
        },
      ],
    },
  ],
  "rowCount": 42, # The total number of rows in the AudienceExport result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
}