2022-07-27
▼ ▲ analyticsadmin.properties.audiences.list
Parameter Order: parent
Flat Path: v1alpha/properties/{propertiesId}/audiences
HTTP Method: GET
Scopes:
Parameters:
parent
Location: path
Required: Yes
Type: string
Description: Required. Example format: properties/1234
Pattern: ^properties/[^/]+$
pageSize
Description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
Location: query
Format: int32
Type: integer
pageToken
Location: query
Description: A page token, received from a previous `ListAudiences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAudiences` must match the call that provided the page token.
Type: string
Description: Lists Audiences on a property.
Path: v1alpha/{+parent}/audiences
▼ ▲ analyticsadmin.properties.audiences.patch
Scopes: https://www.googleapis.com/auth/analytics.edit
Description: Updates an Audience on a property.
Parameters:
name
Type: string
Pattern: ^properties/[^/]+/audiences/[^/]+$
Required: Yes
Description: Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}
Location: path
updateMask
Description: Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
Type: string
Location: query
Format: google-fieldmask
Parameter Order: name
Flat Path: v1alpha/properties/{propertiesId}/audiences/{audiencesId}
HTTP Method: PATCH
Path: v1alpha/{+name}
▼ ▲ analyticsadmin.properties.audiences.archive
HTTP Method: POST
Description: Archives an Audience on a property.
Path: v1alpha/{+name}:archive
Scopes: https://www.googleapis.com/auth/analytics.edit
Parameters:
name
Description: Required. Example format: properties/1234/audiences/5678
Required: Yes
Pattern: ^properties/[^/]+/audiences/[^/]+$
Location: path
Type: string
Flat Path: v1alpha/properties/{propertiesId}/audiences/{audiencesId}:archive
Parameter Order: name
▼ ▲ analyticsadmin.properties.audiences.create
Scopes: https://www.googleapis.com/auth/analytics.edit
HTTP Method: POST
Path: v1alpha/{+parent}/audiences
Parameter Order: parent
Parameters:
parent
Description: Required. Example format: properties/1234
Location: path
Type: string
Required: Yes
Pattern: ^properties/[^/]+$
Description: Creates an Audience.
Flat Path: v1alpha/properties/{propertiesId}/audiences
▼ ▲ analyticsadmin.properties.audiences.get
Scopes:
Parameter Order: name
Parameters:
name
Description: Required. The name of the Audience to get. Example format: properties/1234/audiences/5678
Type: string
Required: Yes
Location: path
Pattern: ^properties/[^/]+/audiences/[^/]+$
Path: v1alpha/{+name}
Description: Lookup for a single Audience.
Flat Path: v1alpha/properties/{propertiesId}/audiences/{audiencesId}
HTTP Method: GET