REST Resource: curators.reports

Zasób: raport

Zasób Report.

Zapis JSON
{
  "name": string,
  "reportId": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "displayName": string,
  "updateTime": string,
  "createTime": string,
  "locale": string
}
Pola
name

string

Identyfikator. Nazwa zasobu raportu. Nazwa zasobu raportu ma postać: curators/{accountId}/reports/{reportId}

reportId

string (int64 format)

Tylko dane wyjściowe. Identyfikator raportu.

reportDefinition

object (ReportDefinition)

Wymagane. Definicja raportu.

displayName

string

Opcjonalnie: Wyświetlana nazwa raportu.

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Moment ostatniej modyfikacji tego raportu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

createTime

string (Timestamp format)

Tylko dane wyjściowe. Moment utworzenia tego raportu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

locale

string

Tylko dane wyjściowe. Ustawienia regionalne tego raportu. Ustawienia regionalne są określane na podstawie ustawień regionalnych użytkownika w momencie wysyłania żądania. Nie można zmienić ustawień regionalnych.

ReportDefinition

Definicja sposobu generowania raportu.

Zapis JSON
{
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "timeZoneSource": enum (TimeZoneSource),
  "timeZone": string,
  "currencyCode": string,
  "dateRange": {
    object (DateRange)
  },
  "sorts": [
    {
      object (Sort)
    }
  ]
}
Pola
dimensions[]

enum (Dimension)

Wymagane. Lista wymiarów, które mają być uwzględnione w raporcie. Jeśli pole jest puste, raport nie będzie zawierać wymiarów, a wszystkie dane będą sumami.

metrics[]

enum (Metric)

Wymagane. Lista danych, które mają być uwzględnione w raporcie. Jeśli pole jest puste, raport nie będzie zawierać żadnych danych.

filters[]

object (Filter)

Opcjonalnie: Filtry tego raportu.

timeZoneSource

enum (TimeZoneSource)

Opcjonalnie: Gdzie można znaleźć strefę czasową tego raportu. Domyślnie używana jest strefa czasu pacyficznego (PT). Jeśli źródło to PROVIDED, pole timeZone w definicji raportu musi również określać strefę czasową.

timeZone

string

Opcjonalnie: Jeśli parametr timeZoneSource ma wartość PROVIDED, jest to strefa czasowa, która zostanie użyta w tym raporcie. Pozostaw puste w przypadku innych źródeł strefy czasowej. Strefa czasowa w formacie IANA. Na przykład „America/New_York”.

currencyCode

string

Opcjonalnie: Kod waluty ISO 4217 dla tego raportu. Jeśli nie zostanie podany, domyślnie przyjmuje się kod waluty konta.

dateRange

object (DateRange)

Wymagane. Główny zakres dat tego raportu.

sorts[]

object (Sort)

Opcjonalnie: Domyślne sortowanie, które ma być stosowane w tym raporcie.

Wymiar

Wymiary raportowania.

Wartości w polu enum
DIMENSION_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
ADVERTISER_DOMAIN Domena reklamodawcy.
COUNTRY Wyświetlana nazwa kraju.
CURATION_DATA_SEGMENT_ID Identyfikator segmentu danych utworzonego przez podmiot dokonujący selekcji.
CURATION_DATA_SEGMENT_RESPONSE_STATUS Stan odpowiedzi na żądania segmentów danych w ramach wyboru w czasie rzeczywistym. Szczegółowe informacje znajdziesz na stronie https://developers.google.com/authorized-buyers/curation/get-started/start.
CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME Zlokalizowana wyświetlana nazwa stanu odpowiedzi na żądania segmentu danych w wyborze w czasie rzeczywistym. Szczegółowe informacje znajdziesz na stronie https://developers.google.com/authorized-buyers/curation/get-started/start.
CURATOR_FEE_TYPE Typ usługi wyboru (np. pakiet lub segment danych).
DATE Data.
DEAL_ID Identyfikator umowy.
DEAL_NAME Nazwa umowy.
DETECTED_ADVERTISER_NAME Wyświetlana nazwa wykrytego reklamodawcy.
DSP_NAME Wyświetlana nazwa platformy DSP.
DSP_SEAT_ID Identyfikator stanowiska na platformie DSP.
ENVIRONMENT Urządzenie użytkownika i środowisko kontenera, w którym nastąpiło wyświetlenie. Obsługiwane wartości to „app” i „web”.
ENVIRONMENT_NAME Zlokalizowana wyświetlana nazwa urządzenia użytkownika i środowiska kontenera, w którym nastąpiło wyświetlenie. Obsługiwane wartości to „app” i „web”.
HOLDING_COMPANY_NAME Wyświetlana nazwa holdingu.
HOUR Godzina.
MOBILE_APP_ID Identyfikator aplikacji mobilnej.
MOBILE_APP_NAME Nazwa aplikacji mobilnej.
MOBILE_OS System operacyjny urządzenia mobilnego.
MONTH Miesiąc.
PACKAGE_FEE_VISIBILITY widoczność opłaty za pakiet (np. ujawniona lub nieujawniona).
PLATFORM Platforma, np. „komputer” lub „urządzenie mobilne”.
PUBLISHER_DOMAIN Domena wydawcy.
PUBLISHER_ID Identyfikator wydawcy.
PUBLISHER_NAME Nazwa wydawcy.
WEEK Tydzień.

