Package google.ads.datamanager.v1

Indeks

IngestionService

Usługa do wysyłania danych o odbiorcach do obsługiwanych miejsc docelowych.

IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

Przesyła listę zasobów AudienceMember do podanego Destination.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/datamanager
IngestEvents

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

Przesyła listę zasobów Event z podanego pliku Destination.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/datamanager
RemoveAudienceMembers

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

Usuwa listę zasobów AudienceMember z podanego Destination.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/datamanager
RetrieveRequestStatus

rpc RetrieveRequestStatus(RetrieveRequestStatusRequest) returns (RetrieveRequestStatusResponse)

Pobiera stan żądania na podstawie jego identyfikatora.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/datamanager

AdIdentifiers

Identyfikatory i inne informacje używane do dopasowywania zdarzenia konwersji do innej aktywności online (np. kliknięć reklam).

Pola
session_attributes

string

Opcjonalnie: Atrybuty sesji na potrzeby atrybucji i modelowania zdarzeń.

gclid

string

Opcjonalnie: Identyfikator kliknięcia Google (gclid) powiązany z tym zdarzeniem.

gbraid

string

Opcjonalnie: Identyfikator kliknięcia w przypadku kliknięć powiązanych ze zdarzeniami w aplikacji pochodzącymi z urządzeń z systemem iOS od wersji 14.

wbraid

string

Opcjonalnie: Identyfikator kliknięcia w przypadku kliknięć powiązanych ze zdarzeniami w witrynie pochodzącymi z urządzeń z systemem iOS od wersji 14.

landing_page_device_info

DeviceInfo

Opcjonalnie: Informacje zebrane o urządzeniu używanym (jeśli dotyczy) w momencie wejścia na stronę reklamodawcy po interakcji z reklamą.

AddressInfo

Informacje o adresie użytkownika.

Pola
given_name

string

Wymagane. Imię użytkownika (pisane małymi literami, bez znaków interpunkcyjnych, bez spacji na początku i na końcu, zahaszowane za pomocą SHA-256).

family_name

string

Wymagane. Nazwisko użytkownika (w całości małymi literami, bez znaków interpunkcyjnych, bez spacji na początku i na końcu, zahaszowane za pomocą SHA-256).

region_code

string

Wymagane. Dwuliterowy kod regionu w formacie ISO-3166-1 alpha-2 z adresu użytkownika.

postal_code

string

Wymagane. Kod pocztowy adresu użytkownika.

AudienceMember

Odbiorca, na którym ma być przeprowadzona operacja.

Pola
destination_references[]

string

Opcjonalnie: Określa, na którą Destination ma zostać przekierowany odbiorca.

consent

Consent

Opcjonalnie: Ustawienie zgody użytkownika.

Pole zbiorcze data. Typ danych identyfikacyjnych, na których ma zostać wykonane działanie. data może mieć tylko jedną z tych wartości:
user_data

UserData

Dane przekazywane przez użytkowników, które identyfikują użytkownika.

pair_data

PairData

Identyfikatory dopasowywania danych o tożsamości użytkowników (PAIR).

mobile_data

MobileData

Dane identyfikujące urządzenia mobilne użytkownika.

AwsWrappedKeyInfo

Klucz szyfrujący dane obudowany przez klucz AWS KMS.

Pola
key_type

KeyType

Wymagane. Typ algorytmu użytego do zaszyfrowania danych.

role_arn

string

Wymagane. Nazwa zasobu Amazon (ARN) roli uprawnień przyjmowanej na potrzeby dostępu do odszyfrowywania KMS. Powinien mieć format „arn:{partition}:iam::{account_id}:role/{role_name}”.

kek_uri

string

Wymagane. Identyfikator URI klucza AWS KMS używanego do odszyfrowywania klucza DEK. Powinien mieć format „arn:{partition}:kms:{region}:{account_id}:key/{key_id}”.

encrypted_dek

string

Wymagane. Zaszyfrowany klucz szyfrujący dane zakodowany w formacie base64.

KeyType

Typ algorytmu użytego do zaszyfrowania danych.

Wartości w polu enum
KEY_TYPE_UNSPECIFIED Nieokreślony typ klucza. Nigdy nie należy go używać.
XCHACHA20_POLY1305 Algorytm XChaCha20-Poly1305

CartData

Dane koszyka powiązane ze zdarzeniem.

Pola
merchant_id

string

Opcjonalnie: Identyfikator Merchant Center powiązany z produktami.

merchant_feed_label

string

Opcjonalnie: Etykieta pliku danych Merchant Center powiązana z plikiem danych produktów.

merchant_feed_language_code

string

Opcjonalnie: Kod języka w formacie ISO 639-1 powiązany z plikiem danych Merchant Center, w którym przesyłane są Twoje produkty.

transaction_discount

double

Opcjonalnie: Suma wszystkich rabatów powiązanych z transakcją.

items[]

Item

Opcjonalnie: Lista produktów powiązanych ze zdarzeniem.

Ustawienia zgody użytkownika wymaganej przez akt o rynkach cyfrowych (DMA).

Pola
ad_user_data

ConsentStatus

Opcjonalnie: Określa, czy użytkownik wyraża zgodę na korzystanie z danych użytkowników reklam.

ad_personalization

ConsentStatus

Opcjonalnie: Określa, czy użytkownik wyraża zgodę na personalizację reklam.

ConsentStatus

Wskazuje, czy użytkownik wyraził zgodę, odmówił jej udzielenia czy nie określił swojego stanowiska.

Wartości w polu enum
CONSENT_STATUS_UNSPECIFIED Nie określono.
CONSENT_GRANTED Przyznano.
CONSENT_DENIED Odrzucono.

Zmienna niestandardowa

Zmienna niestandardowa na potrzeby konwersji z reklam.

Pola
variable

string

