REST Resource: advertisers.campaigns

{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}

string

Tylko dane wyjściowe. Nazwa zasobu kampanii.

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator reklamodawcy, do którego należy kampania.

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator kampanii. Przypisana przez system.

string

Wymagane. Wyświetlana nazwa kampanii.

Musi być zakodowany w standardzie UTF-8 i maksymalnym rozmiarze 240 bajtów.

enum (EntityStatus)

Wymagane. Określa, czy zamówienia reklamowe w ramach tej kampanii mogą wydawać budżety i ustalać stawki za zasoby reklamowe.

• Akceptowane wartości to ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED i ENTITY_STATUS_PAUSED.
• W metodzie campaigns.create wartość ENTITY_STATUS_ARCHIVED jest niedozwolona.

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji kampanii. Przypisana przez system.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

object (CampaignGoal)

Wymagane. Cel kampanii.

object (CampaignFlight)

Wymagane. Planowane wydatki i czas trwania kampanii.

object (FrequencyCap)

Wymagane. Ustawienie limitu wyświetleń na użytkownika w kampanii.

object (CampaignBudget)

Lista budżetów dostępnych w tej kampanii.

Jeśli to pole nie jest skonfigurowane, kampania używa nieograniczonego budżetu.

{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}

enum (CampaignGoalType)

Wymagane. Typ celu kampanii.

object (PerformanceGoal)

Wymagane. Docelowa skuteczność kampanii.

Akceptowane wartości w polu performanceGoalType:

• PERFORMANCE_GOAL_TYPE_CPM
• PERFORMANCE_GOAL_TYPE_CPC
• PERFORMANCE_GOAL_TYPE_CPA
• PERFORMANCE_GOAL_TYPE_CPIAVC
• PERFORMANCE_GOAL_TYPE_CTR
• PERFORMANCE_GOAL_TYPE_VIEWABILITY
• PERFORMANCE_GOAL_TYPE_OTHER

{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}

enum (PerformanceGoalType)

Wymagane. Typ celu dotyczącego skuteczności.

string (int64 format)

Kwota docelowa w milionowych częściach waluty reklamodawcy.

Ma zastosowanie, gdy performanceGoalType należy do jednej z tych kategorii:

• PERFORMANCE_GOAL_TYPE_CPM
• PERFORMANCE_GOAL_TYPE_CPC
• PERFORMANCE_GOAL_TYPE_CPA
• PERFORMANCE_GOAL_TYPE_CPIAVC
• PERFORMANCE_GOAL_TYPE_VCPM

Na przykład 1500000 oznacza 1,5 standardowej jednostki waluty.

string (int64 format)

Wartość dziesiętna określająca odsetek celu w mikro.

Ma zastosowanie, gdy performanceGoalType należy do jednej z tych kategorii:

• PERFORMANCE_GOAL_TYPE_CTR
• PERFORMANCE_GOAL_TYPE_VIEWABILITY
• PERFORMANCE_GOAL_TYPE_CLICK_CVR
• PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
• PERFORMANCE_GOAL_TYPE_VTR
• PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
• PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

Na przykład 70 000 oznacza 7% (0, 07 w formacie dziesiętnym).

string

Ciąg tekstowy kluczowego wskaźnika wydajności (KPI), który może być pusty. Musi być zakodowany w formacie UTF-8 i nie może być dłuższy niż 100 znaków.

Ma zastosowanie, gdy zasada performanceGoalType ma wartość PERFORMANCE_GOAL_TYPE_OTHER.

{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}

string (int64 format)

Kwota, jaką kampania ma wydać w przypadku określonych plannedDates. Nie ograniczy to wyświetlania, ale będzie służyć do śledzenia wydatków w interfejsie DV360.

Ilość jest wyrażona w mikro. Wartość nie może być mniejsza niż 0. Na przykład 500000000 oznacza 500 standardowych jednostek waluty.

object (DateRange)

Wymagane. Przewidywane daty trwania kampanii. Są one ustalane według strefy czasowej reklamodawcy nadrzędnego.

• Podane tu daty nie wpłyną na wyświetlanie reklam. Służą do generowania alertów i ostrzeżeń. Jeśli na przykład data wyświetlania jakiegokolwiek podrzędnego zamówienia reklamowego wykracza poza zakres tych dat, w interfejsie pojawi się ostrzeżenie.
• Pole startDate jest wymagane i musi być bieżącą lub późniejszą datą.
• Pole endDate jest opcjonalne. Jeśli została określona, musi to być startDate lub nowsza.
• Każda podana data musi przypadać przed rokiem 2037.

{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}

string (int64 format)

Unikalny identyfikator budżetu kampanii. Przypisana przez system. Nie ustawiaj dla nowych budżetów.

Trzeba go uwzględnić przy aktualizowaniu lub dodawaniu budżetów do kampanii campaignBudgets. W przeciwnym razie zostanie wygenerowany i przypisany nowy identyfikator.

string

Wymagane. Wyświetlana nazwa budżetu.

Musi być zakodowany w standardzie UTF-8 i maksymalnym rozmiarze 240 bajtów.

enum (BudgetUnit)

Wymagane. Stały. Określa, czy budżet jest mierzony w walucie czy w wyświetleniach.

string (int64 format)

Wymagane. Łączna kwota, jaką mogą budżetować powiązane segmenty zamówienia reklamowego.

Ilość jest wyrażona w mikro. Musi być większy niż 0. Na przykład 500000000 oznacza 500 standardowych jednostek waluty.

object (DateRange)

Wymagane. Zakres dat dla budżetu kampanii. Połączone segmenty budżetu mogą mieć inny zakres dat. Są one ustalane według strefy czasowej reklamodawcy nadrzędnego.

Zarówno startDate, jak i endDate muszą przypadać przed rokiem 2037.

enum (ExternalBudgetSource)

Wymagane. Zewnętrzne źródło budżetu.

string

Stały. Identyfikator określający ten budżet dla źródła zewnętrznego.

Jeśli to pole jest określone, a poziom szczegółów faktury w odpowiednim profilu płatności jest ustawiony na „Zamówienie na poziomie budżetu”, wszystkie wyświetlenia realizowane w ramach tego budżetu będą zawierały ten identyfikator na fakturze.

Nie może się powtarzać w ramach kampanii.

string

Stały. Identyfikator służący do grupowania budżetów, które mają być uwzględnione na tej samej fakturze.

Jeśli to pole jest skonfigurowane, a poziom faktury w odpowiednim profilu płatności jest ustawiony na „Identyfikator grupowania faktur na poziomie budżetu”, wszystkie identyfikatory externalBudgetId korzystające z tego samego elementu invoiceGroupingId zostaną zgrupowane na tej samej fakturze.

object (PrismaConfig)

Dodatkowe metadane do wykorzystania przez narzędzie Mediaocean Prisma.

Wymagany w przypadku budżetów Mediaocean.

Dotyczy tylko reklamodawców prismaEnabled.

{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}

enum (PrismaType)

Wymagane. Typ Prisma.

object (PrismaCpeCode)

Wymagane. Odpowiednie kody dotyczące klientów, usług i szacunków z narzędzia Mediaocean Prisma.

string

Wymagane. Podmiot przeznaczył ten budżet (DSP, witryna itp.).

{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}

string

Kod klienta aplikacji Prisma.

string

Kod produktu Prisma.

string

Szacowany kod aplikacji Prisma.