Wskaźnik

Dane raportowania.

Wartości w polu enum
METRIC_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
ACTIVE_VIEW_MEASURABILITY_RATE Współczynnik wymierności w Widoku aktywnym.
ACTIVE_VIEW_MEASURABLE Wymierne w Widoku aktywnym.
ACTIVE_VIEW_VIEWABILITY_RATE Współczynnik widoczności w Widoku aktywnym.
ACTIVE_VIEW_VIEWABLE Widoczne wyśw. w Widoku aktywnym
AUCTIONS_WON Wygrane aukcje.
BIDS Stawki.
BIDS_IN_AUCTION Stawki w aukcji.
BID_REQUESTS Pytania o stawkę.
CLICKS Kliknięcia.
CURATION_PARTNER_FEE Opłata za selekcję. Jeśli widoczność pakietu jest ustawiona jako nieujawniona, ta wartość zostanie zmieniona na 0,00. Użyj wymiaru PACKAGE_FEE_VISIBILITY, aby sprawdzić, czy opłata za pakiet jest ujawniona.
DATA_SEGMENT_REQUESTS Liczba żądań segmentów danych wysłanych w ramach wyboru w czasie rzeczywistym.
IMPRESSIONS Wyświetlenia.
SPEND Wydatki w walucie raportów określonej w żądaniu. Domyślna waluta to USD.

Filtruj

Filtr obejmujący co najmniej 1 pole.

Zapis JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fieldFilter": {
    object (FieldFilter)
  },
  "notFilter": {
    object (Filter)
  },
  "andFilter": {
    object (FilterList)
  },
  "orFilter": {
    object (FilterList)
  }
  // End of mutually exclusive fields.
}
Pola
Typ określa sposób łączenia filtrów podstawowych. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
fieldFilter

object (FieldFilter)

Filtr dotyczący jednego pola.

notFilter

object (Filter)

Filtr, którego wynik jest negowany.

andFilter

object (FilterList)

Lista filtrów, których wyniki są połączone operatorem AND.

orFilter

object (FilterList)

Lista filtrów, których wyniki są połączone operatorem OR.

Koniec pól wykluczających się wzajemnie.

FieldFilter

filtr dotyczący konkretnego pola,

Zapis JSON
{
  "field": {
    object (Field)
  },
  "operation": enum (Operation),
  "values": [
    {
      object (ReportValue)
    }
  ]
}
Pola
field

object (Field)

Wymagane. Pole, według którego chcesz filtrować.

operation

enum (Operation)

Wymagane. Działanie tego filtra.

values[]

object (ReportValue)

Wymagane. Wartości, według których chcesz filtrować.

Pole

Wymiar lub dane w raporcie.

Zapis JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of mutually exclusive fields.
}
Pola
Wymiar lub dane. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
dimension

enum (Dimension)

Wymiar, który reprezentuje to pole.

metric

enum (Metric)

Dane, które reprezentuje to pole.

Koniec pól wykluczających się wzajemnie.

Operacja

Obsługiwane operacje filtrowania.

Wartości w polu enum
IN

W przypadku operandów skalarnych sprawdza, czy operand znajduje się w zbiorze podanych wartości filtra.

W przypadku operandów listy sprawdza, czy którykolwiek element operandu znajduje się w zbiorze podanych wartości filtra.

Wartość domyślna.

NOT_IN

W przypadku operandów skalarnych sprawdza, czy operand nie znajduje się w zbiorze podanych wartości filtra.

W przypadku operandów listy sprawdza, czy żaden z elementów operandu nie znajduje się w zbiorze podanych wartości filtra.

CONTAINS

W przypadku operandów będących ciągami skalarnymi sprawdza, czy operand zawiera którykolwiek z podanych podłańcuchów filtra.

W przypadku operandów listy ciągów znaków sprawdza, czy którykolwiek ciąg znaków w operandzie zawiera którykolwiek z podanych podłańcuchów filtra.

NOT_CONTAINS

W przypadku operandów ciągów skalarnych sprawdza, czy operand nie zawiera żadnego z podanych podłańcuchów filtra.

W przypadku operandów listy ciągów znaków sprawdza, czy żaden z ciągów znaków w operandzie nie zawiera żadnego z podanych podłańcuchów filtra.