Opcjonalnie: Nazwa zmiennej niestandardowej do ustawienia. Jeśli zmienna nie zostanie znaleziona w przypadku danego miejsca docelowego, zostanie zignorowana.

value

string

Opcjonalnie: Wartość, która ma być przechowywana w zmiennej niestandardowej.

destination_references[]

string

Opcjonalnie: Ciąg odniesienia używany do określania, do którego z Event.destination_references należy wysłać zmienną niestandardową. Jeśli pole jest puste, używana jest wartość Event.destination_references.

CustomerType

Typ klienta powiązanego ze zdarzeniem.

Wartości w polu enum
CUSTOMER_TYPE_UNSPECIFIED Nieokreślony typ klienta. Nigdy nie należy go używać.
NEW klient jest nowy dla reklamodawcy.
RETURNING Klient wraca do reklamodawcy.
REENGAGED Klient ponownie zaangażował się w interakcję z reklamodawcą.

CustomerValueBucket

Wartość klienta określona przez reklamodawcę.

Wartości w polu enum
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Unspecified CustomerValueBucket. Nigdy nie należy go używać.
LOW Klient ma niską wartość.
MEDIUM Klient ma średnią wartość.
HIGH Klient jest wartościowy.

Miejsce docelowe

Usługa Google, do której wysyłasz dane. Na przykład konto Google Ads.

Pola
reference

string

Opcjonalnie: Identyfikator tego zasobu Destination, unikalny w ramach żądania. Służy do odwoływania się do tego zasobu Destination w elementach IngestEventsRequestIngestAudienceMembersRequest.

login_account

ProductAccount

Opcjonalnie: Konto użyte do wykonania tego wywołania interfejsu API. Aby dodawać lub usuwać dane z operating_account, to login_account musi mieć uprawnienia do zapisu w operating_account. Na przykład konto menedżera operating_account lub konto z ustalonym połączeniem z operating_account.

linked_account

ProductAccount

Opcjonalnie: Konto, do którego użytkownik wywołujący login_account ma dostęp dzięki utworzonemu połączeniu kont. Na przykład login_account partnera danych może mieć dostęp do linked_account klienta. Partner może używać tego pola do wysyłania danych z linked_account do innego operating_account.

operating_account

ProductAccount

Wymagane. Konto, na które mają być wysyłane dane lub z którego mają być usuwane.

product_destination_id

string

Wymagane. Obiekt na koncie usługi, do którego mają być przesyłane dane. Może to być np. identyfikator listy odbiorców Google Ads, identyfikator listy odbiorców Display & Video 360 lub identyfikator działania powodującego konwersję w Google Ads.

DeviceInfo

Informacje o urządzeniu używanym (jeśli dotyczy) w momencie wystąpienia zdarzenia.

Pola
user_agent

string

Opcjonalnie: Ciąg znaków klienta użytkownika urządzenia w danym kontekście.

ip_address

string

Opcjonalnie: Adres IP urządzenia w danym kontekście.

Uwaga: Google Ads nie obsługuje dopasowywania adresów IP użytkowników z Europejskiego Obszaru Gospodarczego (EOG), Wielkiej Brytanii i Szwajcarii. Dodaj logikę, która warunkowo wyklucza udostępnianie adresów IP użytkowników z tych regionów, i zadbaj o to, aby udostępniać użytkownikom jasne i wyczerpujące informacje na temat danych, które zbierasz w swoich witrynach, aplikacjach i innych usługach, a jeśli jest to wymagane przez prawo lub obowiązujące zasady Google, uzyskać ich zgodę. Więcej informacji znajdziesz na stronie Importowanie konwersji offline.

Kodowanie

Typ kodowania zahaszowanych informacji identyfikacyjnych.

Wartości w polu enum
ENCODING_UNSPECIFIED Nieokreślony typ kodowania. Nigdy nie należy go używać.
HEX Kodowanie szesnastkowe.
BASE64 kodowanie Base64,

EncryptionInfo

Informacje o szyfrowaniu przesyłanych danych.

Pola
Pole zbiorcze wrapped_key. Klucz opakowany użyty do zaszyfrowania danych. wrapped_key może mieć tylko jedną z tych wartości:
gcp_wrapped_key_info

GcpWrappedKeyInfo

Informacje o kluczu obudowanym w Google Cloud Platform.

aws_wrapped_key_info

AwsWrappedKeyInfo

Informacje o kluczu obudowanym przez Amazon Web Services.

ErrorCount

Liczba błędów z danego powodu.

Pola
record_count

int64

Liczba rekordów, których nie udało się przesłać z określonego powodu.

reason

ProcessingErrorReason

Przyczyna błędu w przypadku nieudanych rekordów.

ErrorInfo

Liczba błędów każdego typu.

Pola
error_counts[]

ErrorCount

Lista błędów i liczba błędów według przyczyny. W niektórych przypadkach może nie być wypełniona.

ErrorReason

Przyczyny błędów interfejsu Data Manager API.

