REST Resource: accountTypes.accounts.userLists

Risorsa: UserList

Una risorsa elenco degli utenti.

Rappresentazione JSON 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of mutually exclusive fields.
}
Campi
name

string

Identificatore. Il nome risorsa dell'elenco utenti. Formato: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

Solo output. L'ID univoco dell'elenco utenti.
readOnly

boolean

Solo output. Un'opzione che indica se un utente può modificare un elenco.
membershipDuration

string (Duration format)

Facoltativo. Il periodo di tempo durante il quale un utente rimane nell'elenco utenti. Le durate valide sono multipli esatti di 24 ore (86.400 secondi). Se fornisci un valore che non è un multiplo esatto di 24 ore, viene restituito un errore INVALID_ARGUMENT.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
accessReason

enum (AccessReason)

Solo output. Il motivo per cui a questo account è stato concesso l'accesso all'elenco.
sizeInfo

object (SizeInfo)

Solo output. Numero stimato di membri di questo elenco di utenti in diverse reti di destinazione.
targetNetworkInfo

object (TargetNetworkInfo)

Facoltativo. Informazioni sull'idoneità per diverse reti di destinazione.
displayName

string

Obbligatorio. Il nome visualizzato dell'elenco utenti.
description

string

Facoltativo. Una descrizione dell'elenco di utenti.
membershipStatus

enum (MembershipStatus)

Facoltativo. Stato abbonamento di questo elenco di utenti.
integrationCode

string

Facoltativo. Un ID di un sistema esterno. Viene utilizzato dai venditori di elenchi di utenti per correlare gli ID nei loro sistemi.
closingReason

enum (ClosingReason)

Solo output. Il motivo per cui lo stato di abbonamento a questo elenco di utenti è chiuso.
accountAccessStatus

enum (AccessStatus)

Facoltativo. Indica se questa condivisione è ancora attiva. Quando un elenco di utenti viene condiviso con l'account, questo campo è impostato su ENABLED. In un secondo momento, il proprietario dell'elenco di utenti può decidere di revocare la condivisione e renderla DISABLED.
Informazioni aggiuntive sull'elenco di utenti. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
ingestedUserListInfo

object (IngestedUserListInfo)

Facoltativo. Rappresenta un elenco utenti compilato con i dati inseriti dagli utenti.
Fine dei campi che si escludono a vicenda.

MembershipStatus

Stato dell'elenco utenti.

Enum
MEMBERSHIP_STATUS_UNSPECIFIED Non specificato.
OPEN Stato aperto: l'elenco di utenti sta accumulando membri e può essere scelto come target.
CLOSED Stato Chiuso: non vengono aggiunti nuovi membri.

ClosingReason

Indica il motivo per cui l'elenco utenti è stato chiuso. Questa enumerazione viene utilizzata solo quando un elenco viene chiuso automaticamente dal sistema.

Enum
CLOSING_REASON_UNSPECIFIED Non specificato.
UNUSED L'elenco di utenti è stato chiuso perché non è stato utilizzato di recente per il targeting. Per maggiori dettagli, visita la pagina https://support.google.com/google-ads/answer/2472738.

AccessReason

Enumerazione che descrive i possibili motivi di accesso.

Enum
ACCESS_REASON_UNSPECIFIED Non specificato.
OWNED La risorsa è di proprietà dell'utente.
SHARED La risorsa viene condivisa con l'utente.
LICENSED La risorsa è concessa in licenza all'utente.
SUBSCRIBED L'utente si è iscritto alla risorsa.
AFFILIATED La risorsa è accessibile all'utente.

AccessStatus

Indica se questo cliente ha ancora accesso all'elenco.

Enum
ACCESS_STATUS_UNSPECIFIED Non specificato.
ENABLED L'accesso è attivato.
DISABLED L'accesso è disattivato.

SizeInfo

Numero stimato di membri di questo elenco di utenti in diverse reti di destinazione.

Rappresentazione JSON 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
Campi
displayNetworkMembersCount

string (int64 format)

Solo output. Numero stimato di membri di questo elenco utenti sulla Rete Display di Google.
searchNetworkMembersCount

string (int64 format)