LESS_THAN Operand jest mniejszy niż podana wartość filtra.
LESS_THAN_EQUALS Operand jest mniejszy lub równy podanej wartości filtra.
GREATER_THAN Operand jest większy niż podana wartość filtra.
GREATER_THAN_EQUALS Operand jest większy niż podana wartość filtra lub jej równy.
BETWEEN Operand znajduje się między podanymi wartościami filtra.
MATCHES Operand pasuje do wyrażenia regularnego lub zbioru wyrażeń regularnych (musi pasować do jednego z nich).
NOT_MATCHES Operand nie pasuje do wyrażenia regularnego lub zbioru wyrażeń regularnych (żadne nie może pasować).

ReportValue

Reprezentuje pojedynczą wartość w raporcie.

Zapis JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "intValue": string,
  "doubleValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "intListValue": {
    object (IntList)
  },
  "stringListValue": {
    object (StringList)
  },
  "doubleListValue": {
    object (DoubleList)
  },
  "bytesValue": string
  // End of mutually exclusive fields.
}
Pola
Wartość pola zależy od formatu danych pola. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
intValue

string (int64 format)

W przypadku liczb całkowitych.

doubleValue

number

W przypadku wartości double.

stringValue

string

W przypadku wartości w postaci ciągu znaków.

boolValue

boolean

W przypadku wartości logicznych.

intListValue

object (IntList)

Listy wartości całkowitych.

stringListValue

object (StringList)

W przypadku list wartości ciągów znaków.

doubleListValue

object (DoubleList)

Listy wartości typu double.

bytesValue

string (bytes format)

Wartości w bajtach.

Ciąg znaków zakodowany w formacie Base64.

Koniec pól wykluczających się wzajemnie.

IntList

Lista liczb całkowitych.

Zapis JSON
{
  "values": [
    string
  ]
}
Pola
values[]

string (int64 format)

Wartości

StringList

Lista wartości w formie ciągu znaków.

Zapis JSON
{
  "values": [
    string
  ]
}
Pola
values[]

string

Wartości

DoubleList

Lista wartości typu double.

Zapis JSON
{
  "values": [
    number
  ]
}
Pola
values[]

number

Wartości

FilterList

Lista filtrów.

Zapis JSON
{
  "filters": [
    {
      object (Filter)
    }
  ]
}
Pola
filters[]

object (Filter)

Wymagane. Lista filtrów.

TimeZoneSource

Źródło, które określa strefę czasową raportu.

Wartości w polu enum
TIME_ZONE_SOURCE_UNSPECIFIED Nieokreślona wartość domyślna.
AD_EXCHANGE Użyj strefy czasu pacyficznego(PT).
UTC Użyj strefy czasowej UTC.
PROVIDED Użyj strefy czasowej podanej w polu ReportDefinition.time_zone. Generowanie raportów może potrwać dłużej, ponieważ daty są obliczane dynamicznie w momencie wysłania żądania.
CURATOR Użyj strefy czasowej z ustawień konta kuratora.

Zakres dat

Zakres dat raportu.

Zapis JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixed": {
    object (FixedDateRange)
  },
  "relative": enum (RelativeDateRange)
  // End of mutually exclusive fields.
}
Pola
Stały lub względny zakres dat. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
fixed

object (FixedDateRange)

Stały zakres dat.

relative

enum (RelativeDateRange)

Względny zakres dat.

Koniec pól wykluczających się wzajemnie.

FixedDateRange

Zakres dat między 2 ustalonymi datami (włącznie z datą zakończenia).

Zapis JSON
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Pola
startDate

object (Date)

Wymagane. Data rozpoczęcia tego zakresu dat.

endDate

object (Date)

Wymagane. Data zakończenia (włącznie z tym dniem) tego zakresu dat.

Data

Reprezentuje pełną lub częściową datę kalendarzową, np. datę urodzin. Pora dnia i strefa czasowa są określone w innym miejscu lub nie mają znaczenia. Data jest podana w kalendarzu gregoriańskim. Może to być jedna z tych wartości:

  • Pełna data z wartościami roku, miesiąca i dnia różnymi od zera.
  • Miesiąc i dzień z rokiem zerowym (np. rocznica).
  • Sam rok z miesiącem i dniem zerowym.
  • Rok i miesiąc z dniem zerowym (np. data ważności karty kredytowej).

Powiązane typy:

Zapis JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Pola
year

integer

Rok daty. Musi mieścić się w zakresie od 1 do 9999 lub wynosić 0, jeśli określasz datę bez roku.

month

integer

Miesiąc roku. Musi mieścić się w zakresie od 1 do 12 lub wynosić 0, jeśli określasz rok bez miesiąca i dnia.

day

integer

Dzień miesiąca. Wartość musi mieścić się w zakresie od 1 do 31 i być prawidłowa w przypadku danego roku i miesiąca lub wynosić 0, jeśli określasz sam rok lub rok i miesiąc, gdy dzień nie jest istotny.

RelativeDateRange

Opcje względnych zakresów dat.

Wartości w polu enum
RELATIVE_DATE_RANGE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
TODAY Data wygenerowania raportu.
YESTERDAY Dzień poprzedzający datę wygenerowania raportu.
THIS_WEEK_TO_DATE Od początku tygodnia kalendarzowego, w którym wygenerowano raport, do dnia, w którym wygenerowano raport (włącznie).
THIS_WEEK_TO_YESTERDAY Od początku tygodnia kalendarzowego, w którym raport jest generowany, do dnia poprzedzającego wygenerowanie raportu (włącznie).
THIS_MONTH_TO_DATE Od początku miesiąca kalendarzowego, w którym raport jest generowany, do dnia, w którym raport jest generowany (włącznie).
THIS_MONTH_TO_YESTERDAY Od początku miesiąca kalendarzowego, w którym raport jest generowany, do dnia poprzedzającego wygenerowanie raportu (włącznie).
THIS_QUARTER_TO_DATE Od początku kwartału kalendarzowego, w którym raport jest generowany, do dnia, w którym raport jest generowany (włącznie).
THIS_QUARTER_TO_YESTERDAY Od początku kwartału kalendarzowego, w którym raport jest generowany, do dnia poprzedzającego wygenerowanie raportu (włącznie).
THIS_YEAR_TO_DATE Od początku roku kalendarzowego, w którym raport jest generowany, do dnia, w którym raport jest generowany (włącznie).
THIS_YEAR_TO_YESTERDAY Od początku roku kalendarzowego, w którym raport jest generowany, do dnia poprzedzającego dzień wygenerowania raportu (włącznie).
LAST_WEEK Cały poprzedni tydzień kalendarzowy, od poniedziałku do niedzieli (włącznie), poprzedzający tydzień kalendarzowy, w którym raport jest generowany.
LAST_WEEK_STARTING_SUNDAY Cały poprzedni tydzień kalendarzowy, od niedzieli do soboty (włącznie), poprzedzający tydzień kalendarzowy, w którym raport jest generowany.
LAST_MONTH Cały poprzedni miesiąc kalendarzowy poprzedzający miesiąc kalendarzowy, w którym raport jest generowany.
LAST_QUARTER Cały poprzedni kwartał kalendarzowy poprzedzający kwartał kalendarzowy, w którym raport jest generowany.
LAST_YEAR Cały poprzedni rok kalendarzowy poprzedzający rok kalendarzowy, w którym raport jest generowany.
LAST_7_DAYS 7 dni poprzedzających dzień uruchomienia raportu.
LAST_30_DAYS 30 dni poprzedzających dzień uruchomienia raportu.
LAST_60_DAYS 60 dni poprzedzających dzień uruchomienia raportu.
LAST_90_DAYS 90 dni poprzedzających dzień uruchomienia raportu.
LAST_93_DAYS 93 dni poprzedzające dzień uruchomienia raportu.
LAST_180_DAYS 180 dni poprzedzających dzień uruchomienia raportu.
LAST_360_DAYS 360 dni poprzedzających dzień uruchomienia raportu.
LAST_365_DAYS 365 dni poprzedzających dzień uruchomienia raportu.
LAST_3_MONTHS Całe 3 miesiące kalendarzowe poprzedzające miesiąc kalendarzowy, w którym raport jest generowany.
LAST_6_MONTHS Całe poprzednie 6 miesięcy kalendarzowych poprzedzających miesiąc kalendarzowy, w którym raport jest generowany.
LAST_12_MONTHS Całe poprzednie 12 miesięcy kalendarzowych poprzedzających miesiąc kalendarzowy, w którym raport jest generowany.
ALL_AVAILABLE Od 3 lat przed uruchomieniem raportu do dnia poprzedzającego uruchomienie raportu (włącznie).

Sortuj

Reprezentuje sortowanie w raporcie.

Zapis JSON
{
  "field": {
    object (Field)
  },
  "descending": boolean
}
Pola
field

object (Field)

Wymagane. Pole (wymiar lub dane), według którego chcesz sortować.

descending

boolean

Opcjonalnie: Kolejność sortowania. Jeśli ma wartość „true”, sortowanie będzie malejące.

Metody

create

Tworzy obiekt Report.

delete

Usuwa obiekt Report.

get

Pobiera obiekt Report.

list

Wyświetla listę obiektów Report.

patch

Aktualizuje obiekt Report.

run

Inicjuje asynchroniczne wykonywanie istniejącego raportu.