Wartości w polu enum
ERROR_REASON_UNSPECIFIED Nie używaj tej wartości domyślnej.
INTERNAL_ERROR Wystąpił błąd wewnętrzny.
DEADLINE_EXCEEDED Odpowiedź na żądanie zajęła zbyt dużo czasu.
RESOURCE_EXHAUSTED Zbyt wiele żądań.
NOT_FOUND Nie znaleziono zasobu.
PERMISSION_DENIED Użytkownik nie ma uprawnień lub zasób nie został znaleziony.
INVALID_ARGUMENT Wystąpił problem z żądaniem.
REQUIRED_FIELD_MISSING Wymagane pole jest puste.
INVALID_FORMAT Format jest nieprawidłowy.
INVALID_HEX_ENCODING Wartość zakodowana w formacie szesnastkowym jest nieprawidłowa.
INVALID_BASE64_ENCODING Wartość zakodowana w formacie base64 jest nieprawidłowa.
INVALID_SHA256_FORMAT Wartość zakodowana za pomocą algorytmu SHA256 jest nieprawidłowa.
INVALID_POSTAL_CODE Kod pocztowy jest nieprawidłowy.
INVALID_COUNTRY_CODE Kod kraju jest nieprawidłowy.
INVALID_ENUM_VALUE Nie można użyć wartości typu wyliczeniowego.
INVALID_USER_LIST_TYPE Typ listy użytkowników nie ma zastosowania do tego żądania.
INVALID_AUDIENCE_MEMBER Ten odbiorca jest nieprawidłowy.
TOO_MANY_AUDIENCE_MEMBERS Maksymalna dozwolona liczba członków listy odbiorców na żądanie to 10 000.
TOO_MANY_USER_IDENTIFIERS Maksymalna dozwolona liczba identyfikatorów użytkownika na członka listy odbiorców to 10.
TOO_MANY_DESTINATIONS Maksymalna liczba miejsc docelowych dozwolonych w przypadku jednego żądania to 10.
INVALID_DESTINATION To miejsce docelowe jest nieprawidłowe.
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED Partner danych nie ma dostępu do listy użytkowników należącej do konta operacyjnego.
INVALID_MOBILE_ID_FORMAT Format identyfikatora urządzenia mobilnego jest nieprawidłowy.
INVALID_USER_LIST_ID Lista użytkowników jest nieprawidłowa.
MULTIPLE_DATA_TYPES_NOT_ALLOWED W jednym żądaniu nie można przesyłać wielu typów danych.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER Konfiguracje miejsc docelowych zawierające konto logowania DataPartner muszą mieć to samo konto logowania we wszystkich konfiguracjach miejsc docelowych.
TERMS_AND_CONDITIONS_NOT_SIGNED Wymagane warunki nie zostały zaakceptowane.
INVALID_NUMBER_FORMAT Nieprawidłowy format liczby.
INVALID_CONVERSION_ACTION_ID Identyfikator działania powodującego konwersję jest nieprawidłowy.
INVALID_CONVERSION_ACTION_TYPE Typ działania powodującego konwersję jest nieprawidłowy.
INVALID_CURRENCY_CODE Kod waluty nie jest obsługiwany.
INVALID_EVENT To wydarzenie jest nieprawidłowe.
TOO_MANY_EVENTS Maksymalna dozwolona liczba zdarzeń na żądanie to 10 000.
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS Na koncie docelowym nie są włączone konwersje rozszerzone dotyczące potencjalnych klientów.
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS Na koncie docelowym nie można korzystać z konwersji rozszerzonych ze względu na zasady Google dotyczące danych klientów. Skontaktuj się z przedstawicielem Google.
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED Konto docelowe nie zaakceptowało warunków dotyczących konwersji rozszerzonych.
DUPLICATE_DESTINATION_REFERENCE Co najmniej 2 miejsca docelowe w żądaniu mają to samo odwołanie.
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER Nieobsługiwane konto operacyjne do autoryzacji dostawcy danych.
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER Nieobsługiwane połączone konto do autoryzacji dostawcy danych.
NO_IDENTIFIERS_PROVIDED Dane zdarzeń nie zawierają identyfikatorów użytkowników ani identyfikatorów reklam.
INVALID_PROPERTY_TYPE Ten typ usługi nie jest obsługiwany.
INVALID_STREAM_TYPE Ten typ strumienia nie jest obsługiwany.
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT Połączone konto jest obsługiwane tylko wtedy, gdy konto logowania jest kontem DATA_PARTNER.
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH Konto logowania musi być takie samo jak konto operacyjne w danym przypadku użycia.
EVENT_TIME_INVALID Zdarzenie nie wystąpiło w dopuszczalnym przedziale czasu.
RESERVED_NAME_USED Parametr używa zarezerwowanej nazwy.
INVALID_EVENT_NAME Nazwa zdarzenia nie jest obsługiwana.
NOT_ALLOWLISTED Konto nie znajduje się na liście dozwolonych w przypadku tej funkcji.
INVALID_REQUEST_ID Identyfikator żądania użyty do pobrania stanu żądania jest nieprawidłowy. Stan można pobrać tylko w przypadku żądań, które zostały zrealizowane i nie mają wartości validate_only=true.
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT zdarzenie miało co najmniej 2 miejsca docelowe Google Analytics;
FIELD_VALUE_TOO_LONG Wartość pola jest za długa.
TOO_MANY_ELEMENTS Żądanie zawiera zbyt wiele elementów na liście.

Zdarzenie

Zdarzenie reprezentujące interakcję użytkownika z witryną lub aplikacją reklamodawcy.

Pola
destination_references[]

string

Opcjonalnie: Ciąg znaków referencyjny używany do określania miejsca docelowego. Jeśli to pole jest puste, zdarzenie zostanie wysłane do wszystkich destinations w żądaniu.

transaction_id

string

Opcjonalnie: Unikalny identyfikator tego wydarzenia. Wymagane w przypadku konwersji korzystających z wielu źródeł danych.

event_timestamp

Timestamp

Wymagane. Czas wystąpienia zdarzenia.

last_updated_timestamp

Timestamp

Opcjonalnie: Ostatnia aktualizacja wydarzenia.

user_data

UserData

Opcjonalnie: Fragmenty danych przekazywanych przez użytkowników, które reprezentują użytkownika powiązanego ze zdarzeniem.

consent

Consent

Opcjonalnie: Informacje o tym, czy powiązany użytkownik wyraził zgodę na różne rodzaje przetwarzania danych.

ad_identifiers

AdIdentifiers

Opcjonalnie: Identyfikatory i inne informacje używane do dopasowywania zdarzenia konwersji do innej aktywności online (np. kliknięć reklam).

currency

string

Opcjonalnie: Kod waluty powiązany ze wszystkimi wartościami pieniężnymi w tym zdarzeniu.

conversion_value

double

Opcjonalnie: Wartość konwersji powiązana ze zdarzeniem w przypadku konwersji opartych na wartości.

event_source

EventSource

Opcjonalnie: Sygnał wskazujący, gdzie wystąpiło zdarzenie (w internecie, aplikacji, sklepie stacjonarnym itp.).

event_device_info

DeviceInfo

Opcjonalnie: Informacje zebrane o urządzeniu używanym (jeśli dotyczy) w momencie wystąpienia zdarzenia.

cart_data

CartData

Opcjonalnie: Informacje o transakcji i produktach powiązanych ze zdarzeniem.

custom_variables[]

CustomVariable

Opcjonalnie: Dodatkowe informacje o parach klucz/wartość do wysłania do kontenerów konwersji (działanie powodujące konwersję lub aktywność FL).

experimental_fields[]

ExperimentalField

Opcjonalnie: Lista par klucz/wartość dla pól eksperymentalnych, które mogą zostać włączone do interfejsu API.

user_properties

UserProperties

Opcjonalnie: Informacje o użytkowniku ocenione przez reklamodawcę w momencie wystąpienia zdarzenia.

event_name

string

Opcjonalnie: Nazwa zdarzenia. Wymagany w przypadku zdarzeń GA4.

client_id

string

Opcjonalnie: Unikalny identyfikator instancji użytkownika klienta internetowego w tym strumieniu danych internetowych GA4.

user_id

string

Opcjonalnie: Unikalny identyfikator użytkownika zdefiniowany przez reklamodawcę.

additional_event_parameters[]

EventParameter

Opcjonalnie: Zbiór dowolnych parametrów zdarzenia, które mają być uwzględnione w zdarzeniu, a nie zostały jeszcze określone za pomocą innych pól strukturalnych.

EventParameter

Parametr zdarzenia dla zdarzeń GA4.

Pola
parameter_name

string

Wymagane. Nazwa parametru do użycia.

value

string

Wymagane. Ciąg znaków reprezentujący wartość parametru do ustawienia.

EventSource

Źródło zdarzenia.

Wartości w polu enum
EVENT_SOURCE_UNSPECIFIED Nieokreślone źródło zdarzeń. Nigdy nie należy go używać.
WEB Wydarzenie zostało wygenerowane w przeglądarce.
APP Wydarzenie zostało wygenerowane przez aplikację.
IN_STORE Wydarzenie zostało wygenerowane na podstawie transakcji w sklepie stacjonarnym.
PHONE Wydarzenie zostało wygenerowane na podstawie rozmowy telefonicznej.
OTHER Wydarzenie zostało wygenerowane z innych źródeł.

ExperimentalField

Eksperymentalne pole reprezentujące nieoficjalne pola.

Pola
field

string

Opcjonalnie: Nazwa pola do użycia.

value

string

Opcjonalnie: Wartość pola do ustawienia.

GcpWrappedKeyInfo

Informacje o kluczu opakowanym Google Cloud Platform.

Pola
key_type

KeyType

Wymagane. Typ algorytmu użytego do zaszyfrowania danych.

wip_provider

string

Wymagane. Dostawca puli Workload Identity wymagany do używania klucza KEK.

kek_uri

string

Wymagane. Identyfikator zasobu Cloud Key Management Service w Google Cloud Platform. Powinien mieć format „projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}”.

encrypted_dek

string

Wymagane. Zaszyfrowany klucz szyfrujący dane zakodowany w formacie base64.

KeyType

Typ algorytmu użytego do zaszyfrowania danych.

Wartości w polu enum
KEY_TYPE_UNSPECIFIED Nieokreślony typ klucza. Nigdy nie należy go używać.
XCHACHA20_POLY1305 Algorytm XChaCha20-Poly1305

IngestAudienceMembersRequest

Prośba o przesłanie członków grupy odbiorców do podanych miejsc docelowych. Zwraca wartość IngestAudienceMembersResponse.

Pola
destinations[]

Destination

Wymagane. Lista miejsc docelowych, do których mają być wysyłani odbiorcy.

audience_members[]

AudienceMember

Wymagane. Lista użytkowników, do których mają być wysyłane dane do określonych miejsc docelowych. W jednym żądaniu można wysłać maksymalnie 10 tys. AudienceMember zasobów.

consent

Consent

Opcjonalnie: Zgoda na poziomie żądania, która ma być stosowana do wszystkich użytkowników w żądaniu. Zgoda na poziomie użytkownika zastępuje zgodę na poziomie żądania i może być określona w każdym AudienceMember.

validate_only

bool

Opcjonalnie: Do celów testowych. Jeśli true, żądanie jest weryfikowane, ale nie wykonywane. Zwracane są tylko błędy, a nie wyniki.

encoding

Encoding

Opcjonalnie: Wymagane w przypadku przesyłania plików w UserData. Typ kodowania identyfikatorów użytkowników. W przypadku zaszyfrowanych identyfikatorów użytkowników jest to typ kodowania zaszyfrowanego ciągu znaków. W przypadku zaszyfrowanych identyfikatorów użytkowników z wartością hash jest to typ kodowania zewnętrznego zaszyfrowanego ciągu znaków, ale niekoniecznie wewnętrznego ciągu znaków z wartością hash. Oznacza to, że wewnętrzny ciąg znaków z wartością hash może być zakodowany w inny sposób niż zewnętrzny zaszyfrowany ciąg znaków. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.

encryption_info

EncryptionInfo

Opcjonalnie: Informacje o szyfrowaniu przesyłanych plików UserData. Jeśli nie jest ustawiona, zakłada się, że przesłane informacje umożliwiające identyfikację są zahaszowane, ale nie zaszyfrowane. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.

terms_of_service

TermsOfService

Opcjonalnie: Warunki korzystania z usługi, które użytkownik zaakceptował lub odrzucił.

IngestAudienceMembersResponse

Odpowiedź z IngestAudienceMembersRequest.

Pola
request_id

string

Automatycznie wygenerowany identyfikator żądania.

IngestEventsRequest

Prośba o przesłanie członków grupy odbiorców do podanych miejsc docelowych. Zwraca wartość IngestEventsResponse.

Pola
destinations[]

Destination

Wymagane. Lista miejsc docelowych, do których mają być wysyłane zdarzenia.

events[]

Event

Wymagane. Lista zdarzeń do wysłania do określonych miejsc docelowych. W jednym żądaniu można wysłać maksymalnie 2000 zasobów Event.

consent

Consent

Opcjonalnie: Zgoda na poziomie żądania, która ma być stosowana do wszystkich użytkowników w żądaniu. Zgoda na poziomie użytkownika zastępuje zgodę na poziomie żądania i może być określona w każdym Event.

validate_only

bool

Opcjonalnie: Do celów testowych. Jeśli true, żądanie jest weryfikowane, ale nie wykonywane. Zwracane są tylko błędy, a nie wyniki.

encoding

Encoding

Opcjonalnie: Wymagane w przypadku przesyłania plików w UserData. Typ kodowania identyfikatorów użytkowników. W przypadku zaszyfrowanych identyfikatorów użytkowników jest to typ kodowania zaszyfrowanego ciągu znaków. W przypadku zaszyfrowanych identyfikatorów użytkowników z wartością hash jest to typ kodowania zewnętrznego zaszyfrowanego ciągu znaków, ale niekoniecznie wewnętrznego ciągu znaków z wartością hash. Oznacza to, że wewnętrzny ciąg znaków z wartością hash może być zakodowany w inny sposób niż zewnętrzny zaszyfrowany ciąg znaków. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.

encryption_info

EncryptionInfo

Opcjonalnie: Informacje o szyfrowaniu przesyłanych plików UserData. Jeśli nie jest ustawiona, zakłada się, że przesłane informacje umożliwiające identyfikację są zahaszowane, ale nie zaszyfrowane. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.

IngestEventsResponse

Odpowiedź z IngestEventsRequest.

Pola
request_id

string

Automatycznie wygenerowany identyfikator żądania.

Element

Reprezentuje produkt w koszyku powiązany ze zdarzeniem.

Pola
merchant_product_id

string

Opcjonalnie: Identyfikator produktu na koncie Merchant Center.

quantity

int64

Opcjonalnie: Liczba tego produktu powiązanego ze zdarzeniem.

unit_price

double

Opcjonalnie: Cena jednostkowa bez podatku, dostawy i wszelkich rabatów na poziomie transakcji.

item_id

string

Opcjonalnie: Unikalny identyfikator, który umożliwia odwoływanie się do elementu.

additional_item_parameters[]

ItemParameter

Opcjonalnie: Zbiór parametrów zdarzenia związanych z produktem, które mają być uwzględnione w zdarzeniu, a nie zostały jeszcze określone za pomocą innych pól strukturalnych.

ItemParameter

Zbiór parametrów zdarzenia związanych z produktem, które mają być uwzględnione w zdarzeniu, a nie zostały jeszcze określone za pomocą innych pól strukturalnych.

Pola
parameter_name

string

Wymagane. Nazwa parametru do użycia.

value

string

Wymagane. Ciąg znaków reprezentujący wartość parametru do ustawienia.

MatchRateRange

Zakres współczynnika dopasowania przesłanych danych lub listy użytkowników.

Wartości w polu enum
MATCH_RATE_RANGE_UNKNOWN Zakres współczynnika dopasowania jest nieznany.
MATCH_RATE_RANGE_NOT_ELIGIBLE Zakres współczynnika dopasowania jest nieprawidłowy.
MATCH_RATE_RANGE_LESS_THAN_20 Zakres współczynnika dopasowania jest mniejszy niż 20% (w przedziale [0, 20)).
MATCH_RATE_RANGE_20_TO_30 Zakres współczynnika dopasowania wynosi od 20% do 30% (w przedziale [20, 31)).
MATCH_RATE_RANGE_31_TO_40 Zakres współczynnika dopasowania wynosi od 31% do 40% (w przedziale [31, 41)).
MATCH_RATE_RANGE_41_TO_50 Współczynnik dopasowania mieści się w zakresie od 41% do 50% (w przedziale [41, 51)).
MATCH_RATE_RANGE_51_TO_60 Zakres współczynnika dopasowania wynosi od 51% do 60% (w przedziale [51, 61).
MATCH_RATE_RANGE_61_TO_70 Zakres współczynnika dopasowania wynosi od 61% do 70% (w przedziale [61, 71)).
MATCH_RATE_RANGE_71_TO_80 Zakres współczynnika dopasowania wynosi od 71% do 80% (w przedziale [71, 81)).
MATCH_RATE_RANGE_81_TO_90 Zakres współczynnika dopasowania wynosi od 81% do 90% (w przedziale [81, 91)).
MATCH_RATE_RANGE_91_TO_100

Zakres współczynnika dopasowania wynosi od 91% do 100% (w przedziale [91, 100]).

MobileData

Identyfikatory mobilne odbiorców. Wymagany jest co najmniej 1 identyfikator urządzenia mobilnego.

Pola
mobile_ids[]

string

Wymagane. Lista identyfikatorów urządzeń mobilnych (identyfikatorów wyświetlania reklam lub IDFA). W jednym elemencie AudienceMember można podać maksymalnie 10 elementów mobileIds.

PairData

Identyfikatory PAIR dla odbiorców. Wymagany jest co najmniej 1 identyfikator PAIR.

Pola
pair_ids[]

string

Wymagane. Dane osobowe dostarczone przez usługę data clean room, zaszyfrowane algorytmem SHA256 i zaszyfrowane za pomocą przemiennego szyfru EC z użyciem klucza wydawcy na potrzeby listy użytkowników PAIR. W jednym elemencie AudienceMember można podać maksymalnie 10 elementów pairIds.

ProcessingErrorReason

Przyczyna błędu przetwarzania.

Wartości w polu enum
PROCESSING_ERROR_REASON_UNSPECIFIED Przyczyna błędu przetwarzania jest nieznana.
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE Zmienna niestandardowa jest nieprawidłowa.
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED Stan zmiennej niestandardowej nie jest włączony.
PROCESSING_ERROR_REASON_EVENT_TOO_OLD Konwersja jest starsza niż maksymalny obsługiwany wiek.
PROCESSING_ERROR_REASON_DUPLICATE_GCLID W systemie istnieje już konwersja z tym samym identyfikatorem kliknięcia Google i czasem konwersji.
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID Konwersja z tą samą kombinacją identyfikatora zamówienia i działania powodującego konwersję została już przesłana.
PROCESSING_ERROR_REASON_INVALID_GBRAID Nie udało się zdekodować parametru gbraid.
PROCESSING_ERROR_REASON_INVALID_GCLID Nie udało się zdekodować identyfikatora kliknięcia Google.
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID Identyfikator sprzedawcy zawiera znaki inne niż cyfry.
PROCESSING_ERROR_REASON_INVALID_WBRAID Nie udało się zdekodować parametru wbraid.
PROCESSING_ERROR_REASON_INTERNAL_ERROR Błąd wewnętrzny.
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED Warunki konwersji rozszerzonych nie zostały podpisane na koncie docelowym.
PROCESSING_ERROR_REASON_INVALID_EVENT Wydarzenie jest nieprawidłowe.
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS Liczba dopasowanych transakcji jest mniejsza niż minimalny próg.
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS Transakcje są poniżej progu minimalnego.
PROCESSING_ERROR_REASON_INVALID_FORMAT Wydarzenie ma błąd formatu.
PROCESSING_ERROR_REASON_DECRYPTION_ERROR Wydarzenie zawiera błąd odszyfrowywania.
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR Nie udało się odszyfrować klucza DEK.
PROCESSING_ERROR_REASON_INVALID_WIP Identyfikator WIP ma nieprawidłowy format lub nie istnieje.
PROCESSING_ERROR_REASON_INVALID_KEK Klucz KEK nie może odszyfrować danych, ponieważ jest nieprawidłowy lub nie istnieje.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED Nie można było użyć tożsamości WIP, ponieważ została odrzucona przez warunek atestu.
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED System nie miał uprawnień potrzebnych do uzyskania dostępu do klucza KEK.
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED Nie udało się uwierzytelnić w AWS.
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Nie udało się odszyfrować danych UserIdentifier za pomocą klucza DEK.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER Użytkownik próbował przesyłać zdarzenia z identyfikatorem reklamy, który nie pochodzi z reklam na koncie operacyjnym.

ProcessingWarningReason

Przyczyna ostrzeżenia dotyczącego przetwarzania.

Wartości w polu enum
PROCESSING_WARNING_REASON_UNSPECIFIED Przyczyna ostrzeżenia o przetwarzaniu jest nieznana.
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED System nie miał uprawnień potrzebnych do uzyskania dostępu do klucza KEK.
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR Nie udało się odszyfrować klucza DEK.
PROCESSING_WARNING_REASON_DECRYPTION_ERROR Wydarzenie zawiera błąd odszyfrowywania.
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED Nie można było użyć tożsamości WIP, ponieważ została odrzucona przez warunek atestu.
PROCESSING_WARNING_REASON_INVALID_WIP Identyfikator WIP ma nieprawidłowy format lub nie istnieje.
PROCESSING_WARNING_REASON_INVALID_KEK Klucz KEK nie może odszyfrować danych, ponieważ jest nieprawidłowy lub nie istnieje.
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Nie udało się odszyfrować danych UserIdentifier za pomocą klucza DEK.
PROCESSING_WARNING_REASON_INTERNAL_ERROR Błąd wewnętrzny.
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED Nie udało się uwierzytelnić w AWS.

Produkt

Rola wycofana. Zamiast niej użyj zasady AccountType. Reprezentuje konkretną usługę Google.

Wartości w polu enum
PRODUCT_UNSPECIFIED Nieokreślony produkt. Nigdy nie należy go używać.
GOOGLE_ADS Google Ads,
DISPLAY_VIDEO_PARTNER partnera Display & Video 360.
DISPLAY_VIDEO_ADVERTISER reklamodawcą Display & Video 360;
DATA_PARTNER Dostawca danych.

ProductAccount

Reprezentuje konkretne konto.

Pola
product
(deprecated)

Product

Rola wycofana. Zamiast niej użyj zasady account_type.

account_id

string

Wymagane. Identyfikator konta. Na przykład identyfikator konta Google Ads.

account_type

AccountType

Opcjonalnie: Typ konta. Na przykład: GOOGLE_ADS. Wymagana jest właściwość account_type lub wycofana product. Jeśli oba są ustawione, wartości muszą być zgodne.

AccountType

Reprezentuje typy kont Google. Służy do lokalizowania kont i miejsc docelowych.

Wartości w polu enum
ACCOUNT_TYPE_UNSPECIFIED Nieokreślony produkt. Nigdy nie należy go używać.
GOOGLE_ADS Google Ads,
DISPLAY_VIDEO_PARTNER partnera Display & Video 360.
DISPLAY_VIDEO_ADVERTISER reklamodawcą Display & Video 360;
DATA_PARTNER Dostawca danych.
GOOGLE_ANALYTICS_PROPERTY Google Analytics.

RemoveAudienceMembersRequest

Prośba o usunięcie użytkowników z grupy odbiorców w podanych miejscach docelowych. Zwraca wartość RemoveAudienceMembersResponse.

Pola
destinations[]

Destination

Wymagane. Lista miejsc docelowych, z których chcesz usunąć użytkowników.

audience_members[]

AudienceMember

Wymagane. Lista użytkowników do usunięcia.

validate_only

bool

Opcjonalnie: Do celów testowych. Jeśli true, żądanie jest weryfikowane, ale nie wykonywane. Zwracane są tylko błędy, a nie wyniki.

encoding

Encoding

Opcjonalnie: Wymagane w przypadku przesyłania plików w UserData. Typ kodowania identyfikatorów użytkowników. Dotyczy tylko zewnętrznego kodowania zaszyfrowanych identyfikatorów użytkowników. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.

encryption_info

EncryptionInfo

Opcjonalnie: Informacje o szyfrowaniu przesyłanych plików UserData. Jeśli nie jest ustawiona, zakłada się, że przesłane informacje umożliwiające identyfikację są zahaszowane, ale nie zaszyfrowane. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.

RemoveAudienceMembersResponse

Odpowiedź z RemoveAudienceMembersRequest.

Pola
request_id

string

Automatycznie wygenerowany identyfikator żądania.

RequestStatusPerDestination

Stan żądania dla każdego miejsca docelowego.

Pola
destination

Destination

Miejsce docelowe w żądaniu do interfejsu DM API.

request_status

RequestStatus

Stan prośby o miejsce docelowe.

error_info

ErrorInfo

Informacje o błędzie zawierające przyczynę błędu i liczbę błędów związanych z przesyłaniem.

warning_info

WarningInfo

Informacje ostrzegawcze zawierające powód ostrzeżenia i liczbę ostrzeżeń związanych z przesłanym plikiem.

Pole zbiorcze status. Stan miejsca docelowego. status może mieć tylko jedną z tych wartości:
audience_members_ingestion_status

IngestAudienceMembersStatus

Stan żądania dotyczącego przesyłania danych o członkach listy odbiorców.

events_ingestion_status

IngestEventsStatus

Stan żądania dotyczącego zdarzeń przesyłanych do systemu.

audience_members_removal_status

RemoveAudienceMembersStatus

Stan prośby o usunięcie członków listy odbiorców.

IngestAudienceMembersStatus

Stan żądania dotyczącego przesyłania danych o członkach listy odbiorców.

Pola
Pole zbiorcze status. Stan przesyłania danych o członkach listy odbiorców do usługi docelowej. status może mieć tylko jedną z tych wartości:
user_data_ingestion_status

IngestUserDataStatus

Stan przesyłania danych użytkownika do miejsca docelowego.

mobile_data_ingestion_status

IngestMobileDataStatus

Stan przesyłania danych mobilnych do miejsca docelowego.

pair_data_ingestion_status

IngestPairDataStatus

Stan pozyskiwania danych par do miejsca docelowego.

IngestEventsStatus

Stan przesyłania zdarzeń do miejsca docelowego.

Pola
record_count

int64

Łączna liczba zdarzeń wysłanych w żądaniu przesyłania. Obejmuje wszystkie zdarzenia w żądaniu, niezależnie od tego, czy zostały przetworzone.

IngestMobileDataStatus

Stan przesyłania danych mobilnych do miejsca docelowego zawierającego statystyki związane z przesyłaniem.

Pola
record_count

int64

Łączna liczba członków listy odbiorców wysłanych w żądaniu przesyłania do miejsca docelowego. Obejmuje wszystkich członków listy odbiorców w żądaniu, niezależnie od tego, czy zostali oni prawidłowo przetworzeni.

mobile_id_count

int64

Łączna liczba identyfikatorów urządzeń mobilnych wysłanych w żądaniu przesyłania do miejsca docelowego. Obejmuje wszystkie identyfikatory mobilne w żądaniu, niezależnie od tego, czy zostały przetworzone.

IngestPairDataStatus

Stan przesyłania danych o parach do miejsca docelowego zawierającego statystyki związane z przesyłaniem.

Pola
record_count

int64

Łączna liczba członków listy odbiorców wysłanych w żądaniu przesyłania do miejsca docelowego. Obejmuje wszystkich członków listy odbiorców w żądaniu, niezależnie od tego, czy zostali oni prawidłowo przetworzeni.

pair_id_count

int64

Łączna liczba identyfikatorów par wysłanych w żądaniu przesłania do miejsca docelowego. Obejmuje wszystkie identyfikatory par w żądaniu, niezależnie od tego, czy zostały przetworzone.

IngestUserDataStatus

Stan przesyłania danych użytkownika do miejsca docelowego zawierającego statystyki związane z przesyłaniem.

Pola
record_count

int64

Łączna liczba członków listy odbiorców wysłanych w żądaniu przesyłania do miejsca docelowego. Obejmuje wszystkich członków listy odbiorców w żądaniu, niezależnie od tego, czy zostali oni prawidłowo przetworzeni.

user_identifier_count

int64

Łączna liczba identyfikatorów użytkowników wysłanych w żądaniu przesyłania do miejsca docelowego. Obejmuje wszystkie identyfikatory użytkowników w żądaniu, niezależnie od tego, czy zostały one przetworzone.

upload_match_rate_range

MatchRateRange

Zakres współczynnika dopasowania przesyłanych danych.

RemoveAudienceMembersStatus

Stan prośby o usunięcie członków listy odbiorców.

Pola
Pole zbiorcze status. Stan usunięcia członków listy odbiorców z miejsca docelowego. status może mieć tylko jedną z tych wartości:
user_data_removal_status

RemoveUserDataStatus

Stan usuwania danych użytkownika z miejsca docelowego.

mobile_data_removal_status

RemoveMobileDataStatus

Stan usunięcia danych mobilnych z miejsca docelowego.

pair_data_removal_status

RemovePairDataStatus

Stan usuwania danych z miejsca docelowego.

RemoveMobileDataStatus

Stan usunięcia danych mobilnych z miejsca docelowego.

Pola
record_count

int64

Łączna liczba członków listy odbiorców wysłanych w żądaniu usunięcia. Obejmuje wszystkich członków grupy odbiorców w żądaniu, niezależnie od tego, czy zostali oni usunięci.

mobile_id_count

int64

Łączna liczba identyfikatorów mobilnych przesłanych w żądaniu usunięcia. Obejmuje wszystkie identyfikatory mobilne w żądaniu, niezależnie od tego, czy zostały usunięte.

RemovePairDataStatus

Stan usuwania danych z miejsca docelowego.

Pola
record_count

int64

Łączna liczba członków listy odbiorców wysłanych w żądaniu usunięcia. Obejmuje wszystkich członków grupy odbiorców w żądaniu, niezależnie od tego, czy zostali oni usunięci.

pair_id_count

int64

Łączna liczba identyfikatorów par wysłanych w żądaniu usunięcia. Obejmuje wszystkie identyfikatory par w żądaniu, niezależnie od tego, czy zostały usunięte.

RemoveUserDataStatus

Stan usuwania danych użytkownika z miejsca docelowego.

Pola
record_count

int64

Łączna liczba członków listy odbiorców wysłanych w żądaniu usunięcia. Obejmuje wszystkich członków grupy odbiorców w żądaniu, niezależnie od tego, czy zostali oni usunięci.

user_identifier_count

int64

Łączna liczba identyfikatorów użytkowników przesłanych w żądaniu usunięcia. Obejmuje wszystkie identyfikatory użytkowników w żądaniu, niezależnie od tego, czy zostały one usunięte.

RequestStatus

Stan prośby.

Wartości w polu enum
REQUEST_STATUS_UNKNOWN Stan prośby jest nieznany.
SUCCESS Żądanie zostało zrealizowane.
PROCESSING Żądanie jest przetwarzane.
FAILED Żądanie nie zostało przetworzone.
PARTIAL_SUCCESS Żądanie zostało częściowo zrealizowane.

RetrieveRequestStatusRequest

Żądanie pobrania stanu żądania wysłanego do interfejsu DM API dla danego identyfikatora żądania. Zwraca wartość RetrieveRequestStatusResponse.

Pola
request_id

string

Wymagane. Wymagane. Identyfikator żądania do interfejsu Data Manager API.

RetrieveRequestStatusResponse

Odpowiedź z RetrieveRequestStatusRequest.

Pola
request_status_per_destination[]

RequestStatusPerDestination

Lista stanów żądań dla każdego miejsca docelowego. Kolejność stanów odpowiada kolejności miejsc docelowych w pierwotnym żądaniu.

TermsOfService

Warunki korzystania z usługi, które użytkownik zaakceptował lub odrzucił.

Pola
customer_match_terms_of_service_status

TermsOfServiceStatus

Opcjonalnie: Warunki korzystania z usługi kierowania na listę klientów: https://support.google.com/adspolicy/answer/6299717. Musisz zaakceptować te warunki podczas przesyłania danych UserData lub MobileData. To pole nie jest wymagane w przypadku listy użytkowników kierowania na listę klientów partnera.

TermsOfServiceStatus

Określa, czy rozmówca zaakceptował warunki usługi.

Wartości w polu enum
TERMS_OF_SERVICE_STATUS_UNSPECIFIED Nie określono.
ACCEPTED Stan wskazujący, że dzwoniący zaakceptował warunki usługi.
REJECTED Stan wskazujący, że dzwoniący odrzucił warunki usługi.

UserData

Dane identyfikujące użytkownika. Wymagany jest co najmniej 1 identyfikator.

Pola
user_identifiers[]

UserIdentifier

Wymagane. Identyfikatory użytkownika. Możesz podać wiele wystąpień tego samego typu danych (np. wiele adresów e-mail). Aby zwiększyć prawdopodobieństwo dopasowania, podaj jak najwięcej identyfikatorów. W jednym pliku AudienceMember lub Event można podać maksymalnie 10 wartości userIdentifiers.

UserIdentifier

Pojedynczy identyfikator użytkownika.

Pola
Pole zbiorcze identifier. Musisz podać dokładnie jedną wartość. identifier może mieć tylko jedną z tych wartości:
email_address

string

Zahaszowany adres e-mail za pomocą funkcji SHA-256 po normalizacji.

phone_number

string

Zahaszowany numer telefonu za pomocą funkcji SHA-256 po normalizacji (standard E164).

address

AddressInfo

Znane elementy adresu użytkownika. Zawiera grupę identyfikatorów, które są dopasowywane jednocześnie.

UserProperties

Informacje o użytkowniku ocenione przez reklamodawcę w momencie wystąpienia zdarzenia. Więcej informacji znajdziesz na stronie https://support.google.com/google-ads/answer/14007601.

Pola
customer_type

CustomerType

Opcjonalnie: Typ klienta powiązanego ze zdarzeniem.

customer_value_bucket

CustomerValueBucket

Opcjonalnie: Wartość klienta określona przez reklamodawcę.

additional_user_properties[]

UserProperty

Opcjonalnie: Zbiór dodatkowych właściwości użytkownika powiązanych z tym zdarzeniem.

UserProperty

Zbiór dodatkowych właściwości użytkownika powiązanych z tym zdarzeniem.

Pola
property_name

string

Wymagane. Nazwa właściwości użytkownika do użycia.

value

string

Wymagane. Ciąg znaków reprezentujący wartość właściwości użytkownika do użycia.

WarningCount

Liczba ostrzeżeń z danego powodu.

Pola
record_count

int64

Liczba rekordów, które zawierają ostrzeżenie.

reason

ProcessingWarningReason

Powód ostrzeżenia.

WarningInfo

Liczba ostrzeżeń dla każdego typu ostrzeżenia.

Pola
warning_counts[]

WarningCount

Lista ostrzeżeń i liczba ostrzeżeń według przyczyny.