Solo output. Numero stimato di membri di questo elenco utenti nel dominio google.com. Questi sono i membri disponibili per il targeting nelle campagne sulla rete di ricerca.
youtubeMembersCount

string (int64 format)

Solo output. Numero stimato di membri di questo elenco di utenti su YouTube.
gmailMembersCount

string (int64 format)

Solo output. Il numero stimato di membri di questo elenco utenti su Gmail.

TargetNetworkInfo

Informazioni sull'idoneità per diverse reti di destinazione.

Rappresentazione JSON 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
Campi
eligibleForDisplay

boolean

Solo output. Indica che questo elenco utenti è idoneo per la Rete Display di Google.

IngestedUserListInfo

Rappresenta un elenco utenti compilato con i dati forniti dagli utenti.

Rappresentazione JSON 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
Campi
uploadKeyTypes[]

enum (UploadKeyType)

Obbligatorio. Immutabile. Tipi di chiavi di caricamento di questo elenco utenti.
contactIdInfo

object (ContactIdInfo)

Facoltativo. Informazioni aggiuntive quando CONTACT_ID è uno dei uploadKeyTypes.
mobileIdInfo

object (MobileIdInfo)

Facoltativo. Informazioni aggiuntive quando MOBILE_ID è uno dei uploadKeyTypes.
userIdInfo

object (UserIdInfo)

Facoltativo. Informazioni aggiuntive quando USER_ID è uno dei uploadKeyTypes.
pairIdInfo

object (PairIdInfo)

Facoltativo. Informazioni aggiuntive quando PAIR_ID è uno dei uploadKeyTypes.

Questa funzionalità è disponibile solo per i partner di dati.
pseudonymousIdInfo

object (PseudonymousIdInfo)

Facoltativo. Ulteriori informazioni per PSEUDONYMOUS_ID è uno dei uploadKeyTypes.
partnerAudienceInfo

object (PartnerAudienceInfo)

Facoltativo. Informazioni aggiuntive per i segmenti di pubblico dei partner.

Questa funzionalità è disponibile solo per i partner di dati.

UploadKeyType

Enumerazione contenente i possibili tipi di chiave di caricamento di un elenco utenti.

Enum
UPLOAD_KEY_TYPE_UNSPECIFIED Non specificato.
CONTACT_ID Informazioni sul cliente, come indirizzo email, numero di telefono o indirizzo fisico.
MOBILE_ID ID pubblicità mobile.
USER_ID ID utente forniti da terze parti.
PAIR_ID ID di riconciliazione dell'identità dell'inserzionista del publisher.
PSEUDONYMOUS_ID

ID piattaforma di gestione dei dati:

  • ID utente Google
  • ID fornito dal partner
  • ID fornito dal publisher
  • IDFA per iOS
  • ID pubblicità Android
  • ID Roku
  • ID Amazon Fire TV
  • ID Microsoft o Xbox
  • ID dispositivo generico

ContactIdInfo

Informazioni aggiuntive quando CONTACT_ID è uno dei uploadKeyTypes.

Rappresentazione JSON 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
Campi
matchRatePercentage

integer

Solo output. Tasso di corrispondenza per gli elenchi utenti Customer Match.
dataSourceType

enum (DataSourceType)

Facoltativo. Immutabile. Origine dei dati di caricamento

DataSourceType

Indica l'origine dei dati di caricamento.

Enum
DATA_SOURCE_TYPE_UNSPECIFIED Non specificato.
DATA_SOURCE_TYPE_FIRST_PARTY I dati caricati sono dati proprietari.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU I dati caricati provengono da un'agenzia di credito di terze parti.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE I dati caricati provengono da un file di elettori di terze parti.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA I dati caricati sono dati di partner terzi.

MobileIdInfo

Informazioni aggiuntive quando MOBILE_ID è uno dei uploadKeyTypes.

Rappresentazione JSON 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
Campi
dataSourceType

enum (DataSourceType)

Facoltativo. Immutabile. Origine dei dati di caricamento.
keySpace

enum (KeySpace)

Obbligatorio. Immutabile. Lo spazio delle chiavi degli ID mobile.
appId

string

Obbligatorio. Immutabile. Una stringa che identifica in modo univoco un'applicazione mobile da cui sono stati raccolti i dati.

