googleapis
Version:
Google APIs Client Library for Node.js
1,216 lines • 210 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace datamanager_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Data Manager API
*
* A unified ingestion API for data partners, agencies and advertisers to connect first-party data across Google advertising products.
*
* @example
* ```js
* const {google} = require('googleapis');
* const datamanager = google.datamanager('v1');
* ```
*/
export class Datamanager {
context: APIRequestContext;
accountTypes: Resource$Accounttypes;
adEvents: Resource$Adevents;
audienceMembers: Resource$Audiencemembers;
events: Resource$Events;
requestStatus: Resource$Requeststatus;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Address information for the user.
*/
export interface Schema$AddressInfo {
/**
* Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted. Normalize the value before hashing: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace
*/
addressLine?: string | null;
/**
* Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace
*/
administrativeArea?: string | null;
/**
* Optional. The city of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace
*/
city?: string | null;
/**
* Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
*/
familyName?: string | null;
/**
* Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
*/
givenName?: string | null;
/**
* Required. The postal code of the user's address.
*/
postalCode?: string | null;
/**
* Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
*/
regionCode?: string | null;
}
/**
* An ad event.
*/
export interface Schema$AdEvent {
/**
* Enum value for ad format.
*/
adFormat?: string | null;
/**
* String value for ad format.
*/
adFormatString?: string | null;
/**
* Optional. The ID of the associated ad group.
*/
adGroupId?: string | null;
/**
* Optional. The height of the ad in pixels.
*/
adHeight?: number | null;
/**
* Optional. The ID of the associated ad within the group.
*/
adId?: string | null;
/**
* Enum value for ad placement.
*/
adPlacement?: string | null;
/**
* String value for ad placement.
*/
adPlacementString?: string | null;
/**
* Enum value for ad type.
*/
adType?: string | null;
/**
* String value for ad type.
*/
adTypeString?: string | null;
/**
* Required. The ID of the advertiser for the ad event. This must match the ID sent in the linking flow.
*/
advertiserId?: string | null;
/**
* Optional. The width of the ad in pixels.
*/
adWidth?: number | null;
/**
* Optional. The partner-assumed attribution status for this ad event. This acts only as a signal for how the partner assumed attribution played out, and does not force an end result in final reports.
*/
attributionHint?: string | null;
/**
* Required. The ID of the associated campaign.
*/
campaignId?: string | null;
/**
* Required. The name of the associated campaign.
*/
campaignName?: string | null;
/**
* Required. Information gathered about the device being used when the ad event happened.
*/
deviceInfo?: Schema$DeviceInfo;
/**
* Optional. An ID created and managed by the caller that uniquely identifies this event. Required if you want to deduplicate ad events that are included in multiple requests. Otherwise, this field is optional.
*/
eventId?: string | null;
/**
* Enum value for event subtype.
*/
eventSubtype?: string | null;
/**
* String value for event subtype.
*/
eventSubtypeString?: string | null;
/**
* Required. The type of the event.
*/
eventType?: string | null;
/**
* Optional. Represents if the row is allowed to be used for measurement purposes, as governed by applicable privacy laws within regional jurisdiction.
*/
measurementAllowed?: boolean | null;
/**
* Required. The medium of the ad, akin to the Google Analytics medium.
*/
medium?: string | null;
/**
* Optional. The device ID of the device that the ad was served to.
*/
mobileDeviceId?: string | null;
/**
* Enum value for platform.
*/
platform?: string | null;
/**
* String value for platform.
*/
platformString?: string | null;
/**
* Enum value for platform type.
*/
platformType?: string | null;
/**
* String value for platform type.
*/
platformTypeString?: string | null;
/**
* Optional. The ISO 3166-2 country plus subdivision.
*/
regionCode?: string | null;
/**
* Required. The platform source of the ad, akin to the Google Analytics source.
*/
source?: string | null;
/**
* Enum value for targeting type.
*/
targetingType?: string | null;
/**
* String value for targeting type.
*/
targetingTypeString?: string | null;
/**
* Required. The time the event occurred.
*/
timestamp?: string | null;
/**
* Optional. Multiple pieces of user-provided data, representing the user the event is associated with. It is possible to provide multiple instances of the same type of data (e.g. email address). The more data provided, the more likely a match will be found.
*/
userData?: Schema$UserData;
/**
* Required. Details of the viewability of the ad served.
*/
viewabilityInfo?: Schema$ViewabilityInfo;
}
/**
* Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).
*/
export interface Schema$AdIdentifiers {
/**
* Optional. The display click ID associated with this event.
*/
dclid?: string | null;
/**
* Optional. Any number of encrypted user IDs.
*/
encryptedUserIds?: Schema$EncryptedUserId[];
/**
* Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.
*/
gbraid?: string | null;
/**
* Optional. The Google click ID (gclid) associated with this event.
*/
gclid?: string | null;
/**
* Optional. The impression ID associated with this event.
*/
impressionId?: string | null;
/**
* Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser’s site after interacting with the ad.
*/
landingPageDeviceInfo?: Schema$DeviceInfo;
/**
* Optional. The match ID field used to join this event with a previous event.
*/
matchId?: string | null;
/**
* Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms’ identifiers for advertisers.
*/
mobileDeviceId?: string | null;
/**
* Optional. Session attributes for event attribution and modeling.
*/
sessionAttributes?: string | null;
/**
* Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.
*/
wbraid?: string | null;
}
/**
* The audience member to be operated on.
*/
export interface Schema$AudienceMember {
/**
* Group of multiple identifier types.
*/
compositeData?: Schema$CompositeData;
/**
* Optional. The consent setting for the user.
*/
consent?: Schema$Consent;
/**
* Optional. Defines which Destination to send the audience member to.
*/
destinationReferences?: string[] | null;
/**
* Encrypted Google User IDs.
*/
googleUserIdData?: Schema$GoogleUserIdData;
/**
* Data identifying the user's mobile devices.
*/
mobileData?: Schema$MobileData;
/**
* [Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). This feature is only available to data partners.
*/
pairData?: Schema$PairData;
/**
* Partner-provided identifiers.
*/
partnerProvidedIdData?: Schema$PartnerProvidedIdData;
/**
* Data related to publisher provided identifiers. This feature is only available to data partners.
*/
ppidData?: Schema$PpidData;
/**
* User-provided data that identifies the user.
*/
userData?: Schema$UserData;
/**
* Data related to unique identifiers for a user, as defined by the advertiser.
*/
userIdData?: Schema$UserIdData;
}
/**
* A data encryption key wrapped by an AWS KMS key.
*/
export interface Schema$AwsWrappedKeyInfo {
/**
* Required. The base64 encoded encrypted data encryption key.
*/
encryptedDek?: string | null;
/**
* Required. The URI of the AWS KMS key used to decrypt the DEK. Should be in the format of `arn:{partition\}:kms:{region\}:{account_id\}:key/{key_id\}` or `aws-kms://arn:{partition\}:kms:{region\}:{account_id\}:key/{key_id\}`
*/
kekUri?: string | null;
/**
* Required. The type of algorithm used to encrypt the data.
*/
keyType?: string | null;
/**
* Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of `arn:{partition\}:iam::{account_id\}:role/{role_name\}`
*/
roleArn?: string | null;
}
/**
* Baseline criteria against which insights are compared.
*/
export interface Schema$Baseline {
/**
* The baseline location of the request. Baseline location is an OR-list of the requested regions.
*/
baselineLocation?: Schema$Location;
/**
* If set to true, the service will try to automatically detect the baseline location for insights.
*/
locationAutoDetectionEnabled?: boolean | null;
}
/**
* The cart data associated with the event.
*/
export interface Schema$CartData {
/**
* Optional. The list of coupon codes that were applied to the cart. Cart-level and item-level coupon codes are independent. If the event is for a Google Analytics destination, only provide a single coupon code. Google Analytics ignores additional coupon codes.
*/
couponCodes?: string[] | null;
/**
* Optional. The list of items associated with the event.
*/
items?: Schema$Item[];
/**
* Optional. The Merchant Center feed label associated with the feed of the items.
*/
merchantFeedLabel?: string | null;
/**
* Optional. The language code in ISO 639-1 associated with the Merchant Center feed of the items.where your items are uploaded.
*/
merchantFeedLanguageCode?: string | null;
/**
* Optional. The Merchant Center ID associated with the items.
*/
merchantId?: string | null;
/**
* Optional. The sum of all discounts associated with the transaction.
*/
transactionDiscount?: number | null;
}
/**
* Composite data holding identifiers and associated data for a user. At least one of `user_data` or `ip_data` is required.
*/
export interface Schema$CompositeData {
/**
* Optional. IP address data representing customer interaction used to build the audience.
*/
ipData?: Schema$IpData[];
/**
* Optional. User-provided data that identifies the user.
*/
userData?: Schema$UserData;
}
/**
* [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user.
*/
export interface Schema$Consent {
/**
* Optional. Represents if the user consents to ad personalization.
*/
adPersonalization?: string | null;
/**
* Optional. Represents if the user consents to ad user data.
*/
adUserData?: string | null;
}
/**
* Additional information when `CONTACT_ID` is one of the `upload_key_types`.
*/
export interface Schema$ContactIdInfo {
/**
* Optional. Immutable. Source of the upload data
*/
dataSourceType?: string | null;
/**
* Output only. Match rate for customer match user lists.
*/
matchRatePercentage?: number | null;
}
/**
* Information about the coordinator key.
*/
export interface Schema$CoordinatorKeyInfo {
/**
* Required. The ID of the chosen coordinator key.
*/
keyId?: string | null;
}
/**
* Custom variable for ads conversions.
*/
export interface Schema$CustomVariable {
/**
* Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.
*/
destinationReferences?: string[] | null;
/**
* Optional. The value to store for the custom variable.
*/
value?: string | null;
/**
* Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.
*/
variable?: string | null;
}
/**
* The count for a specific data type.
*/
export interface Schema$DataTypeCount {
/**
* The count for this data type.
*/
count?: string | null;
/**
* The type of data.
*/
type?: string | null;
}
/**
* The Google product you're sending data to. For example, a Google Ads account.
*/
export interface Schema$Destination {
/**
* 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`.
*/
linkedAccount?: Schema$ProductAccount;
/**
* 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`.
*/
loginAccount?: Schema$ProductAccount;
/**
* Required. The account to send the data to or remove the data from.
*/
operatingAccount?: Schema$ProductAccount;
/**
* 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.
*/
productDestinationId?: string | null;
/**
* Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.
*/
reference?: string | null;
}
/**
* Information about the device being used (if any) when the event happened.
*/
export interface Schema$DeviceInfo {
/**
* Optional. The brand of the device.
*/
brand?: string | null;
/**
* Optional. The brand or type of the browser.
*/
browser?: string | null;
/**
* Optional. The version of the browser.
*/
browserVersion?: string | null;
/**
* Optional. The category of device. For example, “desktop”, “tablet”, “mobile”, “smart TV”.
*/
category?: string | null;
/**
* Optional. The IP address of the device for the given context. Required when used in an AdEvent. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details.
*/
ipAddress?: string | null;
/**
* Optional. The language the device uses in ISO 639-1 format.
*/
languageCode?: string | null;
/**
* Optional. The model of the device.
*/
model?: string | null;
/**
* Optional. The operating system or platform of the device.
*/
operatingSystem?: string | null;
/**
* Optional. The version of the operating system or platform.
*/
operatingSystemVersion?: string | null;
/**
* Optional. The height of the screen in pixels.
*/
screenHeight?: number | null;
/**
* Optional. The width of the screen in pixels.
*/
screenWidth?: number | null;
/**
* Optional. The user-agent string of the device for the given context.
*/
userAgent?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* A user identifier issued to be used for attribution. All fields are required if this is used.
*/
export interface Schema$EncryptedUserId {
/**
* Required. The alphanumeric encrypted id.
*/
encryptedId?: string | null;
/**
* Required. The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
*/
entityId?: string | null;
/**
* Required. The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
*/
entityType?: string | null;
/**
* Required. Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
*/
source?: string | null;
}
/**
* Encryption information for the data being ingested.
*/
export interface Schema$EncryptionInfo {
/**
* Amazon Web Services wrapped key information.
*/
awsWrappedKeyInfo?: Schema$AwsWrappedKeyInfo;
/**
* Key information for the chosen coordinator key. This is not supported for the IngestEvents, IngestAudienceMembers, and RemoveAudienceMembers methods.
*/
coordinatorKeyInfo?: Schema$CoordinatorKeyInfo;
/**
* Google Cloud Platform wrapped key information.
*/
gcpWrappedKeyInfo?: Schema$GcpWrappedKeyInfo;
}
/**
* The error count for a given error reason.
*/
export interface Schema$ErrorCount {
/**
* The error reason of the failed records.
*/
reason?: string | null;
/**
* The count of records that failed to upload for a given reason.
*/
recordCount?: string | null;
}
/**
* Error counts for each type of error.
*/
export interface Schema$ErrorInfo {
/**
* A list of errors and counts per error reason. May not be populated in all cases.
*/
errorCounts?: Schema$ErrorCount[];
}
/**
* An event representing a user interaction with an advertiser's website or app.
*/
export interface Schema$Event {
/**
* Optional. A bucket of any [event parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.
*/
additionalEventParameters?: Schema$EventParameter[];
/**
* Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).
*/
adIdentifiers?: Schema$AdIdentifiers;
/**
* Optional. A unique identifier for the user instance of an app client for this GA4 app stream.
*/
appInstanceId?: string | null;
/**
* Optional. Information about the transaction and items associated with the event.
*/
cartData?: Schema$CartData;
/**
* Optional. A unique identifier for the user instance of a web client for this GA4 web stream.
*/
clientId?: string | null;
/**
* Optional. Information about whether the associated user has provided different types of consent.
*/
consent?: Schema$Consent;
/**
* Optional. The conversion quantity associated with the event, for counting-based conversions.
*/
conversionCount?: number | null;
/**
* Optional. The conversion value associated with the event, for value-based conversions.
*/
conversionValue?: number | null;
/**
* Optional. The currency code associated with all monetary values within this event.
*/
currency?: string | null;
/**
* Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).
*/
customVariables?: Schema$CustomVariable[];
/**
* Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.
*/
destinationReferences?: string[] | null;
/**
* Optional. Information gathered about the device being used (if any) when the event happened.
*/
eventDeviceInfo?: Schema$DeviceInfo;
/**
* Optional. Information gathered about the location of the user when this event occurred.
*/
eventLocation?: Schema$EventLocation;
/**
* Optional. The name of the event. Required for GA4 events.
*/
eventName?: string | null;
/**
* Optional. Signal for where the event happened (web, app, in-store, etc.).
*/
eventSource?: string | null;
/**
* Required. The time the event occurred.
*/
eventTimestamp?: string | null;
/**
* Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.
*/
experimentalFields?: Schema$ExperimentalField[];
/**
* Optional. The last time the event was updated.
*/
lastUpdatedTimestamp?: string | null;
/**
* Optional. The same type of data provided in user_data, but explicitly flagged as being provided as owned by a third-party and not first-party advertiser data.
*/
thirdPartyUserData?: Schema$UserData;
/**
* Optional. The unique identifier for this event. Required for events sent as an additional data source for tag conversions.
*/
transactionId?: string | null;
/**
* Optional. Pieces of user provided data, representing the user the event is associated with.
*/
userData?: Schema$UserData;
/**
* Optional. A unique identifier for a user, as defined by the advertiser.
*/
userId?: string | null;
/**
* Optional. Advertiser-assessed information about the user at the time that the event happened.
*/
userProperties?: Schema$UserProperties;
}
/**
* The location where the event occurred.
*/
export interface Schema$EventLocation {
/**
* Optional. The name of the city where the event occurred.
*/
city?: string | null;
/**
* Optional. The continent code in UN M49 format where the event occurred.
*/
continentCode?: string | null;
/**
* Optional. The 2-letter CLDR region code of the user's address.
*/
regionCode?: string | null;
/**
* Optional. Required for Store Sales. The identifier to represent a physical store where the event happened.
*/
storeId?: string | null;
/**
* Optional. The subcontinent code in UN M49 format where the event occurred.
*/
subcontinentCode?: string | null;
/**
* Optional. The ISO 3166-2 subdivision code where the event occurred.
*/
subdivisionCode?: string | null;
}
/**
* Event parameter for GA4 events.
*/
export interface Schema$EventParameter {
/**
* Required. The name of the parameter to use.
*/
parameterName?: string | null;
/**
* Required. The string representation of the value of the parameter to set.
*/
value?: string | null;
}
/**
* Experimental field representing unofficial fields.
*/
export interface Schema$ExperimentalField {
/**
* Optional. The name of the field to use.
*/
field?: string | null;
/**
* Optional. The value the field to set.
*/
value?: string | null;
}
/**
* Detailed row-level warning with field paths.
*/
export interface Schema$FieldWarning {
/**
* The detailed warning message describing the issue.
*/
description?: string | null;
/**
* The field path that triggered the warning. Uses the same format as google.rpc.BadRequest.FieldViolation.field.
*/
field?: string | null;
/**
* The warning reason.
*/
reason?: string | null;
}
/**
* Information about the Google Cloud Platform wrapped key.
*/
export interface Schema$GcpWrappedKeyInfo {
/**
* Required. The base64 encoded encrypted data encryption key.
*/
encryptedDek?: string | null;
/**
* Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{key\}` or `gcp-kms://projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{key\}`
*/
kekUri?: string | null;
/**
* Required. The type of algorithm used to encrypt the data.
*/
keyType?: string | null;
/**
* Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.
*/
wipProvider?: string | null;
}
/**
* Google user id data holding encrypted google user IDs. At least one google user ID is required.
*/
export interface Schema$GoogleUserIdData {
/**
* Required. The list of encrypted google user IDs.
*/
googleUserIds?: string[] | null;
}
/**
* Request to upload ad events.
*/
export interface Schema$IngestAdEventsRequest {
/**
* Required. Required (at least 1). A list of ad events.
*/
adEvents?: Schema$AdEvent[];
/**
* Required. Information about encryption keys which are used to encrypt the data.
*/
encryptionInfo?: Schema$EncryptionInfo;
/**
* Optional. If true, the request is validated, but not executed.
*/
validateOnly?: boolean | null;
}
/**
* Response from an ad event ingestion operation.
*/
export interface Schema$IngestAdEventsResponse {
}
/**
* Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse.
*/
export interface Schema$IngestAudienceMembersRequest {
/**
* Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.
*/
audienceMembers?: Schema$AudienceMember[];
/**
* Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember.
*/
consent?: Schema$Consent;
/**
* Required. The list of destinations to send the audience members to.
*/
destinations?: Schema$Destination[];
/**
* Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.
*/
encoding?: string | null;
/**
* Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored.
*/
encryptionInfo?: Schema$EncryptionInfo;
/**
* Optional. The terms of service that the user has accepted/rejected.
*/
termsOfService?: Schema$TermsOfService;
/**
* Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.
*/
validateOnly?: boolean | null;
}
/**
* Response from the IngestAudienceMembersRequest.
*/
export interface Schema$IngestAudienceMembersResponse {
/**
* Detailed row-level warnings with field paths.
*/
fieldWarnings?: Schema$FieldWarning[];
/**
* The auto-generated ID of the request.
*/
requestId?: string | null;
}
/**
* The status of the ingest audience members request.
*/
export interface Schema$IngestAudienceMembersStatus {
/**
* The status of the composite data ingestion to the destination.
*/
compositeDataIngestionStatus?: Schema$IngestCompositeDataStatus;
/**
* The status of the google user id data ingestion to the destination.
*/
googleUserIdDataIngestionStatus?: Schema$IngestGoogleUserIdDataStatus;
/**
* The status of the mobile data ingestion to the destination.
*/
mobileDataIngestionStatus?: Schema$IngestMobileDataStatus;
/**
* The status of the pair data ingestion to the destination.
*/
pairDataIngestionStatus?: Schema$IngestPairDataStatus;
/**
* The status of the partner provided id data ingestion to the destination.
*/
partnerProvidedIdDataIngestionStatus?: Schema$IngestPartnerProvidedIdDataStatus;
/**
* The status of the ppid data ingestion to the destination.
*/
ppidDataIngestionStatus?: Schema$IngestPpidDataStatus;
/**
* The status of the user data ingestion to the destination.
*/
userDataIngestionStatus?: Schema$IngestUserDataStatus;
/**
* The status of the user id data ingestion to the destination.
*/
userIdDataIngestionStatus?: Schema$IngestUserIdDataStatus;
}
/**
* The status of the composite data ingestion to the destination containing stats related to the ingestion.
*/
export interface Schema$IngestCompositeDataStatus {
/**
* The total count of data types sent in the upload request for the destination, broken down by data type. Includes all data types in the request, regardless of whether they were successfully ingested or not.
*/
dataTypeCounts?: Schema$DataTypeCount[];
/**
* 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.
*/
recordCount?: string | null;
/**
* The match rate range of the upload.
*/
uploadMatchRateRange?: string | null;
}
/**
* Represents a user list that is populated by user provided data.
*/
export interface Schema$IngestedUserListInfo {
/**
* Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`.
*/
contactIdInfo?: Schema$ContactIdInfo;
/**
* Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`.
*/
mobileIdInfo?: Schema$MobileIdInfo;
/**
* Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
*/
pairIdInfo?: Schema$PairIdInfo;
/**
* Optional. Additional information for partner audiences. This feature is only available to data partners.
*/
partnerAudienceInfo?: Schema$PartnerAudienceInfo;
/**
* Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
*/
pseudonymousIdInfo?: Schema$PseudonymousIdInfo;
/**
* Required. Immutable. Upload key types of this user list.
*/
uploadKeyTypes?: string[] | null;
/**
* Optional. Additional information when `USER_ID` is one of the `upload_key_types`.
*/
userIdInfo?: Schema$UserIdInfo;
}
/**
* Request to upload audience members to the provided destinations. Returns an IngestEventsResponse.
*/
export interface Schema$IngestEventsRequest {
/**
* Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each Event.
*/
consent?: Schema$Consent;
/**
* Required. The list of destinations to send the events to.
*/
destinations?: Schema$Destination[];
/**
* Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.
*/
encoding?: string | null;
/**
* Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored.
*/
encryptionInfo?: Schema$EncryptionInfo;
/**
* Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.
*/
events?: Schema$Event[];
/**
* Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.
*/
validateOnly?: boolean | null;
}
/**
* Response from the IngestEventsRequest.
*/
export interface Schema$IngestEventsResponse {
/**
* Detailed row-level warnings with field paths.
*/
fieldWarnings?: Schema$FieldWarning[];
/**
* The auto-generated ID of the request.
*/
requestId?: string | null;
}
/**
* The status of the events ingestion to the destination.
*/
export interface Schema$IngestEventsStatus {
/**
* 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.
*/
recordCount?: string | null;
}
/**
* The status of the google user id data ingestion to the destination containing stats related to the ingestion.
*/
export interface Schema$IngestGoogleUserIdDataStatus {
/**
* The total count of google user ids sent in the upload request for the destination. Includes all google user ids in the request, regardless of whether they were successfully ingested or not.
*/
googleUserIdCount?: string | null;
/**
* 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.
*/
recordCount?: string | null;
}
/**
* The status of the mobile data ingestion to the destination containing stats related to the ingestion.
*/
export interface Schema$IngestMobileDataStatus {
/**
* 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.
*/
mobileIdCount?: string | null;
/**
* 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.
*/
recordCount?: string | null;
}
/**
* The status of the pair data ingestion to the destination containing stats related to the ingestion.
*/
export interface Schema$IngestPairDataStatus {
/**
* 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.
*/
pairIdCount?: string | null;
/**
* 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.
*/
recordCount?: string | null;
}
/**
* The status of the partner provided id data ingestion to the destination containing stats related to the ingestion.
*/
export interface Schema$IngestPartnerProvidedIdDataStatus {
/**
* The total count of partner provided ids sent in the upload request for the destination. Includes all partner provided ids in the request, regardless of whether they were successfully ingested or not.
*/
partnerProvidedIdCount?: string | null;
/**
* 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.
*/
recordCount?: string | null;
}
/**
* The status of the ppid data ingestion to the destination containing stats related to the ingestion.
*/
export interface Schema$IngestPpidDataStatus {
/**
* The total count of ppids sent in the upload request for the destination. Includes all ppids in the request, regardless of whether they were successfully ingested or not.
*/
ppidCount?: string | null;
/**
* 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.
*/
recordCount?: string | null;
}
/**
* The status of the user data ingestion to the destination containing stats related to the ingestion.
*/
export interface Schema$IngestUserDataStatus {
/**
* 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.
*/
recordCount?: string | null;
/**
* The match rate range of the upload.
*/
uploadMatchRateRange?: string | null;
/**
* 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.
*/
userIdentifierCount?: string | null;
}
/**
* The status of the user id data ingestion to the destination containing stats related to the ingestion.
*/
export interface Schema$IngestUserIdDataStatus {
/**
* 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.
*/
recordCount?: string | null;
/**
* The total count of user ids sent in the upload request for the destination. Includes all user ids in the request, regardless of whether they were successfully ingested or not.
*/
userIdCount?: string | null;
}
/**
* IP address information for a user. We recommend including observe_start_time and observe_end_time to help improve Customer Match match rates.
*/
export interface Schema$IpData {
/**
* Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6.
*/
ipAddress?: string | null;
/**
* Optional. Last recorded interaction time from this IP address in a session.
*/
observeEndTime?: string | null;
/**
* Optional. First recorded interaction time from this IP address in a session.
*/
observeStartTime?: string | null;
}
/**
* Represents an item in the cart associated with the event.
*/
export interface Schema$Item {
/**
* Optional. A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.
*/
additionalItemParameters?: Schema$ItemParameter[];
/**
* Optional. The conversion value associated with this item within the event, for cases where the conversion value is different for each item.
*/
conversionValue?: number | null;
/**
* Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.
*/
customVariables?: Schema$ItemCustomVariable[];
/**
* Optional. A unique identifier to reference the item.
*/
itemId?: string | null;
/**
* Optional. The feed label of the Merchant Center feed. If countries are still being used, the 2-letter country code in ISO-3166-1 alpha-2 can be used instead. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.
*/
merchantFeedLabel?: string | null;
/**
* Optional. The language code in ISO 639-1 associated with the Merchant Center feed where your items are uploaded.
*/
merchantFeedLanguageCode?: string | null;
/**
* Optional. The Merchant Center ID associated with the item. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.
*/
merchantId?: string | null;
/**
* Optional. The product ID within the Merchant Center account.
*/
merchantProductId?: string | null;
/**
* Optional. The number of this item associated with the event.
*/
quantity?: string | null;
/**
* Optional. The unit price excluding tax, shipping, and any transaction level discounts.
*/
unitPrice?: number | null;
}
/**
* Item-level custom variable for ads conversions.
*/
export interface Schema$ItemCustomVariable {
/**
* Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.
*/
destinationReferences?: string[] | null;
/**
* Optional. The value to store for the custom variable.
*/
value?: string | null;
/**
* Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.
*/
variable?: string | null;
}
/**
* A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.
*/
export interface Schema$ItemParameter {
/**
* Required. The name of the parameter to use.
*/
parameterName?: string | null;
/**
* Required. The string representation of the value of the parameter to set.
*/
value?: string | null;
}
/**
* Response from the ListUserListDirectLicensesRequest.
*/
export interface Schema$ListUserListD