REST Resource: accounts.promotions

Zasób: promocja

Oznacza promocję. Więcej informacji znajdziesz w tych artykułach:

Wymagane atrybuty danych promocji, które muszą przejść weryfikację danych, są określone poniżej:

Po wstawieniu i zaktualizowaniu danych promocji może minąć kilka minut, zanim będzie można pobrać ostateczną promocję.

Zapis JSON 
{
  "name": string,
  "promotionId": string,
  "contentLanguage": string,
  "targetCountry": string,
  "redemptionChannel": [
    enum (RedemptionChannel)
  ],
  "dataSource": string,
  "attributes": {
    object (Attributes)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "promotionStatus": {
    object (PromotionStatus)
  },
  "versionNumber": string
}
Pola
name

string

Identyfikator. Nazwa promocji. Format: accounts/{account}/promotions/{promotion}
promotionId

string

Wymagane. Użytkownik podał identyfikator promocji, aby jednoznacznie ją zidentyfikować. Aby zapobiec odrzuceniu promocji, pamiętaj o wymaganiach minimalnych.
contentLanguage

string

Wymagane. Dwuliterowy kod języka ISO 639-1 promocji.

Promocje są dostępne tylko w wybranych językach.
targetCountry

string

Wymagane. Kraj docelowy używany jako część unikalnego identyfikatora. Wyrażony jako kod regionu CLDR.

Promocje są dostępne tylko w wybranych krajach i w bezpłatnych informacjach i reklamach produktowych reklamach lokalnego asortymentu produktów
redemptionChannel[]

enum (RedemptionChannel)

Wymagane. Kanał wykorzystania promocji. Wymagany jest co najmniej 1 kanał.
dataSource

string

Tylko dane wyjściowe. Podstawowe źródło danych promocji.
attributes

object (Attributes)

Opcjonalnie: Lista atrybutów promocji.
customAttributes[]

object (CustomAttribute)

Opcjonalnie: Lista niestandardowych atrybutów (dostarczonych przez sprzedawcę). Można go też używać do przesyłania dowolnego atrybutu specyfikacji danych w formie ogólnej (np. { "name": "size type", "value": "regular" }). Jest to przydatne w przypadku atrybutów, których interfejs API nie udostępnia w prosty sposób.
promotionStatus

object (PromotionStatus)

Tylko dane wyjściowe. Stan promocji, problemy z weryfikacją danych, czyli informacje o promocji obliczane asynchronicznie.
versionNumber

string (int64 format)

Opcjonalnie: Reprezentuje bieżącą wersję (aktualność) promocji, która może służyć do zachowania prawidłowej kolejności, gdy wprowadzane są jednocześnie liczne aktualizacje.

Jeśli jest ustawiona, zapobiega wstawianiu, gdy numer wersji jest niższy niż bieżący numer wersji istniejącej promocji. Ponowne wstawienie (np. odświeżenie promocji po 30 dniach) można wykonać przy użyciu bieżącej wartości versionNumber.

Jeśli operacja zostanie zablokowana, zostanie wywołany wyjątek przerwania.

RedemptionChannel

Kanał promocji.

Wartości w polu enum
REDEMPTION_CHANNEL_UNSPECIFIED Wskazuje, że kanał jest nieokreślony.
IN_STORE Wskazuje, że kanał jest w sklepie. Jest to ten sam kanał local, który jest używany do products.
ONLINE Wskazuje, że kanał jest online.

Atrybuty

Atrybuty.

Zapis JSON 
{
  "productApplicability": enum (ProductApplicability),
  "offerType": enum (OfferType),
  "genericRedemptionCode": string,
  "longTitle": string,
  "couponValueType": enum (CouponValueType),
  "promotionDestinations": [
    enum (DestinationEnum)
  ],
  "itemIdInclusion": [
    string
  ],
  "brandInclusion": [
    string
  ],
  "itemGroupIdInclusion": [
    string
  ],
  "productTypeInclusion": [
    string
  ],
  "itemIdExclusion": [
    string
  ],
  "brandExclusion": [
    string
  ],
  "itemGroupIdExclusion": [
    string
  ],
  "productTypeExclusion": [
    string
  ],
  "minimumPurchaseAmount": {
    object (Price)
  },
  "minimumPurchaseQuantity": string,
  "limitQuantity": string,
  "limitValue": {
    object (Price)
  },
  "percentOff": string,
  "moneyOffAmount": {
    object (Price)
  },
  "getThisQuantityDiscounted": string,
  "freeGiftValue": {
    object (Price)
  },
  "freeGiftDescription": string,
  "freeGiftItemId": string,
  "promotionEffectiveTimePeriod": {
    object (Interval)
  },
  "promotionDisplayTimePeriod": {
    object (Interval)
  },
  "storeApplicability": enum (StoreApplicability),
  "storeCodesInclusion": [
    string
  ],
  "storeCodesExclusion": [
    string
  ],
  "promotionUrl": string
}
Pola
productApplicability

enum (ProductApplicability)

Wymagane. Promocja obejmuje wszystkie produkty lub tylko wybrane produkty.
offerType

enum (OfferType)

Wymagane. Typ promocji. Ten atrybut wskazuje, czy klienci muszą wykorzystać kod kuponu, aby skorzystać z promocji.
genericRedemptionCode

string

Opcjonalnie: ogólny kod promocyjny dla promocji, Używany z polem offerType musi spełniać wymagania minimalne.
longTitle

string

Wymagane. Długi tytuł promocji.
couponValueType

enum (CouponValueType)

Wymagane. Atrybut typ wartości kuponu, który wskazuje typ promocji, którą prowadzisz. W zależności od typu wybranej wartości kuponu wymagane są określone atrybuty.
promotionDestinations[]

enum (DestinationEnum)

Wymagane. Lista miejsc docelowych, w których obowiązuje promocja. Jeśli nie określisz miejsca docelowego, dodając do źródła danych obsługiwaną wartość, Twoja promocja wyświetli się domyślnie w reklamach produktowych i bezpłatnych informacjach.

Możliwe, że wcześniej zdarzyło Ci się przesyłać te wartości jako miejsca docelowe dla Twoich produktów: Shopping Actions, Surfaces across Google, Local surfaces across Google. Do przedstawienia tych wartości służą FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. Więcej informacji znajdziesz w artykule Miejsce docelowe promocji.
itemIdInclusion[]

string

Opcjonalnie: Filtrowanie produktów według identyfikatora produktu w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produktów kwalifikujących się do promocji productApplicability ma wartość specific_products.
brandInclusion[]

string

Opcjonalnie: Filtruj produkty według marki na potrzeby promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produktów kwalifikujących się do promocji productApplicability ma wartość specific_products.
itemGroupIdInclusion[]

string

Opcjonalnie: Filtrowanie produktów według identyfikatora grupy produktów dla promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkt kwalifikujący się do promocji stosowalność produktu [productApplicability] ma wartość specific_products.
productTypeInclusion[]

string

Opcjonalnie: Filtruj produkty według typu produktu w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty kwalifikujące się do promocji produktu objętego promocją productApplicability ma wartość specific_products.
itemIdExclusion[]

string

Opcjonalnie: Filtrowanie produktów według wykluczenia identyfikatora produktu w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produktów kwalifikujących się do promocji productApplicability ma wartość specific_products.
brandExclusion[]

string

Opcjonalnie: Filtrowanie produktów według wykluczenia marki w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty kwalifikujące się do promocji produktu objętego promocją productApplicability ma wartość specific_products.
itemGroupIdExclusion[]

string

Opcjonalnie: Filtrowanie produktów według identyfikatora grupy produktów. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty kwalifikujące się do promocji productApplicability ma wartość specific_products.
productTypeExclusion[]

string

Opcjonalnie: Filtr produktów według wykluczenia typu produktu w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produktów kwalifikujących się do promocji productApplicability ma wartość specific_products.
minimumPurchaseAmount

object (Price)

Opcjonalnie: Minimalna kwota do zapłaty w ramach promocji.
minimumPurchaseQuantity

string (int64 format)

Opcjonalnie: Minimalna wielkość zakupu w ramach promocji.
limitQuantity

string (int64 format)

Opcjonalnie: Maksymalna wielkość zakupu w promocji.
limitValue

object (Price)

Opcjonalnie: Maksymalna cena produktu w promocji.
percentOff

string (int64 format)

Opcjonalnie: Rabat procentowy oferowany w ramach promocji.
moneyOffAmount

object (Price)

Opcjonalnie: Kwota rabatu oferowana w ramach promocji.
getThisQuantityDiscounted

string (int64 format)

Opcjonalnie: Liczba produktów objętych rabatem w ramach promocji. Atrybut jest ustawiany, gdy couponValueType ma wartość buy_m_get_n_money_off lub buy_m_get_n_percent_off.
freeGiftValue

object (Price)

Opcjonalnie: Wartość prezentu w ramach promocji.
freeGiftDescription

string

Opcjonalnie: Opis prezentu w ramach promocji.
freeGiftItemId

string

Opcjonalnie: Identyfikator produktu prezentu objętego promocją.
promotionEffectiveTimePeriod

object (Interval)

Wymagane. Wartość TimePeriod reprezentująca okres obowiązywania promocji. Ten atrybut określa, że promocję można przetestować w Twoim sklepie internetowym w tym okresie.
promotionDisplayTimePeriod

object (Interval)

Opcjonalnie: TimePeriod wyświetlanie dat wyświetlania promocji. Ten atrybut określa datę i okres, kiedy promocja będzie widoczna na Google.com i w reklamach produktowych. Jeśli atrybut okres wyświetlania promocji promotionDisplayTimePeriod nie został określony, data i okres, kiedy promocja będzie widoczna na Google.com i w reklamach produktowych, zostaną określone na podstawie atrybutu okres obowiązywania promocji promotionEffectiveTimePeriod.
storeApplicability

enum (StoreApplicability)

Opcjonalnie: Określ, czy promocja ma obowiązywać we wszystkich sklepach czy tylko w wybranych. Promocje reklam lokalnego asortymentu produktów powodują błąd, jeśli nie uwzględniono w nich możliwości zastosowania w sklepie. Jeśli opcja storeApplicability ma wartość ALL_STORES, a opcja storeCodesInclusion lub score_code_exclusion ma wartość, zgłaszany jest błąd INVALID_ARGUMENT.
storeCodesInclusion[]

string

Opcjonalnie: Kodów sklepu, które chcesz uwzględnić w promocji. Atrybuty filtrowania sklepów mają zastosowanie tylko wtedy, gdy atrybut storeApplicability ma wartość specific_stores.

Kod sklepu (identyfikator sklepu z profilu firmy) sklepu stacjonarnego, w którym sprzedawany jest produkt. Więcej informacji znajdziesz w specyfikacji danych lokalnego asortymentu produktów.
storeCodesExclusion[]

string

Opcjonalnie: Kodów sklepów do wykluczenia w promocji. Atrybuty umożliwiające filtrowanie sklepów mają zastosowanie tylko wtedy, gdy atrybut storeApplicability ma wartość specific_stores.
promotionUrl

string

Opcjonalnie: Adres URL strony w witrynie sprzedawcy, na której wyświetla się promocja. Promocje reklam lokalnego asortymentu produktów powodują błąd, jeśli nie ma elementu promotionUrl. Adres URL służy do potwierdzenia, że promocja jest ważna i można z niej skorzystać.

ProductApplicability

Produkt lub lista produktów, do których ma zastosowanie promocja.

Wartości w polu enum
PRODUCT_APPLICABILITY_UNSPECIFIED Produkty, których dotyczy promocja, są nieznane.
ALL_PRODUCTS Dotyczy wszystkich produktów.
SPECIFIC_PRODUCTS Dotyczy tylko jednego produktu lub jednej listy produktów.

OfferType

Typ oferty w ramach promocji.

Wartości w polu enum
OFFER_TYPE_UNSPECIFIED Nieznany typ oferty.
NO_CODE Typ oferty bez kodu.
GENERIC_CODE Typ oferty z kodem. Ogólny kod promocyjny dla promocji jest wymagany, gdy offerType = GENERIC_CODE.

CouponValueType

Typ wartości kuponu promocji.

Wartości w polu enum
COUPON_VALUE_TYPE_UNSPECIFIED Wskazuje, że typ wartości kuponu jest nieokreślony.
MONEY_OFF Typ wartości kuponu.
PERCENT_OFF Typ wartości kuponu w postaci rabatu procentowego.
BUY_M_GET_N_MONEY_OFF Kup większą ilość i zyskaj N% zniżki. Wymagane są pola minimumPurchaseQuantity i getThisQuantityDiscounted. Musisz też podać moneyOffAmount.
BUY_M_GET_N_PERCENT_OFF Kup większą ilość i zyskaj zniżkę procentową na podstawie typu wartości kuponu. Pola minimumPurchaseQuantity i getThisQuantityDiscounted są wymagane. Pole percent_off_percentage też musi być obecne.
BUY_M_GET_MONEY_OFF Kup większą ilość i oszczędź pieniądze. Pole „minimumPurchaseQuantity” i „moneyOffAmount” są wymagane.
BUY_M_GET_PERCENT_OFF Kup większą ilość i oszczędź pieniądze. Pole „minimumPurchaseQuantity” i „percent_off_percentage” są wymagane.
FREE_GIFT Prezent tylko z opisem.
FREE_GIFT_WITH_VALUE Prezent o wartości pieniężnej.
FREE_GIFT_WITH_ITEM_ID Prezent z identyfikatorem produktu.
FREE_SHIPPING_STANDARD Typ wartości kuponu standardowej dostawy.
FREE_SHIPPING_OVERNIGHT Typ wartości kuponu na bezpłatną dostawę przez noc.
FREE_SHIPPING_TWO_DAY Typ wartości kuponu z bezpłatną dostawą w ciągu 2 dni.

DestinationEnum

wartości docelowych,

Wartości w polu enum
DESTINATION_ENUM_UNSPECIFIED Nie określono.
SHOPPING_ADS Reklamy produktowe.
DISPLAY_ADS Reklamy displayowe.
LOCAL_INVENTORY_ADS Reklamy lokalnego asortymentu produktów –
FREE_LISTINGS Bezpłatne informacje.
FREE_LOCAL_LISTINGS Bezpłatne lokalne informacje o produkcie
YOUTUBE_SHOPPING Zakupy w YouTube.
YOUTUBE_SHOPPING_CHECKOUT Płatność w Zakupach w YouTube.
YOUTUBE_AFFILIATE Kanały partnerskie w YouTube.
FREE_VEHICLE_LISTINGS bezpłatne informacje o pojazdach;
VEHICLE_ADS Reklamy pojazdów.
CLOUD_RETAIL Cloud Retail.
LOCAL_CLOUD_RETAIL Local Cloud Retail.

StoreApplicability

Kody sklepów lub lista kodów sklepów, których dotyczy promocja. Tylko do promocji reklam lokalnego asortymentu produktów.

Wartości w polu enum
STORE_APPLICABILITY_UNSPECIFIED Nie wiadomo, do których kodów sklepów ma zastosowanie promocja.
ALL_STORES Promocja dotyczy wszystkich sklepów.
SPECIFIC_STORES Promocja dotyczy tylko określonych sklepów.

PromotionStatus

Stan promocji.

Zapis JSON 
{
  "destinationStatuses": [
    {
      object (DestinationStatus)
    }
  ],
  "itemLevelIssues": [
    {
      object (ItemLevelIssue)
    }
  ],
  "creationDate": string,
  "lastUpdateDate": string
}
Pola
destinationStatuses[]

object (DestinationStatus)

Tylko dane wyjściowe. Miejsca docelowe promocji.
itemLevelIssues[]

object (ItemLevelIssue)

Tylko dane wyjściowe. Lista problemów związanych z promocją.
creationDate

string (Timestamp format)

Tylko dane wyjściowe. Data utworzenia promocji w formacie ISO 8601: data, godzina i przesunięcie, np. 2020-01-02T09:00:00+01:00 lub 2020-01-02T09:00:00Z
lastUpdateDate

string (Timestamp format)

Tylko dane wyjściowe. Data ostatniej aktualizacji stanu promocji w formacie ISO 8601: data, godzina i przesunięcie, np. 2020-01-02T09:00:00+01:00 lub 2020-01-02T09:00:00Z.

DestinationStatus

Stan określonego miejsca docelowego.

Zapis JSON 
{
  "reportingContext": enum (ReportingContextEnum),
  "status": enum (State)
}
Pola
reportingContext

enum (ReportingContextEnum)

Tylko dane wyjściowe. Nazwa miejsca docelowego promocji.
status

enum (State)

Tylko dane wyjściowe. Stan określonego miejsca docelowego.

Stan

bieżący stan promocji.

Wartości w polu enum
STATE_UNSPECIFIED Nieznany stan promocji.
IN_REVIEW Promocja jest w trakcie sprawdzania.
REJECTED Promocja została odrzucona.
LIVE Promocja jest zatwierdzona i aktywna.
STOPPED Promocja została zatrzymana przez sprzedawcę.
EXPIRED Promocja nie jest już aktywna.
PENDING Promocja nie zostanie przerwana, a wszystkie opinie zostaną zatwierdzone, ale data aktywności przypada w przyszłości.

ItemLevelIssue

Problem związany z promocją.

Zapis JSON 
{
  "code": string,
  "severity": enum (Severity),
  "resolution": string,
  "attribute": string,
  "reportingContext": enum (ReportingContextEnum),
  "description": string,
  "detail": string,
  "documentation": string,
  "applicableCountries": [
    string
  ]
}
Pola
code

string

Tylko dane wyjściowe. Kod błędu.
severity

enum (Severity)

Tylko dane wyjściowe. Jak ten problem wpływa na wyświetlanie promocji.
resolution

string

Tylko dane wyjściowe. Czy problem może zostać rozwiązany przez sprzedawcę.
attribute

string

Tylko dane wyjściowe. Nazwa atrybutu, jeśli problem jest spowodowany przez jeden atrybut.
reportingContext

enum (ReportingContextEnum)

Tylko dane wyjściowe. Miejsce docelowe, którego dotyczy problem.
description

string

Tylko dane wyjściowe. Krótki opis problemu w języku angielskim.
detail

string

Tylko dane wyjściowe. szczegółowy opis problemu w języku angielskim.
documentation

string

Tylko dane wyjściowe. adres URL strony internetowej, która pomoże nam rozwiązać ten problem.
applicableCountries[]

string

Tylko dane wyjściowe. Lista kodów krajów (ISO 3166-1 alfa-2), w przypadku których oferta dotyczy problemu.

Poziom ważności

Waga problemu.

Wartości w polu enum
SEVERITY_UNSPECIFIED Nie określono.
NOT_IMPACTED Ten problem jest ostrzeżeniem i nie ma bezpośredniego wpływu na promocję.
DEMOTED Promocja zostanie zdegradowana i najprawdopodobniej będzie miała ograniczoną skuteczność w wynikach wyszukiwania.
DISAPPROVED Problem powoduje odrzucenie promocji.

Metody

get

 Pobiera promocję z konta Merchant Center.

insert

 Wstawia promocję na konto Merchant Center.

list

 Wyświetla promocje na koncie Merchant Center.