KeySpace

Spazio chiave per l'ID mobile.

Enum
KEY_SPACE_UNSPECIFIED Non specificato.
IOS Lo spazio delle chiavi iOS.
ANDROID Lo spazio delle chiavi Android.

UserIdInfo

Informazioni aggiuntive quando USER_ID è uno dei uploadKeyTypes.

Rappresentazione JSON 
{
  "dataSourceType": enum (DataSourceType)
}
Campi
dataSourceType

enum (DataSourceType)

Facoltativo. Immutabile. Origine dei dati di caricamento.

PairIdInfo

Informazioni aggiuntive quando PAIR_ID è uno dei uploadKeyTypes.

Questa funzionalità è disponibile solo per i partner di dati.

Rappresentazione JSON 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
Campi
publisherId

string (int64 format)

Obbligatorio. Immutabile. Identifica l'editore con cui viene riconciliato l'elenco utenti Publisher Advertiser Identity Reconciliation. Questo campo è fornito dal fornitore della clean room ed è univoco solo nell'ambito di quella clean room. Non può essere utilizzato come identificatore globale in più cleanroom.
publisherName

string

Obbligatorio. Nome descrittivo del publisher da visualizzare nell'interfaccia utente per un'esperienza di targeting migliore.
matchRatePercentage

integer

Obbligatorio. Questo campo indica la percentuale di corrispondenza dell'inclusione di questo elenco utenti con i dati proprietari del publisher corrispondente. Deve essere compreso tra 0 e 100 inclusi.
advertiserIdentifierCount

string (int64 format)

Facoltativo. Il conteggio dei record di dati proprietari dell'inserzionista caricati in un fornitore di data clean room. Ciò non indica le dimensioni di un elenco di utenti PAIR.
cleanRoomIdentifier

string

Obbligatorio. Immutabile. Identifica una relazione univoca tra inserzionista e publisher con un fornitore di data clean room o con più fornitori.

PseudonymousIdInfo

Informazioni aggiuntive quando PSEUDONYMOUS_ID è uno dei uploadKeyTypes.

Rappresentazione JSON 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
Campi
syncStatus

enum (SyncStatus)

Solo output. Stato della sincronizzazione dell'elenco utenti.
billableRecordCount

string (int64 format)

Facoltativo. Immutabile. Il numero di record fatturabili (ad es. caricati o abbinati).

SyncStatus

Stato della sincronizzazione dell'elenco utenti.

Enum
SYNC_STATUS_UNSPECIFIED Non specificato.
CREATED L'elenco utenti è stato creato come segnaposto. I contenuti e/o i metadati dell'elenco sono ancora in fase di sincronizzazione. L'elenco utenti non è pronto per l'uso.
READY_FOR_USE L'elenco utenti è pronto per l'uso. I contenuti e i cookie sono stati sincronizzati correttamente.
FAILED Si è verificato un errore durante la sincronizzazione dei contenuti e/o dei metadati dell'elenco utenti. L'elenco utenti non può essere utilizzato.

PartnerAudienceInfo

Informazioni aggiuntive per i segmenti di pubblico dei partner.

Questa funzionalità è disponibile solo per i partner di dati.

Rappresentazione JSON 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
Campi
partnerAudienceSource

enum (PartnerAudienceSource)

Obbligatorio. Immutabile. L'origine del segmento di pubblico partner.
commercePartner

string

Facoltativo. Il nome del partner commerciale. Consentito solo se partnerAudienceSource è COMMERCE_AUDIENCE.

PartnerAudienceSource

Origine dati del pubblico partner.

Enum
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED Non specificato.
COMMERCE_AUDIENCE L'origine dati del pubblico partner è il segmento di pubblico commerciale.
LINEAR_TV_AUDIENCE L'origine dati del pubblico del partner è il pubblico della TV lineare.
AGENCY_PROVIDER_AUDIENCE L'origine dati del pubblico partner è il pubblico agenzia/fornitore.

Metodi

create

 Crea un UserList.

delete

 Elimina un elenco utenti.

get

 Recupera un elenco utenti.

list

 Elenca UserLists.

patch

 Aggiorna un elenco